Catalog Resource Mappings

Create Resource Mapping

Changed on

Creates a mapping between a catalog resource and service.

post/v1/resource-mappings

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/resource-mappings
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

servicestring required

The id or name of the service to map the resource to.

Example request

{
  "service": "user-svc",
  "resource": "4UdXnoaDYYJsH_Ir"
}

Response

A response containing a single catalog resource mapping.

idstring uuid required

The resource mapping ID.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

Example response

{
  "id": "d277faad-ed4e-4c56-a0fb-acce065dee34",
  "resource": {
    "id": "4UdXnoaDYYJsH_Ir",
    "integration": {
      "name": "gateway-manager",
      "display_name": "gateway-manager",
      "instance": {
        "id": "772b9caf-ddbc-4f4f-8aa4-8dfbbe420351",
        "name": "aws-lambda-prod",
        "display_name": "AWS (prod)"
      }
    },
    "type": "gateway_svc",
    "config": {
      "control_plane_id": "ccadfb0a-56cd-4f74-955d-aec1d87157c8",
      "gateway_service_id": "94896d05-0c4d-45eb-aae3-de754885dd58"
    }
  },
  "service": {
    "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
    "name": "user-svc",
    "display_name": "User Service"
  },
  "created_at": "2022-11-04T20:10:06.927Z"
}

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 409.00 enum value to the response property for the response status