--- title: "Update a Acme plugin" method: PUT path: "/{workspace}/plugins/{PluginId}#Acme" tags: ["Plugins"] --- # Update a Acme plugin `PUT /{workspace}/plugins/{PluginId}#Acme` Update a Acme plugin ## Request body - AcmePlugin — A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields. - `condition` string, nullable — An expression used for conditional control over plugin execution. If the expression evaluates to `true` during the request flow, the plugin is executed; otherwise, it is skipped. - `created_at` integer, nullable — Unix epoch when the resource was created. - `enabled` boolean, nullable — Whether the plugin is applied. - `id` string, nullable — A string representing a UUID (universally unique identifier). - `instance_name` string, nullable — A unique string representing a UTF-8 encoded name. - `name` 'acme', required — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately. - `ordering` object, nullable - `after` object - `access` string[] - `before` object - `access` string[] - `partials` object[] — A list of partials to be used by the plugin. - `id` string — A string representing a UUID (universally unique identifier). - `name` string — A unique string representing a UTF-8 encoded name. - `path` string - `tags` string[], nullable — An optional set of strings associated with the Plugin for grouping and filtering. - `updated_at` integer, nullable — Unix epoch when the resource was last updated. - `config` object, required - `account_email` string, required — 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 name 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` 'ecc' | 'rsa' — 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` 'consul' | 'kong' | 'redis' | 'shm' | 'vault' — The backend storage type to use. In DB-less mode and Konnect, `kong` storage is unavailable. In hybrid mode and Konnect, `shm` storage is unavailable. `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. - `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 - `cloud_authentication` object — Cloud auth related configs for connecting to a Cloud Provider's Redis instance. - `auth_provider` 'aws' | 'azure' | 'gcp' — Auth providers to be used to authenticate to a Cloud Provider's Redis instance. - `aws_access_key_id` string — AWS Access Key ID to be used for authentication when `auth_provider` is set to `aws`. - `aws_assume_role_arn` string — The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens. - `aws_cache_name` string — The name of the AWS Elasticache cluster when `auth_provider` is set to `aws`. - `aws_is_serverless` boolean — This flag specifies whether the cluster is serverless when auth_provider is set to `aws`. - `aws_region` string — The region of the AWS ElastiCache cluster when `auth_provider` is set to `aws`. - `aws_role_session_name` string — The session name for the temporary credentials when assuming the IAM role. - `aws_secret_access_key` string — AWS Secret Access Key to be used for authentication when `auth_provider` is set to `aws`. - `azure_client_id` string — Azure Client ID to be used for authentication when `auth_provider` is set to `azure`. - `azure_client_secret` string — Azure Client Secret to be used for authentication when `auth_provider` is set to `azure`. - `azure_tenant_id` string — Azure Tenant ID to be used for authentication when `auth_provider` is set to `azure`. - `gcp_service_account_json` string — GCP Service Account JSON to be used for authentication when `auth_provider` is set to `gcp`. - `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` 'kubernetes' | 'token' — 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. - `protocols` string[] — A set of strings representing HTTP protocols. ## Response `200` Acme plugin - AcmePlugin — A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields. - `condition` string, nullable — An expression used for conditional control over plugin execution. If the expression evaluates to `true` during the request flow, the plugin is executed; otherwise, it is skipped. - `created_at` integer, nullable — Unix epoch when the resource was created. - `enabled` boolean, nullable — Whether the plugin is applied. - `id` string, nullable — A string representing a UUID (universally unique identifier). - `instance_name` string, nullable — A unique string representing a UTF-8 encoded name. - `name` 'acme', required — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately. - `ordering` object, nullable - `after` object - `access` string[] - `before` object - `access` string[] - `partials` object[] — A list of partials to be used by the plugin. - `id` string — A string representing a UUID (universally unique identifier). - `name` string — A unique string representing a UTF-8 encoded name. - `path` string - `tags` string[], nullable — An optional set of strings associated with the Plugin for grouping and filtering. - `updated_at` integer, nullable — Unix epoch when the resource was last updated. - `config` object, required - `account_email` string, required — 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 name 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` 'ecc' | 'rsa' — 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` 'consul' | 'kong' | 'redis' | 'shm' | 'vault' — The backend storage type to use. In DB-less mode and Konnect, `kong` storage is unavailable. In hybrid mode and Konnect, `shm` storage is unavailable. `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. - `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 - `cloud_authentication` object — Cloud auth related configs for connecting to a Cloud Provider's Redis instance. - `auth_provider` 'aws' | 'azure' | 'gcp' — Auth providers to be used to authenticate to a Cloud Provider's Redis instance. - `aws_access_key_id` string — AWS Access Key ID to be used for authentication when `auth_provider` is set to `aws`. - `aws_assume_role_arn` string — The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens. - `aws_cache_name` string — The name of the AWS Elasticache cluster when `auth_provider` is set to `aws`. - `aws_is_serverless` boolean — This flag specifies whether the cluster is serverless when auth_provider is set to `aws`. - `aws_region` string — The region of the AWS ElastiCache cluster when `auth_provider` is set to `aws`. - `aws_role_session_name` string — The session name for the temporary credentials when assuming the IAM role. - `aws_secret_access_key` string — AWS Secret Access Key to be used for authentication when `auth_provider` is set to `aws`. - `azure_client_id` string — Azure Client ID to be used for authentication when `auth_provider` is set to `azure`. - `azure_client_secret` string — Azure Client Secret to be used for authentication when `auth_provider` is set to `azure`. - `azure_tenant_id` string — Azure Tenant ID to be used for authentication when `auth_provider` is set to `azure`. - `gcp_service_account_json` string — GCP Service Account JSON to be used for authentication when `auth_provider` is set to `gcp`. - `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` 'kubernetes' | 'token' — 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. - `protocols` string[] — A set of strings representing HTTP protocols. ## Other responses - `401` — Unauthorized --- [API](https://skmtc.net/kong/apis/kong-enterprise-admin-api.md) · [All operations](https://skmtc.net/kong/apis/kong-enterprise-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/kong-enterprise-admin-api/revisions/28b1f8a59cdc/schema)