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 Encryption at rest API

The Encryption at rest API from YugabyteDB — 7 operation(s) for encryption at rest.

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

Tagged areas include Encryption at rest. 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 10 operations across 7 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

10 operations 7 paths 9 schemas 2 DELETE4 GET3 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
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB Encryption at rest 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 10

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

Encryption at rest 10
GET
/api/v1/customers/{cUUID}/kms_configs
List KMS configurations
listKMSConfigs 1 param → 200
DELETE
/api/v1/customers/{cUUID}/kms_configs/{configUUID}
Delete a KMS configuration
deleteKMSConfig 3 params → 200
GET
/api/v1/customers/{cUUID}/kms_configs/{configUUID}
Get details of a KMS configuration
getKMSConfig 2 params → 200
POST
/api/v1/customers/{cUUID}/kms_configs/{configUUID}/edit
Edit a KMS configuration
editKMSConfig 3 params body → 200
PUT
/api/v1/customers/{cUUID}/kms_configs/{configUUID}/refresh
Refresh KMS Config
refreshKMSConfig 3 params → 200500
POST
/api/v1/customers/{cUUID}/kms_configs/{kmsProvider}
Create a KMS configuration
createKMSConfig 3 params body → 200
DELETE
/api/v1/customers/{cUUID}/universes/{uniUUID}/kmsdeprecated
This API removes a universe's key reference history - deprecated
removeKeyRefHistory 3 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/kms
Get a universe's key reference history
getKeyRefHistory 2 params → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/kms
Retrive a universe's KMS key
retrieveKey 3 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/kms/key_ref
Get a universe's key reference
getCurrentKeyRef 2 params → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are YBPError (6 properties), YBPSuccess_4 (2 properties), YBPTask_3 (2 properties), YBPSuccess_3 (2 properties). Each schema is shown below with its type and property counts.

YBPSuccess
object
2 properties
YBPError
object
Generic error response from the YugabyteDB Anywhere API
6 properties
YBPTask
object
2 properties
YBPSuccess_2
object
2 properties
YBPTask_2
object
2 properties
YBPSuccess_3
object
2 properties
YBPTask_3
object
2 properties
YBPSuccess_4
object
2 properties
YBPTask_4
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-encryption-at-rest-api-openapi.yml Raw ↑

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
YugabyteDB Accounts API
YugabyteDB Alerts API
YugabyteDB AllowLists API
YugabyteDB Asynchronous Replication API
YugabyteDB Audit API
YugabyteDB Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Backups API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API
Where this information came from

This is an independent, third-party profile of YugabyteDB Encryption at rest 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.