How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YugabyteDB Telemetry Provider API

The Telemetry Provider API from YugabyteDB — 3 operation(s) for telemetry provider.

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

Requests are made against 2 base URLs: {protocol}://{host_port}/api/v2, /.

5 operations 3 paths 4 schemas 1 DELETE3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

YugabyteDB Telemetry Provider API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-AUTH-YW-API-TOKEN (apiKeyAuth).

Paths & Operations 5

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

Telemetry Provider 5

Operations for Telemetry Providers

GET
/customers/{cUUID}/telemetry-provider/types
List Available Telemetry Provider Types
listTelemetryProviderTypes 2 params → 200400500
GET
/api/v1/customers/{cUUID}/telemetry_provider
List All Telemetry Providers
listAllTelemetryProviders 1 param → 200
POST
/api/v1/customers/{cUUID}/telemetry_provider
Create Telemetry Provider
createTelemetry 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/telemetry_provider/{intUUID}
Delete a telemetry provider
deleteTelemetryProvider 3 params → 200
GET
/api/v1/customers/{cUUID}/telemetry_provider/{intUUID}
Get Telemetry Provider
getTelemetryProvider 2 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are TelemetryProvider (7 properties), TelemetryProviderTypeInfo (3 properties), YBPSuccess (2 properties), TelemetryProviderConfig (1 property). Each schema is shown below with its type and property counts.

TelemetryProviderTypeInfo
object
Telemetry Provider Type Information
3 properties
TelemetryProviderConfig
object
Telemetry Provider Configuration
1 property
YBPSuccess
object
2 properties
TelemetryProvider
object
Telemetry Provider Model
7 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-telemetry-provider-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of YugabyteDB Telemetry Provider API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.