---
title: "Get a Resource Mapping"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/operations/fetch-resource-mapping"
---

> Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.md

# Get a Resource Mapping

`GET` `/resource-mappings/{resourceMappingId}`

Operation ID: `fetch-resource-mapping`

Fetches a resource mapping by ID.

## Path parameters

- `resourceMappingId` (string, uuid, required) - The `id` of the resource mapping.

## Responses

- `200` - A response containing a single catalog resource mapping.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## 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
paths:
  /resource-mappings/{resourceMappingId}:
    parameters:
      - schema:
          type: string
          format: uuid
          example: d277faad-ed4e-4c56-a0fb-acce065dee34
        name: resourceMappingId
        in: path
        required: true
        description: The `id` of the resource mapping.
        x-speakeasy-match: id
    get:
      summary: Get a Resource Mapping
      description: Fetches a resource mapping by ID.
      operationId: fetch-resource-mapping
      responses:
        "200":
          $ref: "#/components/responses/CatalogResourceMappingResponse"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Catalog Resource Mappings
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  responses:
    CatalogResourceMappingResponse:
      description: A response containing a single catalog resource mapping.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CatalogResourceMapping"
          examples:
            Resource Mapping:
              $ref: "#/components/examples/ResourceMappingResponse"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    CatalogResourceMapping:
      description: Describes a mapping between a catalog resource and a service.
      type: object
      required:
        - id
        - resource
        - service
        - created_at
      properties:
        id:
          type: string
          format: uuid
          example: d277faad-ed4e-4c56-a0fb-acce065dee34
          description: The resource mapping ID.
        resource:
          $ref: "#/components/schemas/CatalogResourceRef"
        service:
          $ref: "#/components/schemas/CatalogServiceRef"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
    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
    CatalogResourceRef:
      type: object
      description: Short-hand descriptor of a catalog resource.
      required:
        - id
        - name
        - type
        - config
        - integration
      properties:
        id:
          $ref: "#/components/schemas/CatalogResourceId"
        name:
          type: string
          nullable: true
          description: The name of the resource.
        integration:
          $ref: "#/components/schemas/IntegrationRef"
        type:
          $ref: "#/components/schemas/CatalogResourceType"
        config:
          $ref: "#/components/schemas/CatalogResourceConfig"
    CatalogServiceRef:
      type: object
      description: Short-hand descriptor of a catalog service.
      required:
        - id
        - name
        - display_name
      properties:
        id:
          type: string
          format: uuid
          example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
          description: The service ID.
        name:
          type: string
          description: >
            The machine name of the service that uniquely identifies it within
            the catalog.
          example: user-svc
        display_name:
          type: string
          description: The display name of the service.
          example: User Service
    CreatedAt:
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      description: An ISO-8601 timestamp representation of entity creation date.
      readOnly: true
      x-speakeasy-param-suppress-computed-diff: true
    BaseError:
      type: object
      title: Error
      description: standard error
      required:
        - status
        - title
        - instance
        - detail
      properties:
        status:
          type: integer
          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.
          readOnly: true
        title:
          type: string
          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.
          readOnly: true
        type:
          type: string
          description: The error type.
          readOnly: true
        instance:
          type: string
          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.
          readOnly: true
        detail:
          type: string
          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.
          readOnly: true
    CatalogResourceId:
      type: string
      format: base64url
      example: 4UdXnoaDYYJsH_Ir
      description: The resource ID.
      minLength: 16
      maxLength: 16
    IntegrationRef:
      type: object
      description: Short-hand descriptor of an integration installed within the catalog.
      required:
        - name
        - display_name
        - instance
      properties:
        name:
          type: string
          example: gateway-manager
        display_name:
          type: string
          example: gateway-manager
        instance:
          $ref: "#/components/schemas/IntegrationInstanceRef"
    CatalogResourceType:
      type: string
      description: >
        The resource type. Available resource types are compiled from the
        integrations installed within the catalog.
      minLength: 1
      maxLength: 120
      example: gateway_svc
    CatalogResourceConfig:
      x-speakeasy-type-override: any
      type: object
      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.
      additionalProperties: true
      example:
        control_plane_id: ccadfb0a-56cd-4f74-955d-aec1d87157c8
        gateway_service_id: 94896d05-0c4d-45eb-aae3-de754885dd58
    IntegrationInstanceRef:
      type: object
      description: Short-hand descriptor of an integration instance.
      required:
        - id
        - name
        - display_name
      properties:
        id:
          type: string
          format: uuid
          example: 772b9caf-ddbc-4f4f-8aa4-8dfbbe420351
          description: The integration instance ID.
        name:
          type: string
          description: >
            The machine name of the integration instance that uniquely
            identifies it within the catalog.
          pattern: ^[0-9a-z.-]+$
          example: aws-lambda-prod
        display_name:
          type: string
          description: The display name of the integration instance.
          example: AWS (prod)
  examples:
    ResourceMappingResponse:
      value:
        id: b1460dbc-1490-42ae-b9cf-b2fe479ebde5
        resource:
          id: rQIGLHo1vhgy5VYb
          name: my-gateway-service
          type: gateway_svc
          integration:
            name: gateway-manager
            display_name: Gateway Manager
            instance:
              id: da715411-0393-4dc7-b711-33250e7658f3
              name: gateway-manager
              display_name: Gateway Manager
          config:
            control_plane_id: 028bcd27-e0f7-46bd-ad9f-e7a6dd7d5a8e
            gateway_service_id: dbba7bb2-eded-4668-b662-b8bb57684baf
        service:
          id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
          name: sample-service
          display_name: Sample Service
        created_at: 2022-11-04T20:10:06.927Z
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: 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...'`
```