Licenses Reference

    Endpoint

    /licenses/

    Response

    1. {
    2.   "data": [
    3.     {
    4.       "payload": "{\"license\":{\"payload\":{\"admin_seats\":\"1\",\"customer\":\"Example Company, Inc\",\"dataplanes\":\"1\",\"license_creation_date\":\"2017-07-20\",\"license_expiration_date\":\"2017-07-20\",\"license_key\":\"00141000017ODj3AAG_a1V41000004wT0OEAU\",\"product_subscription\":\"Konnect Enterprise\",\"support_plan\":\"None\"},\"signature\":\"6985968131533a967fcc721244a979948b1066967f1e9cd65dbd8eeabe060fc32d894a2945f5e4a03c1cd2198c74e058ac63d28b045c2f1fcec95877bd790e1b\",\"version\":\"1\"}}",
    5.       "created_at": 1500508800,
    6.       "id": "30b4edb7-0847-4f65-af90-efbed8b0161f",
    7.     },
    8.   ],
    9.   "next": null,
    10. }

    If there are no licenses stored by Kong Gateway, the data array will be empty.

    1. {
    2.   "data": [],
    3.   "next": null
    4. }

    Add License

    To create a license using an auto-generated UUID:

    Endpoint

    /licenses/

    Request Body

    When using POST, if the request payload does contain a valid Kong Gateway license, the license will be added.

    Response

    1. HTTP 201 Created

    Endpoint

    /licenses/{id}

    AttributesDescription
    idThe license’s unique ID.

    When using PUT, if the request payload does not contain an entity’s primary key (id for licenses), the license will be added and assigned the given ID.

    If the request payload does contain an entity’s primary key (id for Licenses), the license will be replaced with the given payload attribute. If the ID is not a valid UUID, a 400 BAD REQUEST will be returned. If the ID is omitted, a 405 NOT ALLOWED will be returned.

    Request Body

    Response

    1. HTTP 200 OK
    1. {
    2.   "created_at": 1500508800,
    3.   "payload": "{\"license\":{\"payload\":{\"admin_seats\":\"1\",\"customer\":\"Example Company, Inc\",\"dataplanes\":\"1\",\"license_creation_date\":\"2017-07-20\",\"license_expiration_date\":\"2017-07-20\",\"license_key\":\"00141000017ODj3AAG_a1V41000004wT0OEAU\",\"product_subscription\":\"Konnect Enterprise\",\"support_plan\":\"None\"},\"signature\":\"6985968131533a967fcc721244a979948b1066967f1e9cd65dbd8eeabe060fc32d894a2945f5e4a03c1cd2198c74e058ac63d28b045c2f1fcec95877bd790e1b\",\"version\":\"1\"}}",
    4.   "updated_at": 1500508800

    Update a License

    Endpoint

    /licenses/{id}

    AttributesDescription
    idThe license’s unique ID.

    If the request payload does not contain an entity’s primary key (id for licenses), a 404 NOT FOUND will be returned or if the request payload contains a invalid licence, a 400 BAD REQUEST will be returned.

    Request Body

    Response

    1. HTTP 200 OK

    Endpoint

    /licenses/{id}

    AttributesDescription
    idThe license’s unique ID.

    Response

    1. HTTP 200 OK
    1. {
    2.   "created_at": 1500508800,
    3.   "id": "30b4edb7-0847-4f65-af90-efbed8b0161f",
    4.   "payload": "{\"license\":{\"payload\":{\"admin_seats\":\"1\",\"customer\":\"Example Company, Inc\",\"dataplanes\":\"1\",\"license_creation_date\":\"2017-07-20\",\"license_expiration_date\":\"2017-07-21\",\"license_key\":\"00141000017ODj3AAG_a1V41000004wT0OEAU\",\"product_subscription\":\"Konnect Enterprise\",\"support_plan\":\"None\"},\"signature\":\"24cc21223633044c15c300be19cacc26ccc5aca0dd9a12df8a7324a1970fe304bc07b8dcd7fb08d7b92e04169313377ae3b550ead653b951bc44cd2eb59f6beb\",\"version\":\"1\"}}",
    5.   "updated_at": 1500508800
    6. }

    Delete a License

    Endpoint

    /licenses/{id}

    Response

    1. HTTP 204 No Content