openapi: 3.2.0
info:
  contact:
    name: https://docs.yugabyte.com
  description: ALPHA - NOT FOR EXTERNAL USE
  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)
  title: YugabyteDB Anywhere Custom CA Certificates API
  version: v1
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
  /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
  /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
  /api/v1/customers/{cUUID}/customCAStoreCertificates/{certUUID}:
    delete:
      description: 'WARNING: This is a preview API that could change.'
      operationId: DeleteCustomCACertificate
      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
      x-operation-id-source: normalized
      x-operation-id-original: Delete custom CA certificate
    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
components:
  schemas:
    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
    CustomCACertParams:
      example:
        contents: contents
        name: name
      properties:
        contents:
          type: string
        name:
          type: string
      required:
      - contents
      - name
      type: object
    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
  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-original-swagger-version: '2.0'