Qodex.ai

Kong CE Admin API V2.0

Number of APIs: 118

Kong Community Edition Admin API

This Qodex Collection refers to the Kong Community Edition Admin API for running Kong configured with a database (Postgres or Cassandra). For using the Admin API for Kong in DB-less mode, please refer to the Admin API for DB-less Mode konghq.

Disclaimer: Collection not hardened by development AToW George Jeffcock

Kong comes with an internal RESTful Admin API for administration purposes. Requests to the Admin API can be sent to any node in the cluster, and Kong will keep the configuration consistent across all nodes.

  • 8001 is the default port on which the Admin API listens.
  • 8444 is the default port for HTTPS traffic to the Admin API.

This API is designed for internal use and provides full control over Kong, so care should be taken when setting up Kong environments to avoid undue public exposure of this API. See this document for a discussion of methods to secure the Admin API.

Supported Content Types

  • The Admin API accepts 2 content types on every endpoint:
  • application/x-www-form-urlencoded
    • Simple enough for basic request bodies, you will probably use it most of the time. Note that when sending nested values, Kong expects nested objects to be referenced with dotted keys
    • Example: config.limit=10&config.period=seconds
  • application/json
    • Handy for complex bodies (ex: complex plugin configuration), in that case simply send a JSON representation of the data you want to send.
    • Example: {config: {limit: 10, period: seconds}}

  1. Information Routes - Retrieve Node Information GET {{gateway}}/

  2. Health Routes - Retrieve Node Status GET {{gateway}}/status

  3. Tags - List All Tags GET {{gateway}}/tags

  4. Tags - List Entity Ids by Tag GET {{gateway}}/tags/:tags

  5. Service Object-Add Service - Create Service POST {{gateway}}/services

  6. Service Object-Add Service - Create Service Associated to a Specific Certificate POST {{gateway}}/certificates/:certificateIdorName/services

  7. Service Object-List Services - List all services GET {{gateway}}/services?tags={{tags}}

  8. Service Object-List Services - List Services Associated to a Specific Certificate GET {{gateway}}/certificates/:certificateNameOrId/services

  9. Service Object-Retrieve Service - Retrieve Service GET {{gateway}}/services/:serviceNameOrID

  10. Service Object-Retrieve Service - Retrieve Service Associated to a Specific Certificate GET {{gateway}}/certificates/:certificateId/services/:serviceNameOrId