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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
YugabyteDB

YugabyteDB Customer management API

The Customer management API from YugabyteDB — 4 operation(s) for customer management.

Documentation Provider Profile APIs.io OpenAPI GitHub

YugabyteDB Customer management API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 4 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

6 operations 4 paths 32 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
API Key
Contact
https://docs.yugabyte.com
License
Polyform Free Trial License 1.0.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

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

  • apiKeyAuth — API token passed as header

Paths & Operations 6

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

Customer management 6
GET
/api/v1/customers
List customers
ListOfCustomers 1 param → 200
DELETE
/api/v1/customers/{cUUID}
Delete a customer
deleteCustomer 2 params → 200
GET
/api/v1/customers/{cUUID}
Get a customer's details
CustomerDetail 1 param → 200
PUT
/api/v1/customers/{cUUID}
Update a customer
UpdateCustomer 2 params body → 200
GET
/api/v1/customers/{cUUID}/host_info
Get a customer's host info
getHostInfo 1 param → 200
POST
/api/v1/customers/{cUUID}/metrics
Add metrics to a customer
metrics 2 params body → 200400

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are MetricQueryParams_4 (15 properties), MetricQueryParams (15 properties), MetricQueryParams_3 (15 properties), CustomerAlertData (9 properties). Each schema is shown below with its type and property counts.

CustomerAlertData
object
Format of an alert, used by the API and UI to validate data against input constraints
9 properties 3 required
AlertingData
object
Alerting configuration
6 properties
MetricSettings
object
Settings, selected for particular metric
8 properties 1 required
MetricQueryParams
object
Metrics request data
15 properties 3 required
SmtpData
object
SMTP configuration information
7 properties
YBPSuccess
object
2 properties
Customer
object
Customer information, including associated universes
5 properties 2 required
YBPError
object
Generic error response from the YugabyteDB Anywhere API
6 properties
CustomerDetailsData
object
Customer details, including their universe UUIDs. Only the customer code and name are modifiable.
9 properties 2 required
CustomerAlertData_2
object
Format of an alert, used by the API and UI to validate data against input constraints
9 properties 3 required
AlertingData_2
object
Alerting configuration
6 properties
MetricSettings_2
object
Settings, selected for particular metric
3 properties 3 required
MetricQueryParams_2
object
Metrics request data
7 properties 1 required
SmtpData_2
object
SMTP configuration information
7 properties
YBPSuccess_2
object
2 properties
Customer_2
object
Customer information, including associated universes
6 properties 2 required
YBPError_2
object
Generic error response from the YugabyteDB Anywhere API
3 properties
CustomerDetailsData_2
object
Customer details, including their universe UUIDs. Only the customer code and name are modifiable.
9 properties 2 required
CustomerAlertData_3
object
Format of an alert, used by the API and UI to validate data against input constraints
9 properties 3 required
AlertingData_3
object
Alerting configuration
6 properties
MetricSettings_3
object
Settings, selected for particular metric
8 properties 1 required
MetricQueryParams_3
object
Metrics request data
15 properties 3 required
YBPSuccess_3
object
2 properties
Customer_3
object
Customer information, including associated universes
5 properties 2 required
CustomerDetailsData_3
object
Customer details, including their universe UUIDs. Only the customer code and name are modifiable.
9 properties 2 required
CustomerAlertData_4
object
Format of an alert, used by the API and UI to validate data against input constraints
9 properties 3 required
AlertingData_4
object
Alerting configuration
6 properties
MetricSettings_4
object
Settings, selected for particular metric
8 properties 1 required
MetricQueryParams_4
object
Metrics request data
15 properties 3 required
YBPSuccess_4
object
2 properties
Customer_4
object
Customer information, including associated universes
5 properties 2 required
CustomerDetailsData_4
object
Customer details, including their universe UUIDs. Only the customer code and name are modifiable.
9 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-customer-management-api-openapi.yml Raw ↑

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
AE Profile APIs.io
YugabyteDB Accounts API
AE Profile APIs.io
YugabyteDB Alerts API
AE Profile APIs.io
YugabyteDB AllowLists API
AE Profile APIs.io
YugabyteDB Asynchronous Replication API
AE Profile APIs.io
YugabyteDB Audit API
AE Profile APIs.io
YugabyteDB Authentication API
AE Profile APIs.io
YugabyteDB Availability Zones API
AE Profile APIs.io
YugabyteDB Backup and Restore API
AE Profile APIs.io
YugabyteDB Backups API
AE Profile APIs.io
YugabyteDB Certificate Info API
AE Profile APIs.io
YugabyteDB Cloud providers API
AE Profile APIs.io
#Customer Management
← Back to Y APIs
API Details
ID
yugabytedb:yugabytedb-customer-management-api
Base URL
https://cloud.yugabyte.com/api/public/v1
Docs
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/
Provider
YugabyteDB
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=yugabytedb-customer-management-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabytedb-customer-management-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of YugabyteDB Customer management 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.