-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathopenapi.yaml
More file actions
1370 lines (1338 loc) · 41.6 KB
/
openapi.yaml
File metadata and controls
1370 lines (1338 loc) · 41.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.0.3
info:
title: Tiger Cloud API
description: |
A RESTful API for Tiger Cloud platform.
version: 1.0.0
license:
name: Proprietary
url: https://www.tigerdata.com/legal/terms
contact:
name: Tiger Data Support
url: https://www.tigerdata.com/contact
servers:
- url: https://console.cloud.timescale.com/public/api/v1
description: API server for Tiger Cloud
tags:
- name: Auth
description: Authentication and authorization information.
- name: VPCs
description: Manage VPCs and their peering connections.
- name: Services
description: Manage services, read replicas, and their associated actions.
- name: Analytics
description: Track analytics events.
paths:
/auth/info:
get:
operationId: getAuthInfo
tags:
- Auth
summary: Get Authentication Info
description: Returns information about the authentication credentials being used to access the API
responses:
'200':
description: Authentication information retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/AuthInfo'
'4XX':
$ref: '#/components/responses/ClientError'
/analytics/identify:
post:
operationId: identifyUser
tags:
- Analytics
summary: Identify a user
description: Identifies a user with optional properties for analytics tracking.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
properties:
type: object
additionalProperties: true
description: Optional map of arbitrary properties associated with the user
example:
email: "user@example.com"
name: "John Doe"
responses:
'200':
$ref: '#/components/responses/AnalyticsResponse'
'4XX':
$ref: '#/components/responses/ClientError'
/analytics/track:
post:
operationId: trackEvent
tags:
- Analytics
summary: Track an analytics event
description: Tracks an analytics event with optional properties.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- event
properties:
event:
type: string
description: The name of the event to track
example: service_created
properties:
type: object
additionalProperties: true
description: Optional map of arbitrary properties associated with the event
example:
region: "us-east-1"
responses:
'200':
$ref: '#/components/responses/AnalyticsResponse'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/vpcs:
get:
operationId: getVPCs
tags:
- VPCs
parameters:
- $ref: '#/components/parameters/ProjectId'
summary: List All VPCs
description: Retrieves a list of all Virtual Private Clouds (VPCs).
responses:
'200':
description: A list of VPCs.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/VPC'
'4XX':
$ref: '#/components/responses/ClientError'
post:
operationId: createVPC
tags:
- VPCs
parameters:
- $ref: '#/components/parameters/ProjectId'
summary: Create a VPC
description: Creates a new Virtual Private Cloud (VPC).
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VPCCreate'
responses:
'201':
description: VPC created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/VPC'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/vpcs/{vpc_id}:
get:
operationId: getVPC
tags:
- VPCs
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/VPCId'
summary: Get a VPC
description: Retrieves the details of a specific VPC by its ID.
responses:
'200':
description: VPC details.
content:
application/json:
schema:
$ref: '#/components/schemas/VPC'
'4XX':
$ref: '#/components/responses/ClientError'
delete:
operationId: deleteVPC
tags:
- VPCs
summary: Delete a VPC
description: Deletes a specific VPC.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/VPCId'
responses:
'204':
description: VPC deleted successfully.
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/vpcs/{vpc_id}/rename:
post:
operationId: renameVPC
tags:
- VPCs
summary: Rename a VPC
description: Updates the name of a specific VPC.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/VPCId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VPCRename'
responses:
'200':
description: VPC renamed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/VPC'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/vpcs/{vpc_id}/peerings:
get:
operationId: getVPCPeerings
tags:
- VPCs
summary: List VPC Peerings
description: Retrieves a list of all VPC peering connections for a given VPC.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/VPCId'
responses:
'200':
description: A list of VPC peering connections.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Peering'
'4XX':
$ref: '#/components/responses/ClientError'
post:
operationId: createVPCPeering
tags:
- VPCs
summary: Create a VPC Peering
description: Creates a new VPC peering connection.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/VPCId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PeeringCreate'
responses:
'201':
description: VPC peering created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Peering'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/vpcs/{vpc_id}/peerings/{peering_id}:
get:
operationId: getVPCPeering
tags:
- VPCs
summary: Get a VPC Peering
description: Retrieves the details of a specific VPC peering connection.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/VPCId'
- $ref: '#/components/parameters/PeeringId'
responses:
'200':
description: VPC peering details.
content:
application/json:
schema:
$ref: '#/components/schemas/Peering'
'4XX':
$ref: '#/components/responses/ClientError'
delete:
operationId: deleteVPCPeering
tags:
- VPCs
summary: Delete a VPC Peering
description: Deletes a specific VPC peering connection.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/VPCId'
- $ref: '#/components/parameters/PeeringId'
responses:
'204':
description: VPC peering deleted successfully.
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services:
get:
operationId: getServices
tags:
- Services
summary: List All Services
description: Retrieves a list of all services within a specific project.
parameters:
- $ref: '#/components/parameters/ProjectId'
responses:
'200':
description: A list of services.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Service'
'4XX':
$ref: '#/components/responses/ClientError'
post:
operationId: createService
tags:
- Services
summary: Create a Service
description: Creates a new database service within a project. This is an asynchronous operation.
parameters:
- $ref: '#/components/parameters/ProjectId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceCreate'
responses:
'202':
description: Service creation request has been accepted.
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}:
get:
operationId: getService
tags:
- Services
summary: Get a Service
description: Retrieves the details of a specific service by its ID.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
responses:
'200':
description: Service details.
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
'4XX':
$ref: '#/components/responses/ClientError'
delete:
operationId: deleteService
tags:
- Services
summary: Delete a Service
description: Deletes a specific service. This is an asynchronous operation.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
responses:
'202':
description: Deletion request has been accepted.
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/start:
post:
operationId: startService
tags:
- Services
summary: Start a Service
description: Starts a stopped service within a project. This is an asynchronous operation.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
responses:
'202':
description: Service start request has been accepted.
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/stop:
post:
operationId: stopService
tags:
- Services
summary: Stop a Service
description: Stops a running service within a project. This is an asynchronous operation.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
responses:
'202':
description: Service stop request has been accepted.
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/attachToVPC:
post:
operationId: attachServiceToVPC
tags:
- Services
summary: Attach Service to VPC
description: Associates a service with a VPC.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceVPCInput'
responses:
'202':
$ref: '#/components/responses/SuccessMessage'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/detachFromVPC:
post:
operationId: detachServiceFromVPC
tags:
- Services
summary: Detach Service from VPC
description: Disassociates a service from its VPC.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceVPCInput'
responses:
'202':
$ref: '#/components/responses/SuccessMessage'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/resize:
post:
operationId: resizeService
tags:
- Services
summary: Resize a Service
description: Changes the CPU and memory allocation for a specific service within a project. This is an asynchronous operation.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ResizeInput'
responses:
'202':
description: Resize request has been accepted and is in progress.
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/enablePooler:
post:
operationId: enablePooler
tags:
- Services
summary: Enable Connection Pooler for a Service
description: Activates the connection pooler for a specific service within a project.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
responses:
'200':
$ref: '#/components/responses/SuccessMessage'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/disablePooler:
post:
operationId: disablePooler
tags:
- Services
summary: Disable Connection Pooler for a Service
description: Deactivates the connection pooler for a specific service within a project.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
responses:
'200':
$ref: '#/components/responses/SuccessMessage'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/forkService:
post:
operationId: forkService
tags:
- Services
summary: Fork a Service
description: Creates a new, independent service within a project by taking a snapshot of an existing one.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ForkServiceCreate'
responses:
'202':
description: Fork request accepted. The response contains the details of the new service being created.
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/updatePassword:
post:
operationId: updatePassword
tags:
- Services
summary: Update Service Password
description: Sets a new master password for the service within a project.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePasswordInput'
responses:
'204':
description: Password updated successfully. No content returned.
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/setEnvironment:
post:
operationId: setEnvironment
tags:
- Services
summary: Set Environment for a Service
description: Sets the environment type for the service.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SetEnvironmentInput'
responses:
'200':
$ref: '#/components/responses/SuccessMessage'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/logs:
get:
operationId: getServiceLogs
tags:
- Services
summary: Get service logs
description: |
Fetch logs for a specific service. Returns up to 500 log entries from
available logs. Supports pagination.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
- name: node
in: query
required: false
schema:
type: integer
description: Specific service node to fetch logs from (for multi-node services)
- name: page
in: query
required: false
schema:
type: integer
description: Page number for pagination (0-based)
- name: until
in: query
required: false
schema:
type: string
format: date-time
description: Fetch logs before this timestamp (RFC3339 format, e.g., 2024-01-15T10:00:00Z)
responses:
'200':
description: Service logs retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceLogs'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/setHA:
post:
operationId: setHAReplica
tags:
- Services
summary: Change HA configuration for a Service
description: Changes the HA configuration for a specific service. This is an asynchronous operation.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SetHAReplicaInput'
responses:
'202':
description: HA replica configuration updated
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/replicaSets:
get:
operationId: getReplicaSets
tags:
- Read Replica Sets
summary: Get Read Replica Sets
description: Retrieves a list of all read replica sets associated with a primary service within a project.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
responses:
'200':
description: A list of read replica sets.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ReadReplicaSet'
'4XX':
$ref: '#/components/responses/ClientError'
post:
operationId: createReplicaSet
tags:
- Read Replica Sets
summary: Create a Read Replica Set
description: Creates a new read replica set for a service. This is an asynchronous operation.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ReadReplicaSetCreate'
responses:
'202':
description: Read replica set creation request has been accepted.
content:
application/json:
schema:
$ref: '#/components/schemas/ReadReplicaSet'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}:
delete:
operationId: deleteReplicaSet
tags:
- Read Replica Sets
summary: Delete a Read Replica Set
description: Deletes a specific read replica set. This is an asynchronous operation.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
- $ref: '#/components/parameters/ReplicaSetId'
responses:
'202':
description: Deletion request has been accepted.
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/resize:
post:
operationId: resizeReplicaSet
tags:
- Read Replica Sets
summary: Resize a Read Replica Set
description: Changes the resource allocation for a specific read replica set.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
- $ref: '#/components/parameters/ReplicaSetId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ResizeInput'
responses:
'202':
description: Resize request has been accepted and is in progress.
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/enablePooler:
post:
operationId: enableReplicaPooler
tags:
- Read Replica Sets
summary: Enable Connection Pooler for a Read Replica
description: Activates the connection pooler for a specific read replica set.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
- $ref: '#/components/parameters/ReplicaSetId'
responses:
'200':
$ref: '#/components/responses/SuccessMessage'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/disablePooler:
post:
operationId: disableReplicaPooler
tags:
- Read Replica Sets
summary: Disable Connection Pooler for a Read Replica
description: Deactivates the connection pooler for a specific read replica set.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
- $ref: '#/components/parameters/ReplicaSetId'
responses:
'200':
$ref: '#/components/responses/SuccessMessage'
'4XX':
$ref: '#/components/responses/ClientError'
/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/setEnvironment:
post:
operationId: setReplicaEnvironment
tags:
- Read Replica Sets
summary: Set Environment for a Read Replica
description: Sets the environment type for the read replica set.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/ServiceId'
- $ref: '#/components/parameters/ReplicaSetId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SetEnvironmentInput'
responses:
'200':
$ref: '#/components/responses/SuccessMessage'
'4XX':
$ref: '#/components/responses/ClientError'
components:
parameters:
ProjectId:
name: project_id
in: path
required: true
description: The unique identifier of the project.
schema:
type: string
example: "rp1pz7uyae"
ServiceId:
name: service_id
in: path
required: true
description: The unique identifier of the service.
schema:
type: string
example: "d1k5vk7hf2"
ReplicaSetId:
name: replica_set_id
in: path
required: true
description: The unique identifier of the read replica set.
schema:
type: string
example: "alb8jicdpr"
VPCId:
name: vpc_id
in: path
required: true
description: The unique identifier of the VPC.
schema:
type: string
example: "1234567890"
PeeringId:
name: peering_id
in: path
required: true
description: The unique identifier of the VPC peering connection.
schema:
type: string
example: "1234567890"
schemas:
AuthInfo:
type: object
required:
- type
- apiKey
properties:
type:
type: string
description: The type of authentication being used
enum: ["apiKey"]
example: "apiKey"
apiKey:
type: object
description: Information about the API key credentials
required:
- public_key
- name
- created
- project
- issuing_user
properties:
public_key:
type: string
description: The public key of the client credentials
example: "tskey_abc123"
name:
type: string
description: The name of the credential
example: "my-production-token"
created:
type: string
format: date-time
description: When the client credentials were created
example: "2024-01-15T10:30:00Z"
project:
type: object
description: Information about the project
required:
- id
- name
- plan_type
properties:
id:
type: string
description: The project ID
example: "rp1pz7uyae"
name:
type: string
description: The name of the project
example: "My Production Project"
plan_type:
type: string
description: The plan type for the project
example: "FREE"
issuing_user:
type: object
description: Information about the user who created the credentials
required:
- id
- name
- email
properties:
id:
type: string
description: The user ID
example: "user123"
name:
type: string
description: The user's name
example: "John Doe"
email:
type: string
format: email
description: The user's email
example: "john.doe@example.com"
VPC:
type: object
properties:
id:
type: string
readOnly: true
example: "1234567890"
name:
type: string
example: "my-production-vpc"
cidr:
type: string
example: "10.0.0.0/16"
region_code:
type: string
example: "us-east-1"
VPCCreate:
type: object
required:
- name
- cidr
- region_code
properties:
name:
type: string
example: "my-production-vpc"
cidr:
type: string
example: "10.0.0.0/16"
region_code:
type: string
example: "us-east-1"
VPCRename:
type: object
required:
- name
properties:
name:
type: string
description: The new name for the VPC.
example: "my-renamed-vpc"
Peering:
type: object
properties:
id:
type: string
readOnly: true
example: "1234567890"
peer_account_id:
type: string
example: "acc-12345"
peer_region_code:
type: string
example: "aws-us-east-1"
peer_vpc_id:
type: string
example: "1234567890"
provisioned_id:
type: string
example: "1234567890"
status:
type: string
example: "active"
error_message:
type: string
example: "VPC not found"
PeeringCreate:
type: object
required:
- peer_account_id
- peer_region_code
- peer_vpc_id
properties:
peer_account_id:
type: string
example: "acc-12345"
peer_region_code:
type: string
example: "aws-us-east-1"
peer_vpc_id:
type: string
example: "1234567890"
Endpoint:
type: object
properties:
host:
type: string
example: "my-service.com"
port:
type: integer
example: 8080
ConnectionPooler: