Kong Portal Custom Domains API

openapi: 3.1.0
info:
  contact:
    email: support@konghq.com
    name: Kong Inc
    url: https://konghq.com
  description: 'OpenAPI 3.0 spec for Kong Gateway''s Admin API.


    You can learn more about Kong Gateway at [developer.konghq.com](https://developer.konghq.com).

    Give Kong a star at the [Kong/kong](https://github.com/kong/kong) repository.'
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: Kong Enterprise Admin ACLs Portal Custom Domains API
  version: 3.14.0
servers:
- description: Default Admin API URL
  url: '{protocol}://{hostname}:{port}{path}'
  variables:
    hostname:
      default: localhost
      description: Hostname for Kong's Admin API
    path:
      default: /
      description: Base path for Kong's Admin API
    port:
      default: '8001'
      description: Port for Kong's Admin API
    protocol:
      default: http
      description: Protocol for requests to Kong's Admin API
      enum:
      - http
      - https
security:
- adminToken: []
tags:
- name: Portal Custom Domains
  description: APIs related to configuration of Konnect Developer Portals custom domains.
paths:
  /v3/portals/{portalId}/custom-domain:
    parameters:
    - $ref: '#/components/parameters/PortalId'
    get:
      x-speakeasy-entity-operation:
        terraform-resource: PortalCustomDomain#read
        terraform-datasource: null
      operationId: get-portal-custom-domain
      summary: Get Custom Domain
      description: Get the custom domain associated to the portal.
      responses:
        '200':
          $ref: '#/components/responses/PortalCustomDomain'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      tags:
      - Portal Custom Domains
    post:
      x-speakeasy-entity-operation:
        terraform-resource: PortalCustomDomain#create
        terraform-datasource: null
      operationId: create-portal-custom-domain
      summary: Create Custom Domain
      description: Creates the custom domain associated with the portal. Only one custom domain can be associated with a portal at a time.
      requestBody:
        $ref: '#/components/requestBodies/CreatePortalCustomDomain'
      responses:
        '201':
          $ref: '#/components/responses/PortalCustomDomain'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      tags:
      - Portal Custom Domains
    patch:
      x-speakeasy-entity-operation:
        terraform-resource: PortalCustomDomain#update
        terraform-datasource: null
      operationId: update-portal-custom-domain
      summary: Enable or Disable Domain
      description: Updates the portal domain associated with the portal.
      requestBody:
        $ref: '#/components/requestBodies/UpdatePortalCustomDomain'
      responses:
        '200':
          $ref: '#/components/responses/PortalCustomDomain'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      tags:
      - Portal Custom Domains
    delete:
      x-speakeasy-entity-operation:
        terraform-resource: PortalCustomDomain#delete
        terraform-datasource: null
      operationId: delete-portal-custom-domain
      summary: Remove Domain
      description: Deletes the custom domain associated with the portal.
      responses:
        '204':
          description: No Content
        '404':
          $ref: '#/components/responses/NotFound'
      tags:
      - Portal Custom Domains
components:
  schemas:
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
          - min_length
          - min_digits
          - min_lowercase
          - min_uppercase
          - min_symbols
          - min_items
          - min
          nullable: false
          readOnly: true
          x-speakeasy-unknown-values: allow
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
      - field
      - reason
      - rule
      - minimum
    PortalCustomDomain:
      type: object
      properties:
        hostname:
          type: string
        enabled:
          type: boolean
        ssl:
          $ref: '#/components/schemas/PortalCustomDomainSSL'
        cname_status:
          $ref: '#/components/schemas/PortalCustomDomainCnameStatus'
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
      additionalProperties: false
      required:
      - hostname
      - enabled
      - ssl
      - cname_status
      - created_at
      - updated_at
      title: PortalCustomDomain
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: '2022-11-04T20:10:06.927Z'
      readOnly: true
      x-speakeasy-param-suppress-computed-diff: true
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
          - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
      - field
      - reason
      - rule
      - choices
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
          - max_length
          - max_items
          - max
          nullable: false
          readOnly: true
          x-speakeasy-unknown-values: allow
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
      - field
      - reason
      - rule
      - maximum
    UpdatePortalCustomDomainRequest:
      type: object
      properties:
        enabled:
          type: boolean
        ssl:
          $ref: '#/components/schemas/UpdatePortalCustomDomainSSL'
      additionalProperties: false
      title: UpdatePortalCustomDomainRequest
    PortalCustomDomainSSL:
      type: object
      properties:
        domain_verification_method:
          $ref: '#/components/schemas/PortalCustomDomainVerificationMethod'
        verification_status:
          $ref: '#/components/schemas/PortalCustomDomainVerificationStatus'
        validation_errors:
          $ref: '#/components/schemas/PortalCustomDomainValidationErrors'
        uploaded_at:
          description: An ISO-8601 timestamp representation of the ssl certificate upload date.
          type: string
          format: date-time
          example: '2022-11-04T20:10:06.927Z'
          readOnly: true
        expires_at:
          description: An ISO-8601 timestamp representation of the ssl certificate expiration date.
          type: string
          format: date-time
          example: '2022-11-04T20:10:06.927Z'
          readOnly: true
        skip_ca_check:
          description: 'True when the provided certificate chain is served as-is without validation against a public trust store.

            '
          type: boolean
          readOnly: true
      additionalProperties: false
      required:
      - domain_verification_method
      - verification_status
      title: PortalCustomDomainSSL
    PortalCustomDomainValidationErrors:
      type: array
      items:
        type: string
      readOnly: true
      title: PortalCustomDomainValidationErrors
    ForbiddenError:
      allOf:
      - $ref: '#/components/schemas/BaseError'
      - type: object
        properties:
          status:
            example: 403
          title:
            example: Forbidden
          type:
            example: https://httpstatuses.com/403
          instance:
            example: kong:trace:1234567890
          detail:
            example: Forbidden
    UnauthorizedError:
      allOf:
      - $ref: '#/components/schemas/BaseError'
      - type: object
        properties:
          status:
            example: 401
          title:
            example: Unauthorized
          type:
            example: https://httpstatuses.com/401
          instance:
            example: kong:trace:1234567890
          detail:
            example: Invalid credentials
    PortalCustomDomainVerificationMethod:
      type: string
      enum:
      - http
      - custom_certificate
      title: PortalCustomDomainVerificationMethod
      x-speakeasy-unknown-values: allow
    CreatePortalCustomDomainRequest:
      type: object
      properties:
        hostname:
          type: string
        enabled:
          type: boolean
        ssl:
          $ref: '#/components/schemas/CreatePortalCustomDomainSSL'
      additionalProperties: false
      required:
      - hostname
      - enabled
      - ssl
      title: CreatePortalCustomDomainRequest
    CreatePortalCustomDomainSSLStandard:
      properties:
        domain_verification_method:
          type: string
          const: http
      additionalProperties: false
      required:
      - domain_verification_method
      title: http
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: '2022-11-04T20:10:06.927Z'
      readOnly: true
      x-speakeasy-param-suppress-computed-diff: true
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: 'The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an integer.

            '
          type: integer
          readOnly: true
        title:
          description: 'A short, human-readable summary of the problem. It should not

            change between occurences of a problem, except for localization.

            Should be provided as "Sentence case" for direct use in the UI.

            '
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: 'Used to return the correlation ID back to the user, in the format

            kong:trace:<correlation_id>. This helps us find the relevant logs

            when a customer reports an issue.

            '
          type: string
          readOnly: true
        detail:
          description: 'A human readable explanation specific to this occurence of the problem.

            This field may contain request/entity data to help the user understand

            what went wrong. Enclose variable values in square brackets. Should be

            provided as "Sentence case" for direct use in the UI.

            '
          type: string
          readOnly: true
      required:
      - status
      - title
      - instance
      - detail
      title: Error
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
          - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
      - field
      - rule
      - reason
      - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
      - required
      - is_array
      - is_base64
      - is_boolean
      - is_date_time
      - is_integer
      - is_null
      - is_number
      - is_object
      - is_string
      - is_uuid
      - is_fqdn
      - is_arn
      - unknown_property
      - missing_reference
      - is_label
      - matches_regex
      - invalid
      - is_supported_network_availability_zone_list
      - is_supported_network_cidr_block
      - is_supported_provider_region
      - type
      nullable: true
      readOnly: true
      x-speakeasy-unknown-values: allow
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
        - $ref: '#/components/schemas/InvalidParameterStandard'
        - $ref: '#/components/schemas/InvalidParameterMinimumLength'
        - $ref: '#/components/schemas/InvalidParameterMaximumLength'
        - $ref: '#/components/schemas/InvalidParameterChoiceItem'
        - $ref: '#/components/schemas/InvalidParameterDependentItem'
      minItems: 1
      nullable: false
      uniqueItems: true
    PortalCustomDomainCnameStatus:
      type: string
      enum:
      - verified
      - pending
      readOnly: true
      title: PortalCustomDomainCnameStatus
      x-speakeasy-unknown-values: allow
    BadRequestError:
      allOf:
      - $ref: '#/components/schemas/BaseError'
      - type: object
        required:
        - invalid_parameters
        properties:
          invalid_parameters:
            $ref: '#/components/schemas/InvalidParameters'
    CreatePortalCustomDomainSSL:
      type: object
      oneOf:
      - $ref: '#/components/schemas/CreatePortalCustomDomainSSLWithCustomCertificate'
      - $ref: '#/components/schemas/CreatePortalCustomDomainSSLStandard'
      title: CreatePortalCustomDomainSSL
    PortalCustomDomainVerificationStatus:
      type: string
      enum:
      - verified
      - pending
      - error
      readOnly: true
      title: PortalCustomDomainVerificationStatus
      x-speakeasy-unknown-values: allow
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: '#/components/schemas/InvalidRules'
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
      - field
      - reason
    CreatePortalCustomDomainSSLWithCustomCertificate:
      properties:
        domain_verification_method:
          type: string
          const: custom_certificate
        custom_certificate:
          description: Custom certificate to be used for the SSL termination.
          type: string
        custom_private_key:
          description: Custom certificate private key to be used for the SSL termination.
          type: string
        skip_ca_check:
          description: 'Advanced option. If true, the custom certificate is served exactly as provided, without attempting to bundle against a public trust store. Required for certificates issued by an internal/private CA.

            '
          type: boolean
          default: false
      additionalProperties: false
      required:
      - domain_verification_method
      - custom_certificate
      - custom_private_key
      title: custom_certificate
    UpdatePortalCustomDomainSSL:
      type: object
      properties:
        custom_certificate:
          description: Custom certificate to be used for the SSL termination.
          type: string
        custom_private_key:
          description: Custom certificate private key to be used for the SSL termination.
          type: string
        skip_ca_check:
          description: 'Advanced option. If true, the custom certificate is served exactly as provided, without attempting to bundle against a public trust store. Required for certificates issued by an internal/private CA.

            '
          type: boolean
          default: false
      additionalProperties: false
      title: UpdatePortalCustomDomainSSL
    NotFoundError:
      allOf:
      - $ref: '#/components/schemas/BaseError'
      - type: object
        properties:
          status:
            example: 404
          title:
            example: Not Found
          type:
            example: https://httpstatuses.com/404
          instance:
            example: kong:trace:1234567890
          detail:
            example: Not found
  responses:
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/NotFoundError'
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            description: The error response object.
            type: object
            properties:
              status:
                description: The HTTP status code.
                type: integer
                example: 403
              title:
                description: The Error Response.
                type: string
                example: Unauthorized
              instance:
                description: The Konnect traceback code.
                type: string
                example: konnect:trace:952172606039454040
              detail:
                description: Details about the error response.
                type: string
                example: You do not have permission to perform this action
            $ref: '#/components/schemas/UnauthorizedError'
            title: Unauthorized Response
    PortalCustomDomain:
      description: Portal custom domain
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PortalCustomDomain'
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ForbiddenError'
  requestBodies:
    UpdatePortalCustomDomain:
      description: Create a portal custom domain.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdatePortalCustomDomainRequest'
    CreatePortalCustomDomain:
      description: Create a portal custom domain.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreatePortalCustomDomainRequest'
  parameters:
    PortalId:
      schema:
        type: string
        format: uuid
        example: f32d905a-ed33-46a3-a093-d8f536af9a8a
      name: portalId
      in: path
      required: true
      description: ID of the portal.
  securitySchemes:
    adminToken:
      in: header
      name: Kong-Admin-Token
      type: apiKey
externalDocs:
  description: Documentation for Kong Gateway and its APIs
  url: https://developer.konghq.com