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

YugabyteDB Certificate Info API

The Certificate Info API from YugabyteDB — 7 operation(s) for certificate info.

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

Tagged areas include Certificate Info. 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 9 operations across 7 paths, and defines 21 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://cloud.yugabyte.com/api/public/v1.

9 operations 7 paths 21 schemas 1 DELETE3 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB Certificate Info API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API key obtained from the YugabyteDB Aeon UI under User Profile API Keys. Pass the key as a Bearer token in the Authorization header.

Paths & Operations 9

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

Certificate Info 9
GET
/api/v1/customers/{cUUID}/certificates
YugabyteDB Anywhere List a Customer's Certificates
getListOfCertificate 1 param → 200500
POST
/api/v1/customers/{cUUID}/certificates
YugabyteDB Anywhere Restore a Certificate from Backup
upload 2 params body → 200
POST
/api/v1/customers/{cUUID}/certificates/create_self_signed_cert
YugabyteDB Anywhere Create a Self Signed Certificate
createSelfSignedCert 2 params body → 200
GET
/api/v1/customers/{cUUID}/certificates/{name}
YugabyteDB Anywhere Get a Certificate's UUID
getCertificate 2 params → 200
DELETE
/api/v1/customers/{cUUID}/certificates/{rUUID}
YugabyteDB Anywhere Delete a Certificate
deleteCertificate 3 params → 200
POST
/api/v1/customers/{cUUID}/certificates/{rUUID}
YugabyteDB Anywhere Add a Client Certificate
getClientCert 3 params body → 200
GET
/api/v1/customers/{cUUID}/certificates/{rUUID}/download
YugabyteDB Anywhere Get a Customer's Root Certificate
getRootCert 3 params → 200
POST
/api/v1/customers/{cUUID}/certificates/{rUUID}/edit
YugabyteDB Anywhere Edit TLS Certificate Config Details
editCertificate 3 params body → 200
POST
/api/v1/customers/{cUUID}/certificates/{rUUID}/update_empty_cert
YugabyteDB Anywhere Update an Empty Certificate
updateEmptyCustomCert 3 params → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are CertificateInfoExt_2 (17 properties), CertificateInfoExt (17 properties), HashicorpVaultConfigParams_2 (10 properties), HashicorpVaultConfigParams (10 properties). Each schema is shown below with its type and property counts.

CustomServerCertData
object
2 properties 2 required
HashicorpVaultConfigParams
object
10 properties 4 required
ClientCertParams
object
3 properties 3 required
CustomCertInfo
object
5 properties 5 required
CertificateInfoExt
object
SSL certificate used by the universe
17 properties 4 required
CustomServerCertInfo
object
2 properties 2 required
YBPError
object
Generic error response from the YugabyteDB Anywhere API
6 properties
UniverseDetailSubset
object
A small subset of universe information
6 properties 6 required
YBPSuccess
object
2 properties
CertificateParams
object
Certificate Params is used to validate constraints for the custom certificate Data
9 properties 5 required
CertificateDetails
object
2 properties
CustomServerCertData_2
object
2 properties 2 required
HashicorpVaultConfigParams_2
object
10 properties 4 required
ClientCertParams_2
object
3 properties 3 required
CustomCertInfo_2
object
5 properties 5 required
CertificateInfoExt_2
object
SSL certificate used by the universe
17 properties 4 required
CustomServerCertInfo_2
object
2 properties 2 required
UniverseDetailSubset_2
object
A small subset of universe information
6 properties 6 required
YBPSuccess_2
object
2 properties
CertificateParams_2
object
Certificate Params is used to validate constraints for the custom certificate Data
9 properties 5 required
CertificateDetails_2
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-certificate-info-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 Cloud providers API
YugabyteDB Clusters API