Catalog Service API Mappings

List API Mappings for a Service

Changed on

Returns a paginated collection of API mappings for the given service.

get/v1/catalog-services/{serviceId}/api-mappings

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/catalog-services/{serviceId}/api-mappings
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Query parameters

page[size]integer
Example:10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]integer
Example:1

Determines which page of the entities to retrieve.

sortstring

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').

Example:created_at desc

Sorts a collection of catalog service API mappings. Supported sort attributes are:

  • created_at
  • updated_at

Default sort is created_at in descending order.

Filters a collection of catalog service API mappings for a given Service. Supported filter attributes are:

  • api_id

Response

A paginated list response for a collection of catalog service API mappings.

Example response

{
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status