API Implementation

Create API Implementation

Changed on

Creates an implementation for an API. If all operations in an API are implemented by a single gateway service and the service has no routes that are not part of the API, then the API can be linked to the service. For cases where an API is implemented by multiple gateway services, only a subset of routes in one or more gateway services, or API operations need to be made available for API packages, then the API should be linked to the control plane that defines the routes that overlap with the API.

post/v3/apis/{apiId}/implementations

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/apis/{apiId}/implementations
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

OR

Example request

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z",
  "environment_id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "service": {
    "control_plane_id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
    "id": "7710d5c4-d902-410b-992f-18b814155b53",
    "auth_strategy_sync_error": {
      "control_plane_error": "control_plane_error_unavailable",
      "message": "Unable to connect to the control plane to update plugin"
    }
  }
}

Response

An API implementation

OR

Example response

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z",
  "environment_id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "service": {
    "control_plane_id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
    "id": "7710d5c4-d902-410b-992f-18b814155b53",
    "auth_strategy_sync_error": {
      "control_plane_error": "control_plane_error_unavailable",
      "message": "Unable to connect to the control plane to update plugin"
    }
  }
}

Changes

  • cef0f947e9c9Revision changes
    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 658ffb748f95Revision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status