---
title: "Create a Acme plugin"
method: POST
path: "/plugins#Acme"
tags: ["Plugins"]
---

# Create a Acme plugin

`POST /plugins#Acme`

Create a Acme plugin

## Request body

- CreateAcmePlugin
  - `config` object — The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).
    - `account_email` string — The account identifier. Can be reused in a different plugin instance.
    - `account_key` object — The private key associated with the account.
      - `key_id` string, required — The Key ID.
      - `key_set` string — The ID of the key set to associate the Key ID with.
    - `allow_any_domain` boolean — If set to `true`, the plugin allows all domains and ignores any values in the `domains` list.
    - `api_uri` string — A string representing a URL, such as https://example.com/path/to/resource?q=search.
    - `cert_type` 'rsa' | 'ecc' — The certificate type to create. The possible values are `'rsa'` for RSA certificate or `'ecc'` for EC certificate.
    - `domains` string[] — An array of strings representing hosts. A valid host is a string containing one or more labels separated by periods, with at most one wildcard label ('*')
    - `eab_hmac_key` string — External account binding (EAB) base64-encoded URL string of the HMAC key. You usually don't need to set this unless it is explicitly required by the CA.
    - `eab_kid` string — External account binding (EAB) key id. You usually don't need to set this unless it is explicitly required by the CA.
    - `enable_ipv4_common_name` boolean — A boolean value that controls whether to include the IPv4 address in the common name field of generated certificates.
    - `fail_backoff_minutes` number — Minutes to wait for each domain that fails to create a certificate. This applies to both a new certificate and a renewal certificate.
    - `preferred_chain` string — A string value that specifies the preferred certificate chain to use when generating certificates.
    - `renew_threshold_days` number — Days remaining to renew the certificate before it expires.
    - `rsa_key_size` 2048 | 3072 | 4096 — RSA private key size for the certificate. The possible values are 2048, 3072, or 4096.
    - `storage` 'kong' | 'shm' | 'redis' | 'consul' | 'vault' — The backend storage type to use. The possible values are `'kong'`, `'shm'`, `'redis'`, `'consul'`, or `'vault'`. In DB-less mode, `'kong'` storage is unavailable. Note that `'shm'` storage does not persist during Kong restarts and does not work for Kong running on different machines, so consider using one of `'kong'`, `'redis'`, `'consul'`, or `'vault'` in production. Please refer to the Hybrid Mode sections below as well.
    - `storage_config` object
      - `consul` object
        - `host` string — A string representing a host name, such as example.com.
        - `https` boolean — Boolean representation of https.
        - `kv_path` string — KV prefix path.
        - `port` integer — An integer representing a port number between 0 and 65535, inclusive.
        - `timeout` number — Timeout in milliseconds.
        - `token` string — Consul ACL token.
      - `kong` object
      - `redis` object
        - `database` integer — Database to use for the Redis connection when using the `redis` strategy
        - `extra_options` object — Custom ACME Redis options
          - `namespace` string — A namespace to prepend to all keys stored in Redis.
          - `scan_count` number — The number of keys to return in Redis SCAN calls.
        - `host` string — A string representing a host name, such as example.com.
        - `password` string — Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
        - `port` integer — An integer representing a port number between 0 and 65535, inclusive.
        - `server_name` string — A string representing an SNI (server name indication) value for TLS.
        - `ssl` boolean — If set to true, uses SSL to connect to Redis.
        - `ssl_verify` boolean — If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.
        - `timeout` integer — An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
        - `username` string — Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.
      - `shm` object
        - `shm_name` string — Name of shared memory zone used for Kong API gateway storage
      - `vault` object
        - `auth_method` 'token' | 'kubernetes' — Auth Method, default to token, can be 'token' or 'kubernetes'.
        - `auth_path` string — Vault's authentication path to use.
        - `auth_role` string — The role to try and assign.
        - `host` string — A string representing a host name, such as example.com.
        - `https` boolean — Boolean representation of https.
        - `jwt_path` string — The path to the JWT.
        - `kv_path` string — KV prefix path.
        - `port` integer — An integer representing a port number between 0 and 65535, inclusive.
        - `timeout` number — Timeout in milliseconds.
        - `tls_server_name` string — SNI used in request, default to host if omitted.
        - `tls_verify` boolean — Turn on TLS verification.
        - `token` string — Consul ACL token.
    - `tos_accepted` boolean — If you are using Let's Encrypt, you must set this to `true` to agree the terms of service.
  - `created_at` integer — Unix epoch when the resource was created.
  - `enabled` boolean — Whether the plugin is applied.
  - `id` string
  - `instance_name` string
  - `name` 'acme' — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
  - `ordering` object
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `protocols` string[] — A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support `"tcp"` and `"tls"`.
  - `tags` string[] — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer — Unix epoch when the resource was last updated.
  - `consumer` object — If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    - `id` string
  - `consumer_group` object
    - `id` string
  - `route` object — If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the Route being used.
    - `id` string
  - `service` object — If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    - `id` string

## Response `201`

Created Acme plugin

- AcmePlugin
  - `config` object — The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).
    - `account_email` string — The account identifier. Can be reused in a different plugin instance.
    - `account_key` object — The private key associated with the account.
      - `key_id` string, required — The Key ID.
      - `key_set` string — The ID of the key set to associate the Key ID with.
    - `allow_any_domain` boolean — If set to `true`, the plugin allows all domains and ignores any values in the `domains` list.
    - `api_uri` string — A string representing a URL, such as https://example.com/path/to/resource?q=search.
    - `cert_type` 'rsa' | 'ecc' — The certificate type to create. The possible values are `'rsa'` for RSA certificate or `'ecc'` for EC certificate.
    - `domains` string[] — An array of strings representing hosts. A valid host is a string containing one or more labels separated by periods, with at most one wildcard label ('*')
    - `eab_hmac_key` string — External account binding (EAB) base64-encoded URL string of the HMAC key. You usually don't need to set this unless it is explicitly required by the CA.
    - `eab_kid` string — External account binding (EAB) key id. You usually don't need to set this unless it is explicitly required by the CA.
    - `enable_ipv4_common_name` boolean — A boolean value that controls whether to include the IPv4 address in the common name field of generated certificates.
    - `fail_backoff_minutes` number — Minutes to wait for each domain that fails to create a certificate. This applies to both a new certificate and a renewal certificate.
    - `preferred_chain` string — A string value that specifies the preferred certificate chain to use when generating certificates.
    - `renew_threshold_days` number — Days remaining to renew the certificate before it expires.
    - `rsa_key_size` 2048 | 3072 | 4096 — RSA private key size for the certificate. The possible values are 2048, 3072, or 4096.
    - `storage` 'kong' | 'shm' | 'redis' | 'consul' | 'vault' — The backend storage type to use. The possible values are `'kong'`, `'shm'`, `'redis'`, `'consul'`, or `'vault'`. In DB-less mode, `'kong'` storage is unavailable. Note that `'shm'` storage does not persist during Kong restarts and does not work for Kong running on different machines, so consider using one of `'kong'`, `'redis'`, `'consul'`, or `'vault'` in production. Please refer to the Hybrid Mode sections below as well.
    - `storage_config` object
      - `consul` object
        - `host` string — A string representing a host name, such as example.com.
        - `https` boolean — Boolean representation of https.
        - `kv_path` string — KV prefix path.
        - `port` integer — An integer representing a port number between 0 and 65535, inclusive.
        - `timeout` number — Timeout in milliseconds.
        - `token` string — Consul ACL token.
      - `kong` object
      - `redis` object
        - `database` integer — Database to use for the Redis connection when using the `redis` strategy
        - `extra_options` object — Custom ACME Redis options
          - `namespace` string — A namespace to prepend to all keys stored in Redis.
          - `scan_count` number — The number of keys to return in Redis SCAN calls.
        - `host` string — A string representing a host name, such as example.com.
        - `password` string — Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
        - `port` integer — An integer representing a port number between 0 and 65535, inclusive.
        - `server_name` string — A string representing an SNI (server name indication) value for TLS.
        - `ssl` boolean — If set to true, uses SSL to connect to Redis.
        - `ssl_verify` boolean — If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.
        - `timeout` integer — An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
        - `username` string — Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.
      - `shm` object
        - `shm_name` string — Name of shared memory zone used for Kong API gateway storage
      - `vault` object
        - `auth_method` 'token' | 'kubernetes' — Auth Method, default to token, can be 'token' or 'kubernetes'.
        - `auth_path` string — Vault's authentication path to use.
        - `auth_role` string — The role to try and assign.
        - `host` string — A string representing a host name, such as example.com.
        - `https` boolean — Boolean representation of https.
        - `jwt_path` string — The path to the JWT.
        - `kv_path` string — KV prefix path.
        - `port` integer — An integer representing a port number between 0 and 65535, inclusive.
        - `timeout` number — Timeout in milliseconds.
        - `tls_server_name` string — SNI used in request, default to host if omitted.
        - `tls_verify` boolean — Turn on TLS verification.
        - `token` string — Consul ACL token.
    - `tos_accepted` boolean — If you are using Let's Encrypt, you must set this to `true` to agree the terms of service.
  - `created_at` integer — Unix epoch when the resource was created.
  - `enabled` boolean — Whether the plugin is applied.
  - `id` string
  - `instance_name` string
  - `name` 'acme' — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
  - `ordering` object
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `protocols` string[] — A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support `"tcp"` and `"tls"`.
  - `tags` string[] — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer — Unix epoch when the resource was last updated.
  - `consumer` object — If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    - `id` string
  - `consumer_group` object
    - `id` string
  - `route` object — If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the Route being used.
    - `id` string
  - `service` object — If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    - `id` string

## Other responses

- `401` — Unauthorized

## Changes

> 3 revisions in range; 1 not diffed.

- **2024-09-11** `5bd52189d290` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/kong/apis/kong-enterprise-admin-api/changes/plugins#Acme/post.md)

---

[API](https://skmtc.dev/kong/apis/kong-enterprise-admin-api.md) · [All operations](https://skmtc.dev/kong/apis/kong-enterprise-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kong/kong-enterprise-admin-api/revisions/5bd52189d290/schema)