-
Notifications
You must be signed in to change notification settings - Fork 10
/
cloud-priv.yml
1497 lines (1488 loc) · 47.6 KB
/
cloud-priv.yml
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.0
info:
title: IDPE-exclusive API endpoints
version: 2.3.3
license:
name: MIT
url: 'https://opensource.org/licenses/MIT'
servers:
- description: |-
V2 Private is not necessarily private in the sense that the world cannot view it,
but defines routes that are of little use to the world (quartz-specific routes that
require a super token (`/setup/user`)), or routes that are not yet guaranteed to
not change.
url: /api/v2private
paths:
/oauth/clientConfig:
get:
tags:
- OAuth
summary: Retrieve required OAuth client variables
parameters:
- in: query
name: redirectTo
schema:
type: string
description: optional parameter to redirect the user to after a successful login.
required: false
responses:
'200':
description: Required OAuth client variables
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthClientConfig'
default:
description: unexpected error
$ref: '#/components/responses/ServerError'
/flags:
get:
tags:
- Public Flags
summary: Retrieve public/preauth feature flags
responses:
'200':
description: Pre-authentication exposed feature flags
content:
application/json:
schema:
type: object
additionalProperties: true
default:
description: unexpected error
$ref: '#/components/responses/ServerError'
/limitevents:
get:
tags:
- Limits
summary: List all limit events
parameters:
- in: query
name: offset
required: false
description: |
The offset for pagination.
The number of records to skip.
For more information about pagination parameters, see [Pagination]({{% INFLUXDB_DOCS_URL %}}/api/#tag/Pagination).
schema:
type: integer
minimum: 0
- in: query
name: orgID
required: true
description: only show events belonging to specified organization
schema:
type: string
- in: query
name: start
description: limit to only events at or after start time
schema:
type: string
format: date-time
- in: query
name: stop
description: limit to only events before stop time
schema:
type: string
format: date-time
- in: query
name: limit
schema:
type: integer
minimum: 1
default: 100
maximum: 100
responses:
'200':
description: A list of limit events
content:
application/json:
schema:
$ref: '#/components/schemas/LimitEvents'
default:
description: unexpected error
$ref: '#/components/responses/ServerError'
'/orgs/{orgID}/limits':
get:
tags:
- Limits
summary: Retrieve limits for an organization
parameters:
- in: path
name: orgID
description: The identifier of the organization.
required: true
schema:
type: string
responses:
'200':
description: A limit
content:
application/json:
schema:
$ref: '#/components/schemas/Limit'
default:
description: unexpected error
$ref: '#/components/responses/ServerError'
put:
tags:
- Limits
summary: Create or update limits for an organization
parameters:
- in: path
name: orgID
description: The identifier of the organization.
required: true
schema:
type: string
requestBody:
description: limit that will be updated
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Limit'
responses:
'200':
description: The updated or created limit
content:
application/json:
schema:
$ref: '#/components/schemas/Limit'
default:
description: unexpected error
$ref: '#/components/responses/ServerError'
patch:
tags:
- Limits
summary: Patch limit
parameters:
- in: path
name: orgID
description: The identifier of the organization.
required: true
schema:
type: string
requestBody:
description: fields in the limit that require updates
required: true
content:
application/json:
schema:
type: object
description: These are org limits similar to those configured in/by quartz.
properties:
orgID:
type: string
rate:
type: object
properties:
queryTime:
type: integer
description: Query Time in nanoseconds
readKBs:
type: integer
description: Query limit in kb/sec. 0 is unlimited.
concurrentReadRequests:
type: integer
description: Allowed concurrent queries. 0 is unlimited.
writeKBs:
type: integer
description: Write limit in kb/sec. 0 is unlimited.
concurrentWriteRequests:
type: integer
description: Allowed concurrent writes. 0 is unlimited.
cardinality:
type: integer
description: Allowed organization total cardinality. 0 is unlimited.
concurrentDeleteRequests:
type: integer
description: Allowed organization concurrent outstanding delete requests.
deleteRequestsPerSecond:
type: integer
description: Allowed organization delete request rate.
bucket:
type: object
properties:
maxBuckets:
type: integer
maxRetentionDuration:
type: integer
description: Max bucket retention duration in nanoseconds. 0 is unlimited.
task:
type: object
properties:
maxTasks:
type: integer
required:
- maxTasks
dashboard:
type: object
properties:
maxDashboards:
type: integer
required:
- maxDashboards
check:
type: object
properties:
maxChecks:
type: integer
required:
- maxChecks
notificationRule:
type: object
properties:
maxNotifications:
type: integer
blockedNotificationRules:
type: string
description: comma separated list of notification rules
example: 'http,pagerduty'
notificationEndpoint:
type: object
properties:
blockedNotificationEndpoints:
type: string
description: comma separated list of notification endpoints
example: 'http,pagerduty'
required:
- blockNotificationEndpoints
responses:
'200':
description: The updated limit
content:
application/json:
schema:
$ref: '#/components/schemas/Limit'
'422':
description: Request body could not be processed
content:
application/json:
schema:
$ref: '#/components/responses/ServerError'
default:
description: unexpected error
$ref: '#/components/responses/ServerError'
'/orgs/{orgID}/limits/status':
get:
tags:
- Limits
summary: Get current limit status for an org
parameters:
- in: path
name: orgID
schema:
type: string
required: true
description: The identifier of the organization.
responses:
'200':
description: Current limit status
content:
application/json:
schema:
$ref: '#/components/schemas/LimitStatuses'
default:
description: unexpected error
$ref: '#/components/responses/ServerError'
'/orgs/{orgID}/settings':
get:
summary: Get settings for an org
parameters:
- in: path
name: orgID
description: org to get settings for
required: true
schema:
type: string
responses:
'200':
description: Current settings for org
content:
application/json:
schema:
$ref: '#/components/schemas/OrgSettings'
default:
description: unexpected error
$ref: '#/components/responses/ServerError'
put:
summary: Create or update settings for an org
parameters:
- in: path
name: orgID
description: org to create settings for
required: true
schema:
type: string
requestBody:
description: Org settings that will be updated
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OrgSettings'
responses:
'200':
description: The updated or created settings
content:
application/json:
schema:
$ref: '#/components/schemas/OrgSettings'
default:
description: unexpected error
$ref: '#/components/responses/ServerError'
/setup/user:
post:
operationId: PostSetupUser
tags:
- Setup
summary: 'Create a new user, organization, and bucket'
description: 'Post an onboarding request to create a new user, organization, and bucket.'
requestBody:
description: Source to create
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OnboardingRequest'
responses:
'201':
description: 'The created default user, bucket, and organization.'
content:
application/json:
schema:
$ref: '#/components/schemas/OnboardingResponse'
default:
description: Unexpected error
$ref: '#/components/responses/ServerError'
/provision:
put:
operationId: PutProvision
tags:
- Provision
description: 'Create a new user, organization, and bucket. Idempotent. Requests can be retried.'
requestBody:
description: Create user and org with supplied IDs
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisionRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisionResponse'
description: 'The user name and ID, the org name and ID, the token for user if requested'
'400':
content:
application/json:
schema:
$ref: '#/components/responses/ServerError'
description: 'Bad request. Data in request is invalid. Examples include Invalid IDs, invalid names, and invalid limits'
'401':
content:
application/json:
schema:
$ref: '#/components/responses/ServerError'
description: Credentials not provided
'403':
content:
application/json:
schema:
$ref: '#/components/responses/ServerError'
description: Insufficient credentials to create an organization
'422':
content:
application/json:
schema:
$ref: '#/components/responses/ServerError'
description: |
Unprocessable Entity
- Retention seconds that are higher than max allowed.
Conflict
- user with ID exists with different name
- org with ID exists with different name
- user name already in use with different id
- org name already in use with differnet id
'501':
content:
application/json:
schema:
$ref: '#/components/responses/ServerError'
description: Internal Server Error. Request can be retried
default:
$ref: '#/components/responses/ServerError'
description: Unexpected error
/provision/delete:
post:
operationId: PostProvisionDelete
tags:
- ProvisionDelete
description: 'Delete an organization, associated resources, and all users belonging only to that single organization. Idempotent.'
requestBody:
description: Organization ID to delete
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisionDeleteRequest'
responses:
'204':
description: Organization deleted
'400':
$ref: '#/components/responses/ServerError'
description: Organization ID not provided
'401':
$ref: '#/components/responses/ServerError'
description: Credentials not provided or insufficient credentials to delete an organization
'422':
$ref: '#/components/responses/ServerError'
description: Invalid organization ID
default:
$ref: '#/components/responses/ServerError'
description: Unexpected error
/provision/user:
put:
operationId: PutProvisionUser
tags:
- ProvisionUser
summary: Create/Add a user to an existing org. Creates a user if doesn't exist. Idempotent
parameters:
- in: header
name: Zap-Trace-Span
description: OpenTracing span context
example:
trace_id: '1'
span_id: '1'
baggage:
key: value
required: false
schema:
type: string
requestBody:
description: User to create and org id to add user to
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisionUserRequest'
responses:
'201':
description: User created
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisionUserResponse'
'400':
content:
application/json:
schema:
$ref: '#/components/responses/ServerError'
description: 'Bad request. Data in request is invalid. Examples include Invalid IDs, invalid names.'
'401':
content:
application/json:
schema:
$ref: '#/components/responses/ServerError'
description: Credentials not provided or insufficient credentials to provision a user
'422':
content:
application/json:
schema:
$ref: '#/components/responses/ServerError'
description: |
Unprocessable Entity
- Org with ID doesn't exist.
Conflict
- user with ID exists with different name
- user name already in use with different id
'501':
content:
application/json:
schema:
$ref: '#/components/responses/ServerError'
description: Internal Server Error. Request can be retried.
default:
$ref: '#/components/responses/ServerError'
description: Unexpected error
/provision/user/delete:
post:
operationId: PostProvisionUserDelete
tags:
- ProvisionUserDelete
description: Delete a user from an organization. Deletes the user if they are part of no other organization. Idempotent.
requestBody:
description: The request includes the User ID and the Org ID to delete the user from and whether to transfer user resources to an optional new owner.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisionUserDeleteRequest'
responses:
'204':
description: User deleted
'400':
$ref: '#/components/responses/ServerError'
description: Bad request. Data in request is invalid. Examples include missing IDs or invalid resource option.
'401':
$ref: '#/components/responses/ServerError'
description: Credentials not provided or insufficient credentials to delete a user.
'422':
$ref: '#/components/responses/ServerError'
description: Unprocessable entry. Examples include invalid IDs or new owner ID being the same as current owner ID.
default:
$ref: '#/components/responses/ServerError'
description: Unexpected error
/provision/setup:
post:
operationId: PostProvisionSetup
tags:
- ProvisionSetup
description: Create the initial operator user and organization for the cluster.
requestBody:
description: Initial user and org to create.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisionSetupRequest'
responses:
'201':
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: the token for the created user
description: Token for the created user.
'400':
$ref: '#/components/responses/ServerError'
description: Bad request. Data in request is invalid. Examples include missing names for user or org.
'422':
$ref: '#/components/responses/ServerError'
description: 'Unprocessable entry. Setup has already been completed, or invalid IDs provided.'
default:
$ref: '#/components/responses/ServerError'
description: Unexpected error
/provision/suspend:
post:
operationId: PostProvisionSuspend
tags:
- ProvisionSuspend
description: Suspend an organization. Idempotent.
requestBody:
description: Organization ID to suspend
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisionSuspendRequest'
responses:
'204':
description: Organization suspended
'400':
$ref: '#/components/responses/ServerError'
description: Organization ID not provided
'401':
$ref: '#/components/responses/ServerError'
description: Credentials not provided or insufficient credentials to suspend an organization
'422':
$ref: '#/components/responses/ServerError'
description: Invalid organization ID
default:
$ref: '#/components/responses/ServerError'
description: Unexpected error
/provision/unsuspend:
post:
operationId: PostProvisionUnsuspend
tags:
- ProvisionUnsuspend
description: Unsuspend an organization. Idempotent.
requestBody:
description: Organization ID to unsuspend
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisionSuspendRequest'
responses:
'204':
description: Organization unsuspendd
'400':
$ref: '#/components/responses/ServerError'
description: Organization ID not provided
'401':
$ref: '#/components/responses/ServerError'
description: Credentials not provided or insufficient credentials to unsuspend an organization
'422':
$ref: '#/components/responses/ServerError'
description: Invalid organization ID
default:
$ref: '#/components/responses/ServerError'
description: Unexpected error
components:
schemas:
OnboardingRequest:
type: object
properties:
username:
type: string
password:
type: string
org:
type: string
bucket:
type: string
retentionPeriodHrs:
type: integer
deprecated: true
retentionPeriodSeconds:
type: integer
limit:
$ref: '#/components/schemas/Limit'
required:
- username
- org
- bucket
OnboardingResponse:
type: object
properties:
user:
properties:
id:
readOnly: true
type: string
description: |
The user ID.
name:
type: string
description: |
The user name.
status:
description: |
The status of a user.
An inactive user can't read or write resources.
default: active
type: string
enum:
- active
- inactive
links:
type: object
readOnly: true
example:
self: /api/v2/users/1
properties:
self:
type: string
format: uri
required:
- name
org:
properties:
links:
type: object
readOnly: true
example:
self: /api/v2/orgs/1
members: /api/v2/orgs/1/members
owners: /api/v2/orgs/1/owners
labels: /api/v2/orgs/1/labels
secrets: /api/v2/orgs/1/secrets
buckets: /api/v2/buckets?org=myorg
tasks: /api/v2/tasks?org=myorg
dashboards: /api/v2/dashboards?org=myorg
properties:
self:
$ref: '#/components/schemas/Link'
members:
$ref: '#/components/schemas/Link'
owners:
$ref: '#/components/schemas/Link'
labels:
$ref: '#/components/schemas/Link'
secrets:
$ref: '#/components/schemas/Link'
buckets:
$ref: '#/components/schemas/Link'
tasks:
$ref: '#/components/schemas/Link'
dashboards:
$ref: '#/components/schemas/Link'
id:
readOnly: true
type: string
name:
type: string
defaultStorageType:
description: Discloses whether the organization uses TSM or IOx.
type: string
enum:
- tsm
- iox
description:
type: string
createdAt:
type: string
format: date-time
readOnly: true
updatedAt:
type: string
format: date-time
readOnly: true
status:
description: 'If inactive, the organization is inactive.'
default: active
type: string
enum:
- active
- inactive
required:
- name
bucket:
properties:
links:
type: object
readOnly: true
example:
labels: /api/v2/buckets/1/labels
members: /api/v2/buckets/1/members
org: /api/v2/orgs/2
owners: /api/v2/buckets/1/owners
self: /api/v2/buckets/1
write: /api/v2/write?org=2&bucket=1
properties:
labels:
description: The URL to retrieve labels for this bucket.
$ref: '#/components/schemas/Link'
members:
description: The URL to retrieve members that can read this bucket.
$ref: '#/components/schemas/Link'
org:
description: The URL to retrieve parent organization for this bucket.
$ref: '#/components/schemas/Link'
owners:
description: The URL to retrieve owners that can read and write to this bucket.
$ref: '#/components/schemas/Link'
self:
description: The URL for this bucket.
$ref: '#/components/schemas/Link'
write:
description: The URL to write line protocol to this bucket.
$ref: '#/components/schemas/Link'
id:
readOnly: true
type: string
type:
readOnly: true
type: string
default: user
enum:
- user
- system
name:
type: string
description:
type: string
orgID:
type: string
rp:
type: string
schemaType:
default: implicit
type: string
enum:
- implicit
- explicit
createdAt:
type: string
format: date-time
readOnly: true
updatedAt:
type: string
format: date-time
readOnly: true
retentionRules:
type: array
description: |
Retention rules to expire or retain data.
The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#retention-period).
#### InfluxDB Cloud
- `retentionRules` is required.
#### InfluxDB OSS
- `retentionRules` isn't required.
items:
type: object
properties:
type:
type: string
default: expire
enum:
- expire
everySeconds:
type: integer
format: int64
description: |
The duration in seconds for how long data will be kept in the database.
The default duration is 2592000 (30 days).
0 represents infinite retention.
example: 86400
default: 2592000
minimum: 0
shardGroupDurationSeconds:
type: integer
format: int64
description: |
The shard group duration.
The duration or interval (in seconds) that each shard group covers.
#### InfluxDB Cloud
- Does not use `shardGroupDurationsSeconds`.
#### InfluxDB OSS
- Default value depends on the
[bucket retention period]({{% INFLUXDB_DOCS_URL %}}/reference/internals/shards/#shard-group-duration).
required:
- everySeconds
labels:
type: array
items:
type: object
properties:
id:
readOnly: true
type: string
orgID:
readOnly: true
type: string
name:
type: string
properties:
type: object
additionalProperties:
type: string
description: |
Key-value pairs associated with this label.
To remove a property, send an update with an empty value (`""`) for the key.
example:
color: ffb3b3
description: this is a description
required:
- name
- retentionRules
auth:
required:
- orgID
- permissions
allOf:
- properties:
status:
description: 'Status of the token. If `inactive`, InfluxDB rejects requests that use the token.'
default: active
type: string
enum:
- active
- inactive
description:
type: string
description: A description of the token.
- type: object
properties:
createdAt:
type: string
format: date-time
readOnly: true
updatedAt:
type: string
format: date-time
readOnly: true
orgID:
type: string
description: |
The organization ID.
Specifies the [organization]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#organization) that the authorization is scoped to.
permissions:
type: array
minItems: 1
description: |
The list of permissions.
An authorization must have at least one permission.
items:
required:
- action
- resource
properties:
action:
type: string
enum:
- read
- write
resource:
type: object
required:
- type
properties:
type:
type: string
enum:
- authorizations
- buckets
- dashboards
- orgs
- tasks
- telegrafs
- users
- variables
- secrets
- labels
- views
- documents
- notificationRules
- notificationEndpoints
- checks
- dbrp
- annotations
- sources
- scrapers
- notebooks
- remotes
- replications
- instance
- flows
- functions
- subscriptions
description: |
A resource type.
Identifies the API resource's type (or _kind_).
id:
type: string
description: |
A resource ID.
Identifies a specific resource.
name:
type: string
description: |
The name of the resource.
_Note: not all resource types have a `name` property_.
orgID:
type: string
description: |
An organization ID.
Identifies the organization that owns the resource.
org:
type: string
description: |
An organization name.
The organization that owns the resource.
id:
readOnly: true
type: string
description: The authorization ID.
token:
readOnly: true
type: string
description: |
The API token.
The token value is unique to the authorization.
[API tokens]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#token) are
used to authenticate and authorize InfluxDB API requests and `influx`