---
title: "CatalogResourceRef"
url: "https://nov18-dev.movespot.fyi/apis/konnect-service-catalog-1/versions/781fdf4f-a935-4ec1-9343-3203c8afd399/schemas/CatalogResourceRef"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-service-catalog-1/versions/781fdf4f-a935-4ec1-9343-3203c8afd399.md

# CatalogResourceRef

Short-hand descriptor of a catalog resource.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.3.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    CatalogResourceId:
      description: The resource ID.
      type: string
      format: base64url
      example: 4UdXnoaDYYJsH_Ir
      maxLength: 16
      minLength: 16
    IntegrationRef:
      description: Short-hand descriptor of an integration installed within the catalog.
      type: object
      properties:
        name:
          type: string
          example: gateway-manager
        display_name:
          type: string
          example: gateway-manager
        instance:
          $ref: "#/components/schemas/IntegrationInstanceRef"
      required:
        - name
        - display_name
        - instance
    CatalogResourceType:
      description: >
        The resource type. Available resource types are compiled from the
        integrations installed within the catalog.
      type: string
      example: gateway_svc
      maxLength: 120
      minLength: 1
    CatalogResourceConfig:
      description: >
        JSON object representing the properties used to identify the resource in
        the third-party system.

        The schema depends on the resource type and is dynamically registered at
        runtime.
      type: object
      example:
        control_plane_id: ccadfb0a-56cd-4f74-955d-aec1d87157c8
        gateway_service_id: 94896d05-0c4d-45eb-aae3-de754885dd58
      additionalProperties: true
    IntegrationInstanceRef:
      description: Short-hand descriptor of an integration instance.
      type: object
      properties:
        id:
          description: The integration instance ID.
          type: string
          format: uuid
          example: 772b9caf-ddbc-4f4f-8aa4-8dfbbe420351
        name:
          description: >
            The machine name of the integration instance that uniquely
            identifies it within the catalog.
          type: string
          example: aws-lambda-prod
          pattern: ^[0-9a-z.-]+$
        display_name:
          description: The display name of the integration instance.
          type: string
          example: AWS (prod)
      required:
        - id
        - name
        - display_name
    CatalogResourceRef:
      description: Short-hand descriptor of a catalog resource.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/CatalogResourceId"
        name:
          description: The name of the resource.
          type: string
          nullable: true
        integration:
          $ref: "#/components/schemas/IntegrationRef"
        type:
          $ref: "#/components/schemas/CatalogResourceType"
        config:
          $ref: "#/components/schemas/CatalogResourceConfig"
      required:
        - id
        - name
        - type
        - config
        - integration
```
