---
title: "AddOnResponse"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-dev-2/versions/ecf70889-e649-4a6a-8151-214a472a1044/schemas/AddOnResponse"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-dev-2/versions/ecf70889-e649-4a6a-8151-214a472a1044.md

# AddOnResponse

Object containing information about an add-on.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Cloud Gateways
  version: 2.0.0
servers:
  - url: https://global.api.konghq.com/v2
    description: Base URL for the global region
components:
  schemas:
    AddOnId:
      type: string
      format: uuid
      example: 550e8400-e29b-41d4-a716-446655440000
      readOnly: true
    AddOnName:
      description: Unique human-readable name of the add-on.
      type: string
      example: my-add-on
      maxLength: 70
      minLength: 1
      title: AddOnName
    AddOnOwner:
      description: Owner for the add-on.
      type: object
      oneOf:
        - $ref: "#/components/schemas/ControlPlaneAddOnOwner"
        - $ref: "#/components/schemas/ControlPlaneGroupAddOnOwner"
      title: AddOnOwner
    AddOnConfigResponse:
      description: Configuration object for different types of add-ons.
      type: object
      oneOf:
        - $ref: "#/components/schemas/ManagedCacheAddOnConfigResponse"
      title: AddOnConfigResponse
    AddOnState:
      description: >
        The current state of the add-on. Possible values:

        - `initializing` - The add-on is in the process of being
        initialized/updated.

        - `ready` - The add-on is fully operational.

        - `terminating` - The add-on is in the process of being deleted.
      type: string
      enum:
        - initializing
        - ready
        - terminating
      readOnly: true
      title: Add-On State
    ControlPlaneAddOnOwner:
      description: Control Plane is the owner for the add-on.
      type: object
      properties:
        kind:
          description: Type of owner for the add-on.
          type: string
          enum:
            - control-plane
          x-terraform-transform-const: true
        control_plane_id:
          description: ID of the control-plane that owns this add-on.
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        control_plane_geo:
          $ref: "#/components/schemas/ControlPlaneGeo"
      additionalProperties: false
      required:
        - kind
        - control_plane_id
        - control_plane_geo
      title: ControlPlaneAddOnOwner
    ControlPlaneGroupAddOnOwner:
      description: Control Plane Group is the owner for the add-on.
      type: object
      properties:
        kind:
          description: Type of owner for the add-on.
          type: string
          enum:
            - control-plane-group
          x-terraform-transform-const: true
        control_plane_group_id:
          description: ID of the control-plane group that owns this add-on.
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        control_plane_group_geo:
          $ref: "#/components/schemas/ControlPlaneGeo"
      additionalProperties: false
      required:
        - kind
        - control_plane_group_id
        - control_plane_group_geo
      title: ControlPlaneGroupAddOnOwner
    ManagedCacheAddOnConfigResponse:
      description: Configuration for managed cache add-on.
      type: object
      properties:
        kind:
          description: Type of add-on configuration.
          type: string
          enum:
            - managed-cache.v0
          x-terraform-transform-const: true
        capacity_config:
          $ref: "#/components/schemas/ManagedCacheCapacityConfig"
        data_plane_groups:
          description: List of data-plane groups where the managed cache is deployed.
          type: array
          items:
            $ref: "#/components/schemas/ManagedCacheAddOnDataPlaneGroup"
        state_metadata:
          description: |
            Metadata describing the state of the managed cache add-on.
          type: object
          additionalProperties: false
          properties:
            cache_config_id:
              description: Reference to cache configuration for this add-on.
              type: string
              format: uuid
              example: edaf40f9-9fb0-4ffe-bb74-4e763a6bd471
            cache_server_name:
              description: Env vault path to cache server name.
              type: string
              example: "{vault://env/ADDON_MANAGED_CACHE_SERVER_NAME}"
            cache_host:
              description: Env vault path to cache hostname.
              type: string
              example: "{vault://env/ADDON_MANAGED_CACHE_HOST}"
            cache_port:
              description: Env vault path to cache port.
              type: string
              example: "{vault://env/ADDON_MANAGED_CACHE_PORT}"
            cache_username:
              description: Env vault path to cache username.
              type: string
              example: "{vault://env/ADDON_MANAGED_CACHE_USERNAME}"
            cloud_authentication:
              description: >
                Metadata describing the cloud authentication details for managed
                cache add-on.
              type: object
              additionalProperties: false
              properties:
                auth_provider:
                  description: Env vault path to cache auth provider.
                  type: string
                  example: "{vault://env/ADDON_MANAGED_CACHE_AUTH_PROVIDER}"
                aws_cache_name:
                  description: Env vault path to aws cache name.
                  type: string
                  example: "{vault://env/ADDON_MANAGED_CACHE_AWS_CACHE_NAME}"
                aws_region:
                  description: Env vault path to aws region.
                  type: string
                  example: "{vault://env/ADDON_MANAGED_CACHE_AWS_REGION}"
                aws_assume_role_arn:
                  description: Env vault path to aws assume role arn.
                  type: string
                  example: "{vault://env/ADDON_MANAGED_CACHE_AWS_ASSUME_ROLE_ARN}"
                azure_tenant_id:
                  description: Env vault path to azure tenant id.
                  type: string
                  example: "{vault://env/ADDON_MANAGED_CACHE_AZURE_TENANT_ID}"
      additionalProperties: false
      required:
        - kind
        - capacity_config
        - data_plane_groups
        - state_metadata
      title: ManagedCacheAddOnConfigResponse
    ControlPlaneGeo:
      description: Set of control-plane geos supported for deploying cloud-gateways
        configurations.
      type: string
      enum:
        - us
        - eu
        - au
        - me
        - in
        - sg
      title: Control-Plane Geo
    ManagedCacheCapacityConfig:
      description: Configuration for managed cache capacity and performance characteristics.
      type: object
      oneOf:
        - $ref: "#/components/schemas/TieredCapacityConfig"
      title: ManagedCacheCapacityConfig
    ManagedCacheAddOnDataPlaneGroup:
      description: Object that describes a data-plane group where managed cache add-on
        is deployed.
      type: object
      properties:
        id:
          description: ID of the data-plane group.
          type: string
          format: uuid
          example: 1150820b-c69f-4a2a-b9be-bbcdbc5cd618
        cloud_gateway_network_id:
          description: Network ID this data-plane group is attached to.
          type: string
          format: uuid
          example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695
        provider:
          $ref: "#/components/schemas/ProviderName"
        region:
          description: Region of cloud provider the data-plane group is deployed to.
          type: string
          example: us-east-1
        state:
          description: >
            The current state of the managed cache add-on in the data-plane
            group. Possible values:

            - `initializing` - The add-on is in the process of being
            initialized/updated and is setting up necessary resources for this
            data-plane group.

            - `ready` - The add-on is fully operational for this data-plane
            group.

            - `error` - The add-on is in an error state, and is not operational
            for this data-plane group.

            - `terminating` - The add-on is in the process of being deleted for
            this data-plane group.
          type: string
          enum:
            - initializing
            - ready
            - error
            - terminating
          readOnly: true
        state_metadata:
          description: >
            Metadata describing the state of the managed cache add-on in the
            data-plane group.
          type: object
          additionalProperties: false
          properties:
            error_reason:
              description: >
                Reason why the managed cache add-on may be in an error state,
                reported from backing infrastructure.
              type: string
              example: >
                Failed to create managed cache add-on due to invalid
                configuration.
      additionalProperties: false
      required:
        - id
        - cloud_gateway_network_id
        - provider
        - region
        - state
        - state_metadata
      title: ManagedCacheAddOnDataPlaneGroup
    TieredCapacityConfig:
      description: Capacity tiers with pre-configured size and performance characteristics.
      type: object
      properties:
        kind:
          description: Type of capacity configuration.
          type: string
          enum:
            - tiered
          x-terraform-transform-const: true
        tier:
          description: >
            Capacity tier that determines both cache size and performance
            characteristics:

            - micro: ~0.5 GiB capacity

            - small: ~1 GiB capacity

            - medium: ~3 GiB capacity

            - large: ~6 GiB capacity

            - xlarge: ~12 GiB capacity

            - 2xlarge: ~25 GiB capacity

            - 4xlarge: ~52 GiB capacity

            - 8xlarge: ~100 GiB capacity

            - 12xlarge: ~150 GiB capacity

            - 16xlarge: ~200 GiB capacity

            - 24xlarge: ~300 GiB capacity
          type: string
          enum:
            - micro
            - small
            - medium
            - large
            - xlarge
            - 2xlarge
            - 4xlarge
            - 8xlarge
            - 12xlarge
            - 16xlarge
            - 24xlarge
      example:
        kind: tiered
        tier: small
      additionalProperties: false
      required:
        - kind
        - tier
      title: TieredCapacityConfig
    ProviderName:
      description: Name of cloud provider.
      type: string
      example: aws
      enum:
        - aws
        - azure
        - gcp
      title: Provider Name
    AddOnResponse:
      description: Object containing information about an add-on.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/AddOnId"
        name:
          $ref: "#/components/schemas/AddOnName"
        owner:
          $ref: "#/components/schemas/AddOnOwner"
        config:
          $ref: "#/components/schemas/AddOnConfigResponse"
        entity_version:
          description: Monotonically-increasing version count of the add-on, to indicate
            the order of updates to the add-on.
          type: integer
          example: 1
          readOnly: true
        state:
          $ref: "#/components/schemas/AddOnState"
        created_at:
          description: RFC-3339 timestamp representation of add-on creation date.
          type: string
          format: date-time
          example: 2025-08-26T06:56:41Z
          readOnly: true
        updated_at:
          description: RFC-3339 timestamp representation of add-on update date.
          type: string
          format: date-time
          example: 2025-08-26T06:56:41Z
          readOnly: true
      additionalProperties: false
      required:
        - id
        - name
        - owner
        - config
        - entity_version
        - state
        - created_at
        - updated_at
      title: AddOnResponse
```
