Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

InfluxData Secrets API

The Secrets API from InfluxData — 3 operation(s) for secrets.

InfluxData Secrets API is one of 45 APIs that InfluxData publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Secrets. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.

This API exposes 4 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 2.0.1.

Requests are made against a single base URL, /api/v2.

4 operations 3 paths 4 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.1
Base URL
https://us-east-1-1.aws.cloud2.influxdata.com/api/v2
Authentication
API Key, HTTP Basic
License
Resource Areas
1

Authentication & Security 2

InfluxData Secrets API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (TokenAuthentication). It accepts HTTP basic authentication (BasicAuthentication). By default, every request must be authenticated.

  • TokenAuthentication — Use the [Token authentication](section/Authentication/TokenAuthentication) scheme to authenticate to the InfluxDB API. In your API requests, send an Authorizat…
  • BasicAuthentication — Basic authentication scheme Use the HTTP Basic authentication scheme for InfluxDB /api/v2 API operations that support it: Syntax Authorization: Basic BASE64ENC…

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Secrets 4
GET
/orgs/{orgID}/secrets
List all secret keys for an organization
GetOrgsIDSecrets 2 params → 200default
PATCH
/orgs/{orgID}/secrets
Update secrets in an organization
PatchOrgsIDSecrets 2 params body → 204default
POST
/orgs/{orgID}/secrets/deletedeprecated
Delete secrets from an organization
PostOrgsIDSecrets 2 params body → 204default
DELETE
/orgs/{orgID}/secrets/{secretID}
Delete a secret from an organization
DeleteOrgsIDSecretsID 3 params → 204default

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Error (4 properties), SecretKeys (1 property). Each schema is shown below with its type and property counts.

Secrets
SecretKeysResponse
SecretKeys
object
1 property
Error
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdata-secrets-api-openapi.yml Raw ↑

Other APIs InfluxData publishes across the network.

InfluxData Authorizations (API tokens) API
InfluxData Backup API
InfluxData Bucket Schemas API
InfluxData Buckets API
InfluxData Cells API
InfluxData Checks API
InfluxData Config API
InfluxData Dashboards API
InfluxData Data I/O endpoints API
InfluxData DBRPs API
InfluxData Debug API
InfluxData Delete API