-
Notifications
You must be signed in to change notification settings - Fork 10
/
cloud-diff.yml
4771 lines (4623 loc) · 219 KB
/
cloud-diff.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: InfluxDB Cloud API Service
version: 2.0.1
description: |
The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint.
license:
name: MIT
url: 'https://opensource.org/licenses/MIT'
servers:
- url: /api/v2
paths:
/users:
get:
operationId: GetUsers
tags:
- Security and access endpoints
- Users
summary: List users
description: |
Lists [users]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user).
To limit which users are returned, pass query parameters in your request.
#### InfluxDB Cloud
- InfluxDB Cloud doesn't allow listing all users through the API.
Use the InfluxDB Cloud user interface (UI) to manage account information.
#### Required permissions for InfluxDB Cloud
| Action | Permission required | Restriction |
|:-------|:--------------------|:------------|
| List all users | Operator token | InfluxData internal use only |
| List a specific user | `read-users` or `read-user USER_ID` |
*`USER_ID`* is the ID of the user that you want to retrieve.
#### Related guides
- [Manage users](https://docs.influxdata.com/influxdb/cloud/organizations/users/)
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
- in: query
name: name
schema:
type: string
description: |
A user name.
Only lists the specified [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user).
- in: query
name: id
schema:
type: string
description: |
A user id.
Only lists the specified [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user).
responses:
'200':
description: |
Success. The response contains a list of `users`.
#### InfluxDB Cloud
- Returns an empty `users` list if you don't pass _`id`_ or _`name`_ parameters and don't use an
_operator token_.
Only InfluxData can access InfluxDB Cloud operator tokens.
content:
application/json:
schema:
$ref: '#/components/schemas/Users'
'401':
description: |
Unauthorized.
content:
application/json:
schema:
properties:
code:
description: code is the machine-readable error code.
readOnly: true
type: string
enum:
- internal error
- not implemented
- not found
- conflict
- invalid
- unprocessable entity
- empty value
- unavailable
- forbidden
- too many requests
- unauthorized
- method not allowed
- request too large
- unsupported media type
message:
readOnly: true
description: Human-readable message.
type: string
op:
readOnly: true
description: Describes the logical code operation when the error occurred. Useful for debugging.
type: string
err:
readOnly: true
description: Stack of errors that occurred during processing of the request. Useful for debugging.
type: string
required:
- code
'422':
description: |
Unprocessable entity.
The error may indicate one of the following problems:
- The request body isn't valid--the request is well-formed,
but InfluxDB can't process it due to semantic errors.
- You passed a parameter combination that InfluxDB doesn't support.
content:
application/json:
schema:
$ref: '#/paths/~1users/get/responses/401/content/application~1json/schema'
'500':
description: |
Internal server error.
The server encountered an unexpected situation.
content:
application/json:
schema:
$ref: '#/paths/~1users/get/responses/401/content/application~1json/schema'
default:
description: Unexpected error
$ref: '#/paths/~1tasks/get/responses/default'
post:
operationId: PostUsers
tags:
- Users
summary: Create a user
description: |
(InfluxData internal use only)
Creates and returns a [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user)
that can access InfluxDB.
#### InfluxDB Cloud
- InfluxDB Cloud Doesn't let you manage users through the API.
Use the InfluxDB Cloud user interface (UI) to manage account information.
#### Required permissions for InfluxDB Cloud
| Action | Permission required | Restriction |
|:-------|:--------------------|:------------|
| Create user | Operator token | InfluxData internal use only |
#### Related guides
- [Manage users]({{% INFLUXDB_DOCS_URL %}}/organizations/users/)
parameters:
- $ref: '#/paths/~1users/get/parameters/0'
requestBody:
description: 'In the request body, provide the user.'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/User'
responses:
'201':
description: |
Success.
The response body contains the user.
content:
application/json:
schema:
$ref: '#/components/schemas/OnboardingResponse/properties/user'
'401':
description: |
Unauthorized.
#### InfluxDB Cloud
- Returns this error if the request doesn't use an _operator token_.
Only InfluxData can access InfluxDB Cloud operator tokens.
content:
application/json:
schema:
$ref: '#/paths/~1users/get/responses/401/content/application~1json/schema'
'422':
description: |
Unprocessable entity.
The error may indicate one of the following problems:
- The request body isn't valid--the request is well-formed,
but InfluxDB can't process it due to semantic errors.
- You passed a parameter combination that InfluxDB doesn't support.
content:
application/json:
schema:
$ref: '#/paths/~1users/get/responses/401/content/application~1json/schema'
'500':
$ref: '#/paths/~1users/get/responses/500'
default:
description: Unexpected error
$ref: '#/paths/~1tasks/get/responses/default'
'/users/{userID}':
get:
operationId: GetUsersID
tags:
- Users
summary: Retrieve a user
description: |
Retrieves a [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user).
#### Related guides
- [Manage users]({{% INFLUXDB_DOCS_URL %}}/organizations/users/)
parameters:
- $ref: '#/paths/~1users/get/parameters/0'
- in: path
name: userID
schema:
type: string
required: true
description: |
A user ID.
Retrieves the specified [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user).
responses:
'200':
description: Success. The response body contains the user.
content:
application/json:
schema:
$ref: '#/components/schemas/OnboardingResponse/properties/user'
default:
description: Unexpected error
$ref: '#/paths/~1tasks/get/responses/default'
patch:
operationId: PatchUsersID
tags:
- Users
summary: Update a user
description: |
(InfluxData internal use only)
Updates a [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user) and returns the user.
#### InfluxDB Cloud
- Doesn't let you manage users through the API.
Use the InfluxDB Cloud user interface (UI) to manage account information.
#### Required permissions for InfluxDB Cloud
| Action | Permission required | Restriction |
|:-------|:--------------------|:------------|
| Update user | Operator token | InfluxData internal use only |
#### Related guides
- [Manage users]({{% INFLUXDB_DOCS_URL %}}/organizations/users/)
requestBody:
description: The user update to apply.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/User'
parameters:
- $ref: '#/paths/~1users/get/parameters/0'
- in: path
name: userID
schema:
type: string
required: true
description: |
A user ID.
Updates the specified [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user).
responses:
'200':
description: Success. The response body contains the updated user.
content:
application/json:
schema:
$ref: '#/components/schemas/OnboardingResponse/properties/user'
'400':
$ref: '#/paths/~1tasks~1%7BtaskID%7D/get/responses/400'
'401':
$ref: '#/paths/~1tasks/get/responses/401'
'404':
$ref: '#/paths/~1tasks~1%7BtaskID%7D/get/responses/404'
'500':
$ref: '#/paths/~1users/get/responses/500'
default:
$ref: '#/paths/~1tasks/get/responses/default'
delete:
operationId: DeleteUsersID
tags:
- Users
summary: Delete a user
description: |
(InfluxData internal use only)
Deletes a [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user).
For security purposes, once an InfluxDB user account is deleted from an
organization, the user (and their token) cannot be reactivated.
#### InfluxDB Cloud
- Doesn't let you manage users through the API.
Use the InfluxDB Cloud user interface (UI) to manage account information.
#### Required permissions
| Action | Permission required | Restriction |
|:-------|:--------------------|:------------|
| Delete user | Operator token | InfluxData internal use only |
#### Related guides
- [Manage users]({{% INFLUXDB_DOCS_URL %}}/organizations/users/)
parameters:
- $ref: '#/paths/~1users/get/parameters/0'
- in: path
name: userID
schema:
type: string
required: true
description: |
A user ID.
Deletes the specified [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user).
responses:
'204':
description: Success. The user is deleted.
'400':
$ref: '#/paths/~1tasks~1%7BtaskID%7D/get/responses/400'
'401':
$ref: '#/paths/~1tasks/get/responses/401'
'404':
$ref: '#/paths/~1tasks~1%7BtaskID%7D/get/responses/404'
'500':
$ref: '#/paths/~1users/get/responses/500'
default:
$ref: '#/paths/~1tasks/get/responses/default'
/setup:
get:
operationId: GetSetup
tags:
- Setup
summary: Retrieve setup status
description: 'Check if setup is allowed. Returns `true` if no default user, organization, or bucket have been created.'
parameters:
- $ref: '#/paths/~1users/get/parameters/0'
responses:
'200':
description: 'Setup is allowed, true or false'
content:
application/json:
schema:
type: object
properties:
allowed:
description: |
If `true`, the InfluxDB instance hasn't had initial setup;
`false` otherwise.
type: boolean
post:
operationId: PostSetup
tags:
- Setup
summary: 'Create an initial user, organization, and bucket'
description: 'Post an onboarding request to create an initial user, organization, and bucket.'
parameters:
- $ref: '#/paths/~1users/get/parameters/0'
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: '#/paths/~1tasks/get/responses/default'
/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: '#/paths/~1tasks/get/responses/default'
/variables:
get:
operationId: GetVariables
tags:
- Variables
summary: List all variables
parameters:
- $ref: '#/paths/~1users/get/parameters/0'
- in: query
name: org
description: The name of the organization.
schema:
type: string
- in: query
name: orgID
description: The organization ID.
schema:
type: string
responses:
'200':
description: A list of variables for an organization.
content:
application/json:
schema:
$ref: '#/components/schemas/Variables'
'400':
description: Invalid request
$ref: '#/paths/~1tasks/get/responses/default'
default:
description: Internal server error
$ref: '#/paths/~1tasks/get/responses/default'
post:
operationId: PostVariables
summary: Create a variable
tags:
- Variables
parameters:
- $ref: '#/paths/~1users/get/parameters/0'
requestBody:
description: Variable to create
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Variable'
responses:
'201':
description: Variable created
content:
application/json:
schema:
$ref: '#/components/schemas/Variable'
default:
description: Internal server error
$ref: '#/paths/~1tasks/get/responses/default'
'/variables/{variableID}':
get:
operationId: GetVariablesID
tags:
- Variables
summary: Retrieve a variable
parameters:
- $ref: '#/paths/~1users/get/parameters/0'
- in: path
name: variableID
required: true
schema:
type: string
description: The variable ID.
responses:
'200':
description: Variable found
content:
application/json:
schema:
$ref: '#/components/schemas/Variable'
'404':
description: Variable not found
$ref: '#/paths/~1tasks/get/responses/default'
default:
description: Internal server error
$ref: '#/paths/~1tasks/get/responses/default'
delete:
operationId: DeleteVariablesID
tags:
- Variables
summary: Delete a variable
parameters:
- $ref: '#/paths/~1users/get/parameters/0'
- in: path
name: variableID
required: true
schema:
type: string
description: The variable ID.
responses:
'204':
description: Variable deleted
default:
description: Internal server error
$ref: '#/paths/~1tasks/get/responses/default'
patch:
operationId: PatchVariablesID
summary: Update a variable
tags:
- Variables
parameters:
- $ref: '#/paths/~1users/get/parameters/0'
- in: path
name: variableID
required: true
schema:
type: string
description: The variable ID.
requestBody:
description: Variable update to apply
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Variable'
responses:
'200':
description: Variable updated
content:
application/json:
schema:
$ref: '#/components/schemas/Variable'
default:
description: Internal server error
$ref: '#/paths/~1tasks/get/responses/default'
put:
operationId: PutVariablesID
summary: Replace a variable
tags:
- Variables
parameters:
- $ref: '#/paths/~1users/get/parameters/0'
- in: path
name: variableID
required: true
schema:
type: string
description: The variable ID.
requestBody:
description: Variable to replace
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Variable'
responses:
'200':
description: Variable updated
content:
application/json:
schema:
$ref: '#/components/schemas/Variable'
default:
description: Internal server error
$ref: '#/paths/~1tasks/get/responses/default'
'/buckets/{bucketID}/schema/measurements':
summary: Bucket schemas
get:
summary: List measurement schemas of a bucket
description: |
Lists _explicit_
[schemas]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#schema)
(`"schemaType": "explicit"`) for a bucket.
_Explicit_ schemas are used to enforce column names, tags, fields, and data
types for your data.
By default, buckets have an _implicit_ schema-type (`"schemaType": "implicit"`)
that conforms to your data.
#### Related guides
- [Using bucket schemas](https://www.influxdata.com/blog/new-bucket-schema-option-protect-from-unwanted-schema-changes/)
operationId: getMeasurementSchemas
parameters:
- in: query
name: org
description: |
An organization name.
Specifies the organization that owns the schema.
schema:
type: string
- in: query
name: orgID
description: |
An organization ID.
Specifies the organization that owns the schema.
schema:
type: string
- in: query
name: name
description: |
A measurement name.
Only returns measurement schemas with the specified name.
schema:
type: string
- in: path
name: bucketID
description: |
A bucket ID.
Lists measurement schemas for the specified bucket.
schema:
type: string
required: true
tags:
- Bucket Schemas
responses:
'200':
description: A list of measurement schemas returning summary information.
headers:
ETag:
description: The current version of the bucket schema
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementSchemaList'
'400':
description: |
Bad request.
content:
application/json:
schema:
$ref: '#/paths/~1users/get/responses/401/content/application~1json/schema'
examples:
invalidSchemaType:
summary: Invalid schema type.
value:
code: invalid
message: bucket schemaType must be explicit
'401':
$ref: '#/paths/~1tasks/get/responses/401'
'404':
$ref: '#/paths/~1tasks~1%7BtaskID%7D/get/responses/404'
'500':
$ref: '#/paths/~1users/get/responses/500'
post:
summary: Create a measurement schema for a bucket
description: |
Creates an _explict_ measurement [schema]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#schema)
for a bucket.
_Explicit_ schemas are used to enforce column names, tags, fields, and data
types for your data.
By default, buckets have an _implicit_ schema-type (`"schemaType": "implicit"`)
that conforms to your data.
Use this endpoint to create schemas that prevent non-conforming write requests.
#### Limitations
- Buckets must be created with the "explict" `schemaType` in order to use
schemas.
#### Related guides
- [Manage bucket schemas]({{% INFLUXDB_DOCS_URL %}}/organizations/buckets/bucket-schema/).
- [Create a bucket with an explicit schema]({{% INFLUXDB_DOCS_URL %}}/organizations/buckets/create-bucket/#create-a-bucket-with-an-explicit-schema)
operationId: createMeasurementSchema
parameters:
- in: query
name: org
description: |
An organization name.
Specifies the organization that owns the schema.
schema:
type: string
- in: query
name: orgID
description: |
An organization ID.
Specifies the organization that owns the schema.
schema:
type: string
- in: path
name: bucketID
description: |
A bucket ID.
Adds a schema for the specified bucket.
schema:
type: string
required: true
tags:
- Bucket Schemas
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementSchemaCreateRequest'
responses:
'201':
description: The current version of the measurement schema.
headers:
ETag:
description: The current version of the measurement schema
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementSchema'
'400':
description: |
Bad request.
content:
application/json:
examples:
badNameExample:
summary: Invalid name
description: 'The error returned when the name is invalid, such as too few or too many characters or the name contains non-printable ASCII or is not valid UTF-8.'
value:
code: invalid
message: name is invalid
missingColumnsExample:
summary: Missing columns
description: The error returned when the request body is missing the columns property.
value:
code: invalid
message: columns is required
missingTimestampExample:
summary: Missing timestamp
description: The error returned when the request body is missing a timestamp type column.
value:
code: invalid
message: Timestamp column is required
duplicateColumnNamesExample:
summary: Duplicate column names
description: The error returned when the request body contains duplicate column names.
value:
code: invalid
message: Duplicate column names
missingFieldExample:
summary: Missing field
description: The error returned when the request body is missing at least one field type column.
value:
code: invalid
message: At least one field column is required
schema:
$ref: '#/paths/~1users/get/responses/401/content/application~1json/schema'
'401':
$ref: '#/paths/~1tasks/get/responses/401'
'404':
$ref: '#/paths/~1tasks~1%7BtaskID%7D/get/responses/404'
'500':
$ref: '#/paths/~1users/get/responses/500'
x-codeSamples:
- lang: Shell
label: cURL
source: |
curl --request POST "INFLUX_URL/api/v2/buckets/BUCKET_ID/schema/measurements \
--header "Authorization: Token INFLUX_API_TOKEN" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '{
"name": "temperature",
"column": [
{
"type": "tag",
"name": "location"
},
{
"type": "field",
"name": "value",
"dataType": "float"
},
{
"type": "timestamp",
"name": "time"
}
]
}'
'/buckets/{bucketID}/schema/measurements/{measurementID}':
summary: Bucket Schema
get:
summary: Retrieve a measurement schema
description: |
Retrieves an explicit measurement [schema]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#schema).
operationId: getMeasurementSchema
parameters:
- in: query
name: org
description: |
Organization name.
Specifies the organization that owns the schema.
schema:
type: string
- in: query
name: orgID
description: |
Organization ID.
Specifies the organization that owns the schema.
schema:
type: string
- in: path
name: bucketID
description: |
A bucket ID.
Retrieves schemas for the specified bucket.
schema:
type: string
required: true
- in: path
name: measurementID
description: |
The measurement schema ID.
Specifies the measurement schema to retrieve.
schema:
type: string
required: true
tags:
- Bucket Schemas
responses:
'200':
description: Schema definition for a single measurement
headers:
ETag:
description: The current version of the measurement schema
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementSchema'
'401':
$ref: '#/paths/~1tasks/get/responses/401'
'404':
$ref: '#/paths/~1tasks~1%7BtaskID%7D/get/responses/404'
'500':
$ref: '#/paths/~1users/get/responses/500'
patch:
summary: Update a measurement schema
description: |
Updates a measurement [schema]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#schema).
Use this endpoint to update the fields (`name`, `type`, and `dataType`) of a
measurement schema.
#### Limitations
- You can't update the `name` of a measurement.
#### Related guides
- [Manage bucket schemas]({{% INFLUXDB_DOCS_URL %}}/organizations/buckets/bucket-schema/).
- [Using bucket schemas](https://www.influxdata.com/blog/new-bucket-schema-option-protect-from-unwanted-schema-changes/).
operationId: updateMeasurementSchema
parameters:
- in: query
name: org
description: |
An organization name.
Specifies the organization that owns the schema.
schema:
type: string
- in: query
name: orgID
description: |
An organization ID.
Specifies the organization that owns the schema.
schema:
type: string
- in: path
name: bucketID
description: |
A bucket ID.
Specifies the bucket to retrieve schemas for.
schema:
type: string
required: true
- in: path
name: measurementID
description: |
A measurement schema ID.
Retrieves the specified measurement schema.
schema:
type: string
required: true
tags:
- Bucket Schemas
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementSchemaUpdateRequest'
responses:
'200':
description: |
Success.
The response body contains the measurement schema.
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementSchema'
'400':
description: |
Bad request.
content:
application/json:
examples:
missingColumnsExample:
summary: Deleted columns
description: The error returned when the request body does not contain all the columns from the source.
value:
code: invalid
message: Unable to delete columns from schema
schema:
$ref: '#/paths/~1users/get/responses/401/content/application~1json/schema'
'401':
$ref: '#/paths/~1tasks/get/responses/401'
'404':
$ref: '#/paths/~1tasks~1%7BtaskID%7D/get/responses/404'
'500':
$ref: '#/paths/~1users/get/responses/500'
x-codeSamples:
- lang: Shell
label: cURL
source: |
curl --request PATCH "INFLUX_URL/api/v2/buckets/BUCKET_ID/schema/measurements \
--header "Authorization: Token INFLUX_API_TOKEN" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '{
"column": [
{
"type": "tag",
"name": "location"
},
{
"type": "field",
"name": "value",
"dataType": "float"
},
{
"type": "timestamp",
"name": "time"
}
]
}'
'/orgs/{orgID}/limits':
get:
tags:
- Limits
summary: Retrieve limits for an organization
operationId: GetOrgLimitsID
parameters:
- in: path
name: orgID
description: The ID of the organization.
required: true
schema:
type: string
responses:
'200':
description: Limits defined for the organization.
content:
application/json:
schema:
type: object
description: These are org limits similar to those configured in/by quartz.
properties:
links: