ACME Plugin API

v1.0.0OAS 3.0

API for managing ACME certificates in Kong.

API Base URL
  • Server 1:{protocol}://{hostname}:{port}{path}

    Default Admin API URL

Security
personalAccessToken (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Apply or Renew Certificate

Applies or renews the certificate and returns the result.

post
{protocol}://{hostname}:{port}{path}/acme

Body

application/json
hoststringrequired

The domain where the certificate should be created.

Example:example.com

test_http_challenge_flowboolean

Only checks if the configuration is valid without applying the certificate.

Response

Certificate successfully applied.

 

Update Certificate

Apply or renew a certificate in the background.

patch
{protocol}://{hostname}:{port}{path}/acme

Body

application/json
hoststringrequired

The domain where the certificate should be created.

Example:example.com

test_http_challenge_flowboolean

Only checks if the configuration is valid without applying the certificate.

Response

202

Renewal process started successfully.

 
202

Did this doc help?

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!