chore(api): Updates API specs for users and auths. Fixes whitespace, punctuation, grammar, links, and other style issues. (#4469)
Jason Stirnaman
GitHub
parent
d3d152230e
commit
eeaab0f240
File diff suppressed because it is too large
Load Diff
|
|
@ -2,20 +2,13 @@ openapi: 3.0.0
|
||||||
info:
|
info:
|
||||||
title: InfluxDB Cloud v1 compatibility API documentation
|
title: InfluxDB Cloud v1 compatibility API documentation
|
||||||
version: 0.1.0
|
version: 0.1.0
|
||||||
description: >
|
description: |
|
||||||
The InfluxDB 1.x compatibility /write and /query endpoints work with
|
The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
|
||||||
InfluxDB 1.x client libraries and third-party integrations like Grafana and
|
|
||||||
others.
|
|
||||||
|
|
||||||
|
|
||||||
If you want to use the latest InfluxDB /api/v2 API instead, see the
|
|
||||||
[InfluxDB v2 API documentation](/influxdb/cloud/api/).
|
|
||||||
|
|
||||||
|
If you want to use the latest InfluxDB /api/v2 API instead, see the [InfluxDB v2 API documentation](/influxdb/cloud/api/).
|
||||||
|
|
||||||
This documentation is generated from the
|
This documentation is generated from the
|
||||||
|
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml).
|
||||||
[InfluxDB OpenAPI
|
|
||||||
specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml).
|
|
||||||
servers:
|
servers:
|
||||||
- url: /
|
- url: /
|
||||||
paths:
|
paths:
|
||||||
|
|
@ -41,9 +34,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
required: true
|
required: true
|
||||||
description: >-
|
description: Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy.
|
||||||
Bucket to write to. If none exists, InfluxDB creates a bucket with a
|
|
||||||
default 3-day retention policy.
|
|
||||||
- in: query
|
- in: query
|
||||||
name: rp
|
name: rp
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -56,36 +47,25 @@ paths:
|
||||||
description: Write precision.
|
description: Write precision.
|
||||||
- in: header
|
- in: header
|
||||||
name: Content-Encoding
|
name: Content-Encoding
|
||||||
description: >-
|
description: When present, its value indicates to the database that compression is applied to the line protocol body.
|
||||||
When present, its value indicates to the database that compression
|
|
||||||
is applied to the line protocol body.
|
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
description: >-
|
description: Specifies that the line protocol in the body is encoded with gzip or not encoded with identity.
|
||||||
Specifies that the line protocol in the body is encoded with gzip
|
|
||||||
or not encoded with identity.
|
|
||||||
default: identity
|
default: identity
|
||||||
enum:
|
enum:
|
||||||
- gzip
|
- gzip
|
||||||
- identity
|
- identity
|
||||||
responses:
|
responses:
|
||||||
'204':
|
'204':
|
||||||
description: >-
|
description: Write data is correctly formatted and accepted for writing to the bucket.
|
||||||
Write data is correctly formatted and accepted for writing to the
|
|
||||||
bucket.
|
|
||||||
'400':
|
'400':
|
||||||
description: >-
|
description: Line protocol poorly formed and no points were written. Response can be used to determine the first malformed line in the body line-protocol. All data in body was rejected and not written.
|
||||||
Line protocol poorly formed and no points were written. Response
|
|
||||||
can be used to determine the first malformed line in the body
|
|
||||||
line-protocol. All data in body was rejected and not written.
|
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/LineProtocolError'
|
$ref: '#/components/schemas/LineProtocolError'
|
||||||
'401':
|
'401':
|
||||||
description: >-
|
description: Token does not have sufficient permissions to write to this organization and bucket or the organization and bucket do not exist.
|
||||||
Token does not have sufficient permissions to write to this
|
|
||||||
organization and bucket or the organization and bucket do not exist.
|
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -97,35 +77,24 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/Error'
|
$ref: '#/components/schemas/Error'
|
||||||
'413':
|
'413':
|
||||||
description: >-
|
description: Write has been rejected because the payload is too large. Error message returns max size supported. All data in body was rejected and not written.
|
||||||
Write has been rejected because the payload is too large. Error
|
|
||||||
message returns max size supported. All data in body was rejected
|
|
||||||
and not written.
|
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/LineProtocolLengthError'
|
$ref: '#/components/schemas/LineProtocolLengthError'
|
||||||
'429':
|
'429':
|
||||||
description: >-
|
description: Token is temporarily over quota. The Retry-After header describes when to try the write again.
|
||||||
Token is temporarily over quota. The Retry-After header describes
|
|
||||||
when to try the write again.
|
|
||||||
headers:
|
headers:
|
||||||
Retry-After:
|
Retry-After:
|
||||||
description: >-
|
description: A non-negative decimal integer indicating the seconds to delay after the response is received.
|
||||||
A non-negative decimal integer indicating the seconds to delay
|
|
||||||
after the response is received.
|
|
||||||
schema:
|
schema:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
'503':
|
'503':
|
||||||
description: >-
|
description: Server is temporarily unavailable to accept writes. The Retry-After header describes when to try the write again.
|
||||||
Server is temporarily unavailable to accept writes. The Retry-After
|
|
||||||
header describes when to try the write again.
|
|
||||||
headers:
|
headers:
|
||||||
Retry-After:
|
Retry-After:
|
||||||
description: >-
|
description: A non-negative decimal integer indicating the seconds to delay after the response is received.
|
||||||
A non-negative decimal integer indicating the seconds to delay
|
|
||||||
after the response is received.
|
|
||||||
schema:
|
schema:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
|
@ -155,10 +124,7 @@ paths:
|
||||||
name: Accept
|
name: Accept
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
description: >-
|
description: Specifies how query results should be encoded in the response. **Note:** With `application/csv`, query results include epoch timestamps instead of RFC3339 timestamps.
|
||||||
Specifies how query results should be encoded in the response.
|
|
||||||
**Note:** With `application/csv`, query results include epoch
|
|
||||||
timestamps instead of RFC3339 timestamps.
|
|
||||||
default: application/json
|
default: application/json
|
||||||
enum:
|
enum:
|
||||||
- application/json
|
- application/json
|
||||||
|
|
@ -167,15 +133,10 @@ paths:
|
||||||
- application/x-msgpack
|
- application/x-msgpack
|
||||||
- in: header
|
- in: header
|
||||||
name: Accept-Encoding
|
name: Accept-Encoding
|
||||||
description: >-
|
description: The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand.
|
||||||
The Accept-Encoding request HTTP header advertises which content
|
|
||||||
encoding, usually a compression algorithm, the client is able to
|
|
||||||
understand.
|
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
description: >-
|
description: Specifies that the query response in the body should be encoded with gzip or not encoded with identity.
|
||||||
Specifies that the query response in the body should be encoded
|
|
||||||
with gzip or not encoded with identity.
|
|
||||||
default: identity
|
default: identity
|
||||||
enum:
|
enum:
|
||||||
- gzip
|
- gzip
|
||||||
|
|
@ -207,23 +168,16 @@ paths:
|
||||||
description: Query results
|
description: Query results
|
||||||
headers:
|
headers:
|
||||||
Content-Encoding:
|
Content-Encoding:
|
||||||
description: >-
|
description: The Content-Encoding entity header is used to compress the media-type. When present, its value indicates which encodings were applied to the entity-body
|
||||||
The Content-Encoding entity header is used to compress the
|
|
||||||
media-type. When present, its value indicates which encodings
|
|
||||||
were applied to the entity-body
|
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
description: >-
|
description: Specifies that the response in the body is encoded with gzip or not encoded with identity.
|
||||||
Specifies that the response in the body is encoded with gzip
|
|
||||||
or not encoded with identity.
|
|
||||||
default: identity
|
default: identity
|
||||||
enum:
|
enum:
|
||||||
- gzip
|
- gzip
|
||||||
- identity
|
- identity
|
||||||
Trace-Id:
|
Trace-Id:
|
||||||
description: >-
|
description: The Trace-Id header reports the request's trace ID, if one was generated.
|
||||||
The Trace-Id header reports the request's trace ID, if one was
|
|
||||||
generated.
|
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
description: Specifies the request's trace ID.
|
description: Specifies the request's trace ID.
|
||||||
|
|
@ -242,14 +196,10 @@ paths:
|
||||||
type: string
|
type: string
|
||||||
format: binary
|
format: binary
|
||||||
'429':
|
'429':
|
||||||
description: >-
|
description: Token is temporarily over quota. The Retry-After header describes when to try the read again.
|
||||||
Token is temporarily over quota. The Retry-After header describes
|
|
||||||
when to try the read again.
|
|
||||||
headers:
|
headers:
|
||||||
Retry-After:
|
Retry-After:
|
||||||
description: >-
|
description: A non-negative decimal integer indicating the seconds to delay after the response is received.
|
||||||
A non-negative decimal integer indicating the seconds to delay
|
|
||||||
after the response is received.
|
|
||||||
schema:
|
schema:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
|
@ -330,11 +280,8 @@ components:
|
||||||
items: {}
|
items: {}
|
||||||
InfluxQLCSVResponse:
|
InfluxQLCSVResponse:
|
||||||
type: string
|
type: string
|
||||||
example: >
|
example: |
|
||||||
name,tags,time,test_field,test_tag
|
name,tags,time,test_field,test_tag test_measurement,,1603740794286107366,1,tag_value test_measurement,,1603740870053205649,2,tag_value test_measurement,,1603741221085428881,3,tag_value
|
||||||
test_measurement,,1603740794286107366,1,tag_value
|
|
||||||
test_measurement,,1603740870053205649,2,tag_value
|
|
||||||
test_measurement,,1603741221085428881,3,tag_value
|
|
||||||
Error:
|
Error:
|
||||||
properties:
|
properties:
|
||||||
code:
|
code:
|
||||||
|
|
@ -379,15 +326,11 @@ components:
|
||||||
type: string
|
type: string
|
||||||
op:
|
op:
|
||||||
readOnly: true
|
readOnly: true
|
||||||
description: >-
|
description: Op describes the logical code operation during error. Useful for debugging.
|
||||||
Op describes the logical code operation during error. Useful for
|
|
||||||
debugging.
|
|
||||||
type: string
|
type: string
|
||||||
err:
|
err:
|
||||||
readOnly: true
|
readOnly: true
|
||||||
description: >-
|
description: Err is a stack of errors that occurred during processing of the request. Useful for debugging.
|
||||||
Err is a stack of errors that occurred during processing of the
|
|
||||||
request. Useful for debugging.
|
|
||||||
type: string
|
type: string
|
||||||
line:
|
line:
|
||||||
readOnly: true
|
readOnly: true
|
||||||
|
|
@ -425,30 +368,21 @@ components:
|
||||||
type: apiKey
|
type: apiKey
|
||||||
name: Authorization
|
name: Authorization
|
||||||
in: header
|
in: header
|
||||||
description: >
|
description: |
|
||||||
Use the [Token
|
Use the [Token authentication](#section/Authentication/TokenAuthentication)
|
||||||
authentication](#section/Authentication/TokenAuthentication)
|
|
||||||
|
|
||||||
scheme to authenticate to the InfluxDB API.
|
scheme to authenticate to the InfluxDB API.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
In your API requests, send an `Authorization` header.
|
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.
|
||||||
For the header value, provide the word `Token` followed by a space and
|
|
||||||
an InfluxDB API token.
|
|
||||||
|
|
||||||
The word `Token` is case-sensitive.
|
The word `Token` is case-sensitive.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Syntax
|
### Syntax
|
||||||
|
|
||||||
|
|
||||||
`Authorization: Token YOUR_INFLUX_TOKEN`
|
`Authorization: Token YOUR_INFLUX_TOKEN`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
For examples and more information, see the following:
|
For examples and more information, see the following:
|
||||||
- [`/authorizations`](#tag/Authorizations) endpoint.
|
- [`/authorizations`](#tag/Authorizations) endpoint.
|
||||||
- [Authorize API requests](/influxdb/cloud/api-guide/api_intro/#authentication).
|
- [Authorize API requests](/influxdb/cloud/api-guide/api_intro/#authentication).
|
||||||
|
|
@ -456,54 +390,37 @@ components:
|
||||||
BasicAuthentication:
|
BasicAuthentication:
|
||||||
type: http
|
type: http
|
||||||
scheme: basic
|
scheme: basic
|
||||||
description: >
|
description: |
|
||||||
Use the HTTP [Basic
|
Use the HTTP [Basic authentication](#section/Authentication/BasicAuthentication)
|
||||||
authentication](#section/Authentication/BasicAuthentication)
|
scheme with clients that support the InfluxDB 1.x convention of username and password (that don't support the `Authorization: Token` scheme):
|
||||||
|
|
||||||
scheme with clients that support the InfluxDB 1.x convention of username
|
|
||||||
and password (that don't support the `Authorization: Token` scheme):
|
|
||||||
|
|
||||||
|
|
||||||
|
For examples and more information, see how to [authenticate with a username and password](/influxdb/cloud/reference/api/influxdb-1x/).
|
||||||
For examples and more information, see how to [authenticate with a
|
|
||||||
username and password](/influxdb/cloud/reference/api/influxdb-1x/).
|
|
||||||
QuerystringAuthentication:
|
QuerystringAuthentication:
|
||||||
type: apiKey
|
type: apiKey
|
||||||
in: query
|
in: query
|
||||||
name: u=&p=
|
name: u=&p=
|
||||||
description: >
|
description: |
|
||||||
Use the [Querystring
|
Use the [Querystring authentication](#section/Authentication/QuerystringAuthentication)
|
||||||
authentication](#section/Authentication/QuerystringAuthentication)
|
scheme with InfluxDB 1.x API parameters to provide credentials through the query string.
|
||||||
|
|
||||||
scheme with InfluxDB 1.x API parameters to provide credentials through
|
|
||||||
the query string.
|
|
||||||
|
|
||||||
|
|
||||||
|
For examples and more information, see how to [authenticate with a username and password](/influxdb/cloud/reference/api/influxdb-1x/).
|
||||||
For examples and more information, see how to [authenticate with a
|
|
||||||
username and password](/influxdb/cloud/reference/api/influxdb-1x/).
|
|
||||||
security:
|
security:
|
||||||
- TokenAuthentication: []
|
- TokenAuthentication: []
|
||||||
- BasicAuthentication: []
|
- BasicAuthentication: []
|
||||||
- QuerystringAuthentication: []
|
- QuerystringAuthentication: []
|
||||||
tags:
|
tags:
|
||||||
- name: Authentication
|
- name: Authentication
|
||||||
description: >
|
description: |
|
||||||
The InfluxDB 1.x API requires authentication for all requests.
|
The InfluxDB 1.x API requires authentication for all requests.
|
||||||
|
|
||||||
InfluxDB Cloud uses InfluxDB API tokens to authenticate requests.
|
InfluxDB Cloud uses InfluxDB API tokens to authenticate requests.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
For more information, see the following:
|
For more information, see the following:
|
||||||
|
|
||||||
- [Token authentication](#section/Authentication/TokenAuthentication)
|
- [Token authentication](#section/Authentication/TokenAuthentication)
|
||||||
|
|
||||||
- [Basic authentication](#section/Authentication/BasicAuthentication)
|
- [Basic authentication](#section/Authentication/BasicAuthentication)
|
||||||
|
- [Querystring authentication](#section/Authentication/QuerystringAuthentication)
|
||||||
- [Querystring
|
|
||||||
authentication](#section/Authentication/QuerystringAuthentication)
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ReDoc-Inject: <security-definitions> -->
|
<!-- ReDoc-Inject: <security-definitions> -->
|
||||||
x-traitTag: true
|
x-traitTag: true
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -2,20 +2,13 @@ openapi: 3.0.0
|
||||||
info:
|
info:
|
||||||
title: InfluxDB OSS v1 compatibility API documentation
|
title: InfluxDB OSS v1 compatibility API documentation
|
||||||
version: 2.4.0 v1 compatibility
|
version: 2.4.0 v1 compatibility
|
||||||
description: >
|
description: |
|
||||||
The InfluxDB 1.x compatibility /write and /query endpoints work with
|
The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
|
||||||
InfluxDB 1.x client libraries and third-party integrations like Grafana and
|
|
||||||
others.
|
|
||||||
|
|
||||||
|
|
||||||
If you want to use the latest InfluxDB /api/v2 API instead, see the
|
|
||||||
[InfluxDB v2 API documentation](/influxdb/v2.4/api/).
|
|
||||||
|
|
||||||
|
If you want to use the latest InfluxDB /api/v2 API instead, see the [InfluxDB v2 API documentation](/influxdb/v2.4/api/).
|
||||||
|
|
||||||
This documentation is generated from the
|
This documentation is generated from the
|
||||||
|
[InfluxDB OpenAPI specification](https://github.com/influxdata/openapi/blob/influxdb-oss-v2.4.0/contracts/swaggerV1Compat.yml).
|
||||||
[InfluxDB OpenAPI
|
|
||||||
specification](https://github.com/influxdata/openapi/blob/influxdb-oss-v2.4.0/contracts/swaggerV1Compat.yml).
|
|
||||||
servers:
|
servers:
|
||||||
- url: /
|
- url: /
|
||||||
paths:
|
paths:
|
||||||
|
|
@ -41,9 +34,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
required: true
|
required: true
|
||||||
description: >-
|
description: Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy.
|
||||||
Bucket to write to. If none exists, InfluxDB creates a bucket with a
|
|
||||||
default 3-day retention policy.
|
|
||||||
- in: query
|
- in: query
|
||||||
name: rp
|
name: rp
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -56,36 +47,25 @@ paths:
|
||||||
description: Write precision.
|
description: Write precision.
|
||||||
- in: header
|
- in: header
|
||||||
name: Content-Encoding
|
name: Content-Encoding
|
||||||
description: >-
|
description: When present, its value indicates to the database that compression is applied to the line protocol body.
|
||||||
When present, its value indicates to the database that compression
|
|
||||||
is applied to the line protocol body.
|
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
description: >-
|
description: Specifies that the line protocol in the body is encoded with gzip or not encoded with identity.
|
||||||
Specifies that the line protocol in the body is encoded with gzip
|
|
||||||
or not encoded with identity.
|
|
||||||
default: identity
|
default: identity
|
||||||
enum:
|
enum:
|
||||||
- gzip
|
- gzip
|
||||||
- identity
|
- identity
|
||||||
responses:
|
responses:
|
||||||
'204':
|
'204':
|
||||||
description: >-
|
description: Write data is correctly formatted and accepted for writing to the bucket.
|
||||||
Write data is correctly formatted and accepted for writing to the
|
|
||||||
bucket.
|
|
||||||
'400':
|
'400':
|
||||||
description: >-
|
description: Line protocol poorly formed and no points were written. Response can be used to determine the first malformed line in the body line-protocol. All data in body was rejected and not written.
|
||||||
Line protocol poorly formed and no points were written. Response
|
|
||||||
can be used to determine the first malformed line in the body
|
|
||||||
line-protocol. All data in body was rejected and not written.
|
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/LineProtocolError'
|
$ref: '#/components/schemas/LineProtocolError'
|
||||||
'401':
|
'401':
|
||||||
description: >-
|
description: Token does not have sufficient permissions to write to this organization and bucket or the organization and bucket do not exist.
|
||||||
Token does not have sufficient permissions to write to this
|
|
||||||
organization and bucket or the organization and bucket do not exist.
|
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -97,35 +77,24 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/Error'
|
$ref: '#/components/schemas/Error'
|
||||||
'413':
|
'413':
|
||||||
description: >-
|
description: Write has been rejected because the payload is too large. Error message returns max size supported. All data in body was rejected and not written.
|
||||||
Write has been rejected because the payload is too large. Error
|
|
||||||
message returns max size supported. All data in body was rejected
|
|
||||||
and not written.
|
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/LineProtocolLengthError'
|
$ref: '#/components/schemas/LineProtocolLengthError'
|
||||||
'429':
|
'429':
|
||||||
description: >-
|
description: Token is temporarily over quota. The Retry-After header describes when to try the write again.
|
||||||
Token is temporarily over quota. The Retry-After header describes
|
|
||||||
when to try the write again.
|
|
||||||
headers:
|
headers:
|
||||||
Retry-After:
|
Retry-After:
|
||||||
description: >-
|
description: A non-negative decimal integer indicating the seconds to delay after the response is received.
|
||||||
A non-negative decimal integer indicating the seconds to delay
|
|
||||||
after the response is received.
|
|
||||||
schema:
|
schema:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
'503':
|
'503':
|
||||||
description: >-
|
description: Server is temporarily unavailable to accept writes. The Retry-After header describes when to try the write again.
|
||||||
Server is temporarily unavailable to accept writes. The Retry-After
|
|
||||||
header describes when to try the write again.
|
|
||||||
headers:
|
headers:
|
||||||
Retry-After:
|
Retry-After:
|
||||||
description: >-
|
description: A non-negative decimal integer indicating the seconds to delay after the response is received.
|
||||||
A non-negative decimal integer indicating the seconds to delay
|
|
||||||
after the response is received.
|
|
||||||
schema:
|
schema:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
|
@ -155,10 +124,7 @@ paths:
|
||||||
name: Accept
|
name: Accept
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
description: >-
|
description: Specifies how query results should be encoded in the response. **Note:** With `application/csv`, query results include epoch timestamps instead of RFC3339 timestamps.
|
||||||
Specifies how query results should be encoded in the response.
|
|
||||||
**Note:** With `application/csv`, query results include epoch
|
|
||||||
timestamps instead of RFC3339 timestamps.
|
|
||||||
default: application/json
|
default: application/json
|
||||||
enum:
|
enum:
|
||||||
- application/json
|
- application/json
|
||||||
|
|
@ -167,15 +133,10 @@ paths:
|
||||||
- application/x-msgpack
|
- application/x-msgpack
|
||||||
- in: header
|
- in: header
|
||||||
name: Accept-Encoding
|
name: Accept-Encoding
|
||||||
description: >-
|
description: The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand.
|
||||||
The Accept-Encoding request HTTP header advertises which content
|
|
||||||
encoding, usually a compression algorithm, the client is able to
|
|
||||||
understand.
|
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
description: >-
|
description: Specifies that the query response in the body should be encoded with gzip or not encoded with identity.
|
||||||
Specifies that the query response in the body should be encoded
|
|
||||||
with gzip or not encoded with identity.
|
|
||||||
default: identity
|
default: identity
|
||||||
enum:
|
enum:
|
||||||
- gzip
|
- gzip
|
||||||
|
|
@ -207,23 +168,16 @@ paths:
|
||||||
description: Query results
|
description: Query results
|
||||||
headers:
|
headers:
|
||||||
Content-Encoding:
|
Content-Encoding:
|
||||||
description: >-
|
description: The Content-Encoding entity header is used to compress the media-type. When present, its value indicates which encodings were applied to the entity-body
|
||||||
The Content-Encoding entity header is used to compress the
|
|
||||||
media-type. When present, its value indicates which encodings
|
|
||||||
were applied to the entity-body
|
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
description: >-
|
description: Specifies that the response in the body is encoded with gzip or not encoded with identity.
|
||||||
Specifies that the response in the body is encoded with gzip
|
|
||||||
or not encoded with identity.
|
|
||||||
default: identity
|
default: identity
|
||||||
enum:
|
enum:
|
||||||
- gzip
|
- gzip
|
||||||
- identity
|
- identity
|
||||||
Trace-Id:
|
Trace-Id:
|
||||||
description: >-
|
description: The Trace-Id header reports the request's trace ID, if one was generated.
|
||||||
The Trace-Id header reports the request's trace ID, if one was
|
|
||||||
generated.
|
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
description: Specifies the request's trace ID.
|
description: Specifies the request's trace ID.
|
||||||
|
|
@ -242,14 +196,10 @@ paths:
|
||||||
type: string
|
type: string
|
||||||
format: binary
|
format: binary
|
||||||
'429':
|
'429':
|
||||||
description: >-
|
description: Token is temporarily over quota. The Retry-After header describes when to try the read again.
|
||||||
Token is temporarily over quota. The Retry-After header describes
|
|
||||||
when to try the read again.
|
|
||||||
headers:
|
headers:
|
||||||
Retry-After:
|
Retry-After:
|
||||||
description: >-
|
description: A non-negative decimal integer indicating the seconds to delay after the response is received.
|
||||||
A non-negative decimal integer indicating the seconds to delay
|
|
||||||
after the response is received.
|
|
||||||
schema:
|
schema:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
|
@ -330,11 +280,8 @@ components:
|
||||||
items: {}
|
items: {}
|
||||||
InfluxQLCSVResponse:
|
InfluxQLCSVResponse:
|
||||||
type: string
|
type: string
|
||||||
example: >
|
example: |
|
||||||
name,tags,time,test_field,test_tag
|
name,tags,time,test_field,test_tag test_measurement,,1603740794286107366,1,tag_value test_measurement,,1603740870053205649,2,tag_value test_measurement,,1603741221085428881,3,tag_value
|
||||||
test_measurement,,1603740794286107366,1,tag_value
|
|
||||||
test_measurement,,1603740870053205649,2,tag_value
|
|
||||||
test_measurement,,1603741221085428881,3,tag_value
|
|
||||||
Error:
|
Error:
|
||||||
properties:
|
properties:
|
||||||
code:
|
code:
|
||||||
|
|
@ -379,15 +326,11 @@ components:
|
||||||
type: string
|
type: string
|
||||||
op:
|
op:
|
||||||
readOnly: true
|
readOnly: true
|
||||||
description: >-
|
description: Op describes the logical code operation during error. Useful for debugging.
|
||||||
Op describes the logical code operation during error. Useful for
|
|
||||||
debugging.
|
|
||||||
type: string
|
type: string
|
||||||
err:
|
err:
|
||||||
readOnly: true
|
readOnly: true
|
||||||
description: >-
|
description: Err is a stack of errors that occurred during processing of the request. Useful for debugging.
|
||||||
Err is a stack of errors that occurred during processing of the
|
|
||||||
request. Useful for debugging.
|
|
||||||
type: string
|
type: string
|
||||||
line:
|
line:
|
||||||
readOnly: true
|
readOnly: true
|
||||||
|
|
@ -425,30 +368,21 @@ components:
|
||||||
type: apiKey
|
type: apiKey
|
||||||
name: Authorization
|
name: Authorization
|
||||||
in: header
|
in: header
|
||||||
description: >
|
description: |
|
||||||
Use the [Token
|
Use the [Token authentication](#section/Authentication/TokenAuthentication)
|
||||||
authentication](#section/Authentication/TokenAuthentication)
|
|
||||||
|
|
||||||
scheme to authenticate to the InfluxDB API.
|
scheme to authenticate to the InfluxDB API.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
In your API requests, send an `Authorization` header.
|
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.
|
||||||
For the header value, provide the word `Token` followed by a space and
|
|
||||||
an InfluxDB API token.
|
|
||||||
|
|
||||||
The word `Token` is case-sensitive.
|
The word `Token` is case-sensitive.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Syntax
|
### Syntax
|
||||||
|
|
||||||
|
|
||||||
`Authorization: Token YOUR_INFLUX_TOKEN`
|
`Authorization: Token YOUR_INFLUX_TOKEN`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
For examples and more information, see the following:
|
For examples and more information, see the following:
|
||||||
- [`/authorizations`](#tag/Authorizations) endpoint.
|
- [`/authorizations`](#tag/Authorizations) endpoint.
|
||||||
- [Authorize API requests](/influxdb/cloud/api-guide/api_intro/#authentication).
|
- [Authorize API requests](/influxdb/cloud/api-guide/api_intro/#authentication).
|
||||||
|
|
@ -456,54 +390,37 @@ components:
|
||||||
BasicAuthentication:
|
BasicAuthentication:
|
||||||
type: http
|
type: http
|
||||||
scheme: basic
|
scheme: basic
|
||||||
description: >
|
description: |
|
||||||
Use the HTTP [Basic
|
Use the HTTP [Basic authentication](#section/Authentication/BasicAuthentication)
|
||||||
authentication](#section/Authentication/BasicAuthentication)
|
scheme with clients that support the InfluxDB 1.x convention of username and password (that don't support the `Authorization: Token` scheme):
|
||||||
|
|
||||||
scheme with clients that support the InfluxDB 1.x convention of username
|
|
||||||
and password (that don't support the `Authorization: Token` scheme):
|
|
||||||
|
|
||||||
|
|
||||||
|
For examples and more information, see how to [authenticate with a username and password](/influxdb/cloud/reference/api/influxdb-1x/).
|
||||||
For examples and more information, see how to [authenticate with a
|
|
||||||
username and password](/influxdb/cloud/reference/api/influxdb-1x/).
|
|
||||||
QuerystringAuthentication:
|
QuerystringAuthentication:
|
||||||
type: apiKey
|
type: apiKey
|
||||||
in: query
|
in: query
|
||||||
name: u=&p=
|
name: u=&p=
|
||||||
description: >
|
description: |
|
||||||
Use the [Querystring
|
Use the [Querystring authentication](#section/Authentication/QuerystringAuthentication)
|
||||||
authentication](#section/Authentication/QuerystringAuthentication)
|
scheme with InfluxDB 1.x API parameters to provide credentials through the query string.
|
||||||
|
|
||||||
scheme with InfluxDB 1.x API parameters to provide credentials through
|
|
||||||
the query string.
|
|
||||||
|
|
||||||
|
|
||||||
|
For examples and more information, see how to [authenticate with a username and password](/influxdb/cloud/reference/api/influxdb-1x/).
|
||||||
For examples and more information, see how to [authenticate with a
|
|
||||||
username and password](/influxdb/cloud/reference/api/influxdb-1x/).
|
|
||||||
security:
|
security:
|
||||||
- TokenAuthentication: []
|
- TokenAuthentication: []
|
||||||
- BasicAuthentication: []
|
- BasicAuthentication: []
|
||||||
- QuerystringAuthentication: []
|
- QuerystringAuthentication: []
|
||||||
tags:
|
tags:
|
||||||
- name: Authentication
|
- name: Authentication
|
||||||
description: >
|
description: |
|
||||||
The InfluxDB 1.x API requires authentication for all requests.
|
The InfluxDB 1.x API requires authentication for all requests.
|
||||||
|
|
||||||
InfluxDB Cloud uses InfluxDB API tokens to authenticate requests.
|
InfluxDB Cloud uses InfluxDB API tokens to authenticate requests.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
For more information, see the following:
|
For more information, see the following:
|
||||||
|
|
||||||
- [Token authentication](#section/Authentication/TokenAuthentication)
|
- [Token authentication](#section/Authentication/TokenAuthentication)
|
||||||
|
|
||||||
- [Basic authentication](#section/Authentication/BasicAuthentication)
|
- [Basic authentication](#section/Authentication/BasicAuthentication)
|
||||||
|
- [Querystring authentication](#section/Authentication/QuerystringAuthentication)
|
||||||
- [Querystring
|
|
||||||
authentication](#section/Authentication/QuerystringAuthentication)
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ReDoc-Inject: <security-definitions> -->
|
<!-- ReDoc-Inject: <security-definitions> -->
|
||||||
x-traitTag: true
|
x-traitTag: true
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue