YugabyteDB

YugabyteDB Custom CA Certificates API

The Custom CA Certificates API from YugabyteDB — 4 operation(s) for custom ca certificates.

Documentation GitHub OpenAPI

Operations 5

POST /api/v1/customers/{cUUID}/customCAStore Add a named custom CA certificate #

POST /api/v1/customers/{cUUID}/customCAStore/{certUUID} Update a named custom CA certificate #

GET /api/v1/customers/{cUUID}/customCAStoreCertificates List all custom CA certificates of a customer #

DELETE /api/v1/customers/{cUUID}/customCAStoreCertificates/{certUUID} Delete a named custom CA certificate #

GET /api/v1/customers/{cUUID}/customCAStoreCertificates/{certUUID} Download a custom CA certificates of a customer #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/yugabytedb-custom-ca-certificates-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Yugabytedb Custom CA Certificates API
  version: v1
  contact:
    name: https://docs.yugabyte.com
  license:
    name: Polyform Free Trial License 1.0.0
    url: https://github.com/yugabyte/yugabyte-db/blob/master/licenses/POLYFORM-FREE-TRIAL-LICENSE-1.0.0.txt
  termsOfService: TODO(chirag)
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  - x-split-from differs across the merged source definitions and was not carried
  description: 'Operations tagged Custom CA Certificates across 3 of this provider''s published API definitions: openapi_2.yaml, yugabytedb-anywhere-v1-full.yaml, yugabytedb-anywhere-v1-providers-infra.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
tags:
- name: Custom CA Certificates
paths:
  /api/v1/customers/{cUUID}/customCAStore:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: addCA
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomCACertParams'
        description: CA certificate contents in 'X509' format
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                format: uuid
                type: string
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Add a named custom CA certificate
      tags:
      - Custom CA Certificates
      x-codegen-request-body-name: X509CACertificate
    servers:
    - url: /
  /api/v1/customers/{cUUID}/customCAStore/{certUUID}:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: updateCA
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: certUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomCACertParams'
        description: CA certificate contents in 'X509' format
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                format: uuid
                type: string
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Update a named custom CA certificate
      tags:
      - Custom CA Certificates
      x-codegen-request-body-name: X509CACertificate
    servers:
    - url: /
  /api/v1/customers/{cUUID}/customCAStoreCertificates:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: listAllCustomCaCertificates
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CustomCaCertificateInfo'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List all custom CA certificates of a customer
      tags:
      - Custom CA Certificates
    servers:
    - url: /
  /api/v1/customers/{cUUID}/customCAStoreCertificates/{certUUID}:
    delete:
      description: 'WARNING: This is a preview API that could change.'
      operationId: Delete custom CA certificate
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: certUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete a named custom CA certificate
      tags:
      - Custom CA Certificates
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: getAllCustomCaCertificates
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: certUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomCaCertificateInfo'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Download a custom CA certificates of a customer
      tags:
      - Custom CA Certificates
    servers:
    - url: /
components:
  schemas:
    YBPSuccess:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
      type: object
    CustomCACertParams:
      example:
        contents: contents
        name: name
      properties:
        contents:
          type: string
        name:
          type: string
      required:
      - contents
      - name
      type: object
    CustomCaCertificateInfo:
      description: Custom CA certificate
      example:
        expiryDate: 2024-07-12 13:07:18+00:00
        contents: /opt/yugaware/certs/trust-store/<ID>/ca.root.cert
        customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        name: name
        active: true
        createdTime: 2023-11-10 15:09:18+00:00
        id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        startDate: 2023-10-12 13:07:18+00:00
      properties:
        active:
          type: boolean
        contents:
          description: Path to CA Certificate
          example: /opt/yugaware/certs/trust-store/<ID>/ca.root.cert
          type: string
        createdTime:
          description: Date when certificate was added.
          example: 2023-11-10 15:09:18+00:00
          format: date-time
          type: string
        customerId:
          format: uuid
          type: string
        expiryDate:
          description: End date of certificate validity.
          example: 2024-07-12 13:07:18+00:00
          format: date-time
          type: string
        id:
          format: uuid
          type: string
        name:
          type: string
        startDate:
          description: Start date of certificate validity.
          example: 2023-10-12 13:07:18+00:00
          format: date-time
          type: string
      required:
      - active
      - customerId
      - id
      - name
      type: object
    YBPSuccess_2:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
          example: Example message
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
          example: true
      type: object
    CustomCACertParams_2:
      example:
        contents: contents
        name: name
      properties:
        contents:
          type: string
          example: example-contents
        name:
          type: string
          example: example-name
      required:
      - contents
      - name
      type: object
    CustomCaCertificateInfo_2:
      description: Custom CA certificate
      example:
        expiryDate: 2024-07-12 13:07:18+00:00
        contents: /opt/yugaware/certs/trust-store/<ID>/ca.root.cert
        customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        name: name
        active: true
        createdTime: 2023-11-10 15:09:18+00:00
        id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        startDate: 2023-10-12 13:07:18+00:00
      properties:
        active:
          type: boolean
          example: true
        contents:
          description: Path to CA Certificate
          example: /opt/yugaware/certs/trust-store/<ID>/ca.root.cert
          type: string
        createdTime:
          description: Date when certificate was added.
          example: 2023-11-10 15:09:18+00:00
          format: date-time
          type: string
        customerId:
          format: uuid
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        expiryDate:
          description: End date of certificate validity.
          example: 2024-07-12 13:07:18+00:00
          format: date-time
          type: string
        id:
          format: uuid
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        name:
          type: string
          example: example-name
        startDate:
          description: Start date of certificate validity.
          example: 2023-10-12 13:07:18+00:00
          format: date-time
          type: string
      required:
      - active
      - customerId
      - id
      - name
      type: object
    YBPSuccess_3:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
          example: Example message
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
          example: true
      type: object
    CustomCACertParams_3:
      example:
        contents: contents
        name: name
      properties:
        contents:
          type: string
          example: example-contents
        name:
          type: string
          example: example-name
      required:
      - contents
      - name
      type: object
    CustomCaCertificateInfo_3:
      description: Custom CA certificate
      example:
        expiryDate: 2024-07-12 13:07:18+00:00
        contents: /opt/yugaware/certs/trust-store/<ID>/ca.root.cert
        customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        name: name
        active: true
        createdTime: 2023-11-10 15:09:18+00:00
        id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        startDate: 2023-10-12 13:07:18+00:00
      properties:
        active:
          type: boolean
          example: true
        contents:
          description: Path to CA Certificate
          example: /opt/yugaware/certs/trust-store/<ID>/ca.root.cert
          type: string
        createdTime:
          description: Date when certificate was added.
          example: 2023-11-10 15:09:18+00:00
          format: date-time
          type: string
        customerId:
          format: uuid
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        expiryDate:
          description: End date of certificate validity.
          example: 2024-07-12 13:07:18+00:00
          format: date-time
          type: string
        id:
          format: uuid
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        name:
          type: string
          example: example-name
        startDate:
          description: Start date of certificate validity.
          example: 2023-10-12 13:07:18+00:00
          format: date-time
          type: string
      required:
      - active
      - customerId
      - id
      - name
      type: object
  securitySchemes:
    apiKeyAuth:
      description: API token passed as header
      in: header
      name: X-AUTH-YW-API-TOKEN
      type: apiKey
externalDocs:
  description: About YugabyteDB Anywhere
  url: https://docs.yugabyte.com/latest/yugabyte-platform/
x-refined-from:
- openapi_2.yaml
- yugabytedb-anywhere-v1-full.yaml
- yugabytedb-anywhere-v1-providers-infra.yaml