-
Notifications
You must be signed in to change notification settings - Fork 10
/
cloud.yml
210 lines (176 loc) · 7.31 KB
/
cloud.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
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
#REF_CLOUD_TAGS
#REF_CLOUD_TAG_GROUPS
paths:
#REF_COMMON_PATHS
/users:
$ref: './cloud/paths/users.yml'
'/users/{userID}':
$ref: './cloud/paths/users_userID.yml'
/setup:
$ref: './cloud/paths/setup.yml'
/setup/user:
$ref: './cloud/paths/setup_user.yml'
/variables:
$ref: './cloud/paths/variables.yml'
'/variables/{variableID}':
$ref: './cloud/paths/variables_variableID.yml'
/buckets/{bucketID}/schema/measurements:
$ref: './cloud/paths/measurements.yml'
/buckets/{bucketID}/schema/measurements/{measurementID}:
$ref: './cloud/paths/measurements_measurementID.yml'
/orgs/{orgID}/limits:
$ref: './cloud/paths/orgs_orgID_limits_get.yml'
/orgs/{orgID}/usage:
$ref: './cloud/paths/orgs_orgID_usage.yml'
/dashboards:
$ref: './cloud/paths/dashboards.yml'
/tasks:
$ref: './cloud/paths/tasks.yml'
"/tasks/{taskID}":
$ref: "./cloud/paths/tasks_taskID.yml"
components:
parameters:
#REF_COMMON_PARAMETERS
schemas:
#REF_COMMON_SCHEMAS
User:
$ref: './cloud/schemas/User.yml'
Users:
$ref: './cloud/schemas/Users.yml'
OnboardingRequest:
$ref: './cloud/schemas/OnboardingRequest.yml'
OnboardingResponse:
$ref: './cloud/schemas/OnboardingResponse.yml'
Limit:
$ref: './cloud/schemas/Limit.yml'
Variable:
$ref: './cloud/schemas/Variable.yml'
Variables:
$ref: './cloud/schemas/Variables.yml'
ColumnDataType:
$ref: './cloud/schemas/ColumnDataType.yml'
ColumnSemanticType:
$ref: './cloud/schemas/ColumnSemanticType.yml'
MeasurementSchema:
$ref: './cloud/schemas/MeasurementSchema.yml'
MeasurementSchemaColumn:
$ref: './cloud/schemas/MeasurementSchemaColumn.yml'
MeasurementSchemaCreateRequest:
$ref: './cloud/schemas/MeasurementSchemaCreateRequest.yml'
MeasurementSchemaList:
$ref: './cloud/schemas/MeasurementSchemaList.yml'
MeasurementSchemaUpdateRequest:
$ref: './cloud/schemas/MeasurementSchemaUpdateRequest.yml'
Tasks:
$ref: "./cloud/schemas/Tasks.yml"
Task:
$ref: "./cloud/schemas/Task.yml"
TaskCreateRequest:
$ref: "./cloud/schemas/TaskCreateRequest.yml"
TaskUpdateRequest:
$ref: "./cloud/schemas/TaskUpdateRequest.yml"
responses:
#REF_COMMON_RESPONSES
examples:
AuthorizationPostRequest:
$ref: "./common/requestBody/examples/AuthorizationRequestExamples.yml#/AuthorizationPostRequest"
AuthorizationWithResourcePostRequest:
$ref: "./common/requestBody/examples/AuthorizationRequestExamples.yml#/AuthorizationWithResourcePostRequest"
AuthorizationWithUserPostRequest:
$ref: "./common/requestBody/examples/AuthorizationRequestExamples.yml#/AuthorizationWithUserPostRequest"
TaskWithFluxRequest:
$ref: "./common/requestBody/examples/TaskRequestExamples.yml#/TaskWithFluxRequest"
TaskWithScriptRequest:
$ref: "./common/requestBody/examples/TaskRequestExamples.yml#/TaskWithScriptRequest"
securitySchemes:
TokenAuthentication:
type: apiKey
name: Authorization
in: header
description: |
Use the [Token authentication](#section/Authentication/TokenAuthentication)
scheme to authenticate to the InfluxDB API.
In your API requests, send an `Authorization` header.
For the header value, provide the word `Token` followed by a space and an InfluxDB API token.
The word `Token` is case-sensitive.
### Syntax
`Authorization: Token INFLUX_API_TOKEN`
### Example
#### Use Token authentication with cURL
The following example shows how to use cURL to send an API request that uses Token authentication:
```sh
curl --request GET "INFLUX_URL/api/v2/buckets" \
--header "Authorization: Token INFLUX_API_TOKEN"
```
Replace the following:
- *`INFLUX_URL`*: your InfluxDB Cloud URL
- *`INFLUX_API_TOKEN`*: your [InfluxDB API token]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#token)
### Related endpoints
- [`/authorizations` endpoints](#tag/Authorizations-(API-tokens))
### Related guides
- [Authorize API requests]({{% INFLUXDB_DOCS_URL %}}/api-guide/api_intro/#authentication)
- [Manage API tokens]({{% INFLUXDB_DOCS_URL %}}/security/tokens/)
BasicAuthentication:
type: http
scheme: basic
description: |
### Basic authentication scheme
Use the HTTP Basic authentication scheme for InfluxDB `/api/v2` API operations that support it:
### Syntax
`Authorization: Basic BASE64_ENCODED_CREDENTIALS`
To construct the `BASE64_ENCODED_CREDENTIALS`, combine the username and
the password with a colon (`USERNAME:PASSWORD`), and then encode the
resulting string in [base64](https://developer.mozilla.org/en-US/docs/Glossary/Base64).
Many HTTP clients encode the credentials for you before sending the
request.
_**Warning**: Base64-encoding can easily be reversed to obtain the original
username and password. It is used to keep the data intact and does not provide
security. You should always use HTTPS when authenticating or sending a request with
sensitive information._
### Examples
In the examples, replace the following:
- **`EMAIL_ADDRESS`**: InfluxDB Cloud username (the email address the user signed up with)
- **`PASSWORD`**: InfluxDB Cloud [API token]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#token)
- **`INFLUX_URL`**: your InfluxDB Cloud URL
#### Encode credentials with cURL
The following example shows how to use cURL to send an API request that uses Basic authentication.
With the `--user` option, cURL encodes the credentials and passes them
in the `Authorization: Basic` header.
```sh
curl --get "INFLUX_URL/api/v2/signin"
--user "EMAIL_ADDRESS":"PASSWORD"
```
#### Encode credentials with Flux
The Flux [`http.basicAuth()` function](https://docs.influxdata.com/flux/v0.x/stdlib/http/basicauth/) returns a Base64-encoded
basic authentication header using a specified username and password combination.
#### Encode credentials with JavaScript
The following example shows how to use the JavaScript `btoa()` function
to create a Base64-encoded string:
```js
btoa('EMAIL_ADDRESS:PASSWORD')
```
The output is the following:
```js
'VVNFUk5BTUU6UEFTU1dPUkQ='
```
Once you have the Base64-encoded credentials, you can pass them in the
`Authorization` header--for example:
```sh
curl --get "INFLUX_URL/api/v2/signin"
--header "Authorization: Basic VVNFUk5BTUU6UEFTU1dPUkQ="
```
To learn more about HTTP authentication, see
[Mozilla Developer Network (MDN) Web Docs, HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)._
security:
- TokenAuthentication: []