---
title: "Get Add-On"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b/operations/get-add-on"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b.md

# Get Add-On

`GET` `/cloud-gateways/add-ons/{addOnId}`

Operation ID: `get-add-on`

Retrieves an add-on by ID.

## Path parameters

- `addOnId` (string, uuid, required) - ID of the add-on to operate on.

## Responses

- `200` - Response format for retrieving an add-on by ID.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## 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
paths:
  /cloud-gateways/add-ons/{addOnId}:
    get:
      operationId: get-add-on
      summary: Get Add-On
      description: Retrieves an add-on by ID.
      parameters:
        - $ref: "#/components/parameters/AddOnId"
      responses:
        "200":
          $ref: "#/components/responses/RetrieveAddOnResponse"
        "401":
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: "#/components/schemas/UnauthorizedError"
              examples:
                Unauthorized:
                  $ref: "#/components/examples/AddOnUnauthorizedExample"
        "403":
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: "#/components/schemas/ForbiddenError"
              examples:
                Forbidden:
                  $ref: "#/components/examples/AddOnForbiddenExample"
        "404":
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: "#/components/schemas/NotFoundError"
              examples:
                Not Found:
                  $ref: "#/components/examples/AddOnNotFoundExample"
      tags:
        - Add-Ons
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    AddOnId:
      name: addOnId
      description: ID of the add-on to operate on.
      required: true
      in: path
      schema:
        $ref: "#/components/schemas/AddOnId"
  responses:
    RetrieveAddOnResponse:
      description: Response format for retrieving an add-on by ID.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AddOnResponse"
  schemas:
    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
    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
    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
    AddOnId:
      type: string
      format: uuid
      example: 550e8400-e29b-41d4-a716-446655440000
      readOnly: true
    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
    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
    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
  examples:
    AddOnUnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:9108763905133773926
        detail: You must be authenticated to perform this action.
    AddOnForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2909730654778726250
        detail: You do not have permission to perform this action.
    AddOnNotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:3180784359748741888
        detail: The requested resource was not found.
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
