---
title: "List Resource Mappings"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/operations/list-resource-mappings"
---

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

# List Resource Mappings

`GET` `/resource-mappings`

Operation ID: `list-resource-mappings`

Returns a paginated collection of catalog resource mappings.

## Query parameters

- `page[size]` (integer, optional) - The maximum number of items to include per page. The last page of a collection may include fewer items.
- `page[number]` (integer, optional) - Determines which page of the entities to retrieve.
- `filter` (object, optional) - Filters a collection of resource mappings.
- `sort` (string, optional) - Sorts a collection of resource mappings. Supported sort attributes are: - `created_at` Default sort is `created_at` in descending order.

## Responses

- `200` - A paginated list response for a collection of catalog resource mappings.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden

## 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:
    get:
      summary: List Resource Mappings
      description: Returns a paginated collection of catalog resource mappings.
      operationId: list-resource-mappings
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/CatalogResourceMappingFilter"
        - $ref: "#/components/parameters/CatalogResourceMappingSort"
      responses:
        "200":
          $ref: "#/components/responses/ListCatalogResourceMappingsResponse"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - Catalog Resource Mappings
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    PageSize:
      name: page[size]
      description: The maximum number of items to include per page. The last page of a
        collection may include fewer items.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 10
    PageNumber:
      name: page[number]
      description: Determines which page of the entities to retrieve.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 1
    CatalogResourceMappingFilter:
      name: filter
      description: Filters a collection of resource mappings.
      required: false
      in: query
      style: deepObject
      schema:
        $ref: "#/components/schemas/CatalogResourceMappingFilterParameters"
    CatalogResourceMappingSort:
      name: sort
      description: |
        Sorts a collection of resource mappings. Supported sort attributes are:
          - `created_at`

        Default sort is `created_at` in descending order.
      required: false
      in: query
      schema:
        $ref: "#/components/schemas/SortQuery"
  responses:
    ListCatalogResourceMappingsResponse:
      description: A paginated list response for a collection of catalog resource mappings.
      content:
        application/json:
          schema:
            type: object
            additionalProperties: false
            properties:
              meta:
                $ref: "#/components/schemas/PaginatedMeta"
              data:
                type: array
                items:
                  $ref: "#/components/schemas/CatalogResourceMapping"
            required:
              - meta
              - data
          examples:
            Resource Mappings:
              $ref: "#/components/examples/ResourceMappingListResponse"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    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"
  schemas:
    CatalogResourceMappingFilterParameters:
      type: object
      properties:
        resource.id:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilterExact"
        resource.name:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilter"
        resource.type:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilter"
        resource.config:
          oneOf:
            - $ref: "#/components/schemas/CatalogResourceConfigFieldFilter"
        resource.integration.name:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilter"
        resource.integration.display_name:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilter"
        resource.integration.instance.id:
          oneOf:
            - $ref: "#/components/schemas/UuidFieldFilter"
        resource.integration.instance.name:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilter"
        resource.integration.instance.display_name:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilter"
        service.id:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilterExact"
        service.name:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilter"
        service.display_name:
          oneOf:
            - $ref: "#/components/schemas/StringFieldFilter"
        created_at:
          $ref: "#/components/schemas/DateTimeFieldFilter"
    SortQuery:
      title: SortQuery
      type: string
      example: created_at desc
      description: >
        The `asc` suffix is optional as the default sort order is ascending.

        The `desc` suffix is used to specify a descending order.

        Multiple sort attributes may be provided via a comma separated list.

        JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar
        desc').
    PaginatedMeta:
      type: object
      title: PaginatedMeta
      x-speakeasy-terraform-ignore: true
      description: returns the pagination information
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
    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"
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    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
    StringFieldFilterExact:
      description: "Filter using **one** of the following operators: `eq`, `oeq`, `neq`"
      x-examples:
        example-1:
          oeq: some-value,some-other-value
          neq: not-this-value
        example-2:
          eq: some-value
      properties:
        eq:
          type: string
          description: The field exactly matches the provided value.
          example: ?filter[field_name_here][eq]=foo
        oeq:
          type: string
          description: The field matches any of the provided values.
          example: ?filter[field_name_here][oeq]=foo,bar
        neq:
          type: string
          description: The field does not match the provided value.
          example: ?filter[field_name_here][neq]=bar
      type: object
      additionalProperties: false
    StringFieldFilter:
      oneOf:
        - title: Filter by operator
          description: "Filter using **one** of the following operators: `eq`, `oeq`,
            `neq`, `contains`, `ocontains`"
          x-examples:
            example-1:
              contains: some-value
              ocontains: this-value,or-that-value
              oeq: some-value,some-other-value
              neq: not-this-value
            example-2:
              eq: some-value
          properties:
            eq:
              type: string
              description: The field exactly matches the provided value.
              example: ?filter[field_name_here][eq]=foo
            contains:
              type: string
              description: The field contains the provided value.
              example: ?filter[field_name_here][contains]=foo
            ocontains:
              type: string
              description: The field contains any of the provided values.
              example: ?filter[field_name_here][ocontains]=foo,bar
            oeq:
              type: string
              description: The field matches any of the provided values.
              example: ?filter[field_name_here][oeq]=foo,bar
            neq:
              type: string
              description: The field does not match the provided value.
              example: ?filter[field_name_here][neq]=bar
          type: object
          additionalProperties: false
        - title: Filter by exact string match
          type: string
          description: The field exactly matches the provided value.
          example: ?filter[title]=foo
    CatalogResourceConfigFieldFilter:
      description: "Filter using **one** of the following operators: `eq`, `oeq`,
        `neq`, `contains`, `ocontains`"
      x-examples:
        example-1:
          contains: some-value
          ocontains: this-value,or-that-value
          oeq: some-value,some-other-value
          neq: not-this-value
        example-2:
          eq: some-value
      properties:
        eq:
          type: string
          description: The field exactly matches the provided value.
          example: ?filter[field_name_here][eq]=foo
        contains:
          type: string
          description: The field contains the provided value.
          example: ?filter[field_name_here][contains]=foo
        ocontains:
          type: string
          description: The field contains any of the provided values.
          example: ?filter[field_name_here][ocontains]=foo,bar
        oeq:
          type: string
          description: The field matches any of the provided values.
          example: ?filter[field_name_here][oeq]=foo,bar
        neq:
          type: string
          description: The field does not match the provided value.
          example: ?filter[field_name_here][neq]=bar
      type: object
      additionalProperties: false
    UuidFieldFilter:
      description: "Filter using **one** of the following operators: `eq`, `oeq`, `neq`"
      x-examples:
        example-1:
          oeq: some-value,some-other-value
          neq: not-this-value
        example-2:
          eq: some-value
      properties:
        eq:
          type: string
          description: The field exactly matches the provided value.
          example: ?filter[field_name_here][eq]=foo
        oeq:
          type: string
          description: The field matches any of the provided values.
          example: ?filter[field_name_here][oeq]=foo,bar
        neq:
          type: string
          description: The field does not match the provided value.
          example: ?filter[field_name_here][neq]=bar
      type: object
      additionalProperties: false
    DateTimeFieldFilter:
      title: DateTimeFieldFilter
      description: Filters on the given datetime (RFC-3339) field value.
      oneOf:
        - type: string
          title: DateTimeFieldImplicitEqualsFilter
          format: date-time
          description: Value strictly equals given RFC-3339 formatted timestamp in UTC
          example: 2022-03-30T07:20:50Z
        - type: object
          title: DateTimeFieldEqualsFilter
          additionalProperties: false
          properties:
            eq:
              type: string
              format: date-time
              description: Value strictly equals given RFC-3339 formatted timestamp in UTC
              example: 2022-03-30T07:20:50Z
          required:
            - eq
        - type: object
          title: DateTimeFieldLTFilter
          additionalProperties: false
          properties:
            lt:
              type: string
              format: date-time
              description: Value is less than the given RFC-3339 formatted timestamp in UTC
              example: 2022-03-30T07:20:50Z
          required:
            - lt
        - type: object
          title: DateTimeFieldLTEFilter
          additionalProperties: false
          properties:
            lte:
              type: string
              format: date-time
              description: Value is less than or equal to the given RFC-3339 formatted
                timestamp in UTC
              example: 2022-03-30T07:20:50Z
          required:
            - lte
        - type: object
          title: DateTimeFieldGTFilter
          additionalProperties: false
          properties:
            lt:
              type: string
              format: date-time
              description: Value is greater than the given RFC-3339 formatted timestamp in UTC
              example: 2022-03-30T07:20:50Z
          required:
            - gt
        - type: object
          title: DateTimeFieldGTEFilter
          additionalProperties: false
          properties:
            lte:
              type: string
              format: date-time
              description: Value is greater than or equal to the given RFC-3339 formatted
                timestamp in UTC
              example: 2022-03-30T07:20:50Z
          required:
            - gte
      x-examples:
        datetime_field_1: 2022-03-30T07:20:50Z
        datetime_field_2:
          eq: 2022-03-30T07:20:50Z
        datetime_field_3:
          lt: 2022-03-30T07:20:50Z
        datetime_field_4:
          lte: 2022-03-30T07:20:50Z
        datetime_field_5:
          gt: 2022-03-30T07:20:50Z
        datetime_field_6:
          gte: 2022-03-30T07:20:50Z
    PageMeta:
      type: object
      description: Contains pagination query parameters and the total number of
        objects returned.
      required:
        - number
        - size
        - total
      properties:
        number:
          type: number
          example: 1
          x-speakeasy-terraform-ignore: true
        size:
          type: number
          example: 10
          x-speakeasy-terraform-ignore: true
        total:
          type: number
          example: 100
          x-speakeasy-terraform-ignore: true
    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
    InvalidParameters:
      type: array
      nullable: false
      uniqueItems: true
      minItems: 1
      description: invalid parameters
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
    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
    InvalidParameterStandard:
      type: object
      additionalProperties: false
      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
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          readOnly: true
          nullable: false
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          readOnly: true
          nullable: false
          enum:
            - max_length
            - max_items
            - max
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          readOnly: true
          nullable: false
          enum:
            - enum
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          uniqueItems: true
          readOnly: true
          nullable: false
          minItems: 1
          items: {}
        source:
          type: string
          example: body
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          readOnly: true
          nullable: true
          enum:
            - dependent_fields
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          uniqueItems: true
          nullable: true
          items: {}
          readOnly: true
        source:
          type: string
          example: body
      required:
        - field
        - rule
        - reason
        - dependents
    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)
    InvalidRules:
      description: invalid parameters rules
      type: string
      readOnly: true
      nullable: true
      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
  examples:
    ResourceMappingListResponse:
      value:
        data:
          - 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
        meta:
          page:
            total: 1
            size: 100
            number: 1
    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
  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...'`
```