--- title: "Create a Mocking plugin" method: POST path: "/plugins#Mocking" tags: ["Plugins"] --- # Create a Mocking plugin `POST /plugins#Mocking` Create a Mocking plugin ## Request body - CreateMockingPlugin - `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/). - `api_specification` string — The contents of the specification file. You must use this option for hybrid or DB-less mode. You can include the full specification as part of the configuration. In Kong Manager, you can copy and paste the contents of the spec directly into the `Config.Api Specification` text field. - `api_specification_filename` string — The path and name of the specification file loaded into Kong Gateway's database. You cannot use this option for DB-less or hybrid mode. - `custom_base_path` string — The base path to be used for path match evaluation. This value is ignored if `include_base_path` is set to `false`. - `include_base_path` boolean — Indicates whether to include the base path when performing path match evaluation. - `included_status_codes` integer[] — A global list of the HTTP status codes that can only be selected and returned. - `max_delay_time` number — The maximum value in seconds of delay time. Set this value when `random_delay` is enabled and you want to adjust the default. The value must be greater than the `min_delay_time`. - `min_delay_time` number — The minimum value in seconds of delay time. Set this value when `random_delay` is enabled and you want to adjust the default. The value must be less than the `max_delay_time`. - `random_delay` boolean — Enables a random delay in the mocked response. Introduces delays to simulate real-time response times by APIs. - `random_examples` boolean — Randomly selects one example and returns it. This parameter requires the spec to have multiple examples configured. - `random_status_code` boolean — Determines whether to randomly select an HTTP status code from the responses of the corresponding API method. The default value is `false`, which means the minimum HTTP status code is always selected and returned. - `created_at` integer — Unix epoch when the resource was created. - `enabled` boolean — Whether the plugin is applied. - `id` string - `instance_name` string - `name` 'mocking' — 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 Mocking plugin - MockingPlugin - `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/). - `api_specification` string — The contents of the specification file. You must use this option for hybrid or DB-less mode. You can include the full specification as part of the configuration. In Kong Manager, you can copy and paste the contents of the spec directly into the `Config.Api Specification` text field. - `api_specification_filename` string — The path and name of the specification file loaded into Kong Gateway's database. You cannot use this option for DB-less or hybrid mode. - `custom_base_path` string — The base path to be used for path match evaluation. This value is ignored if `include_base_path` is set to `false`. - `include_base_path` boolean — Indicates whether to include the base path when performing path match evaluation. - `included_status_codes` integer[] — A global list of the HTTP status codes that can only be selected and returned. - `max_delay_time` number — The maximum value in seconds of delay time. Set this value when `random_delay` is enabled and you want to adjust the default. The value must be greater than the `min_delay_time`. - `min_delay_time` number — The minimum value in seconds of delay time. Set this value when `random_delay` is enabled and you want to adjust the default. The value must be less than the `max_delay_time`. - `random_delay` boolean — Enables a random delay in the mocked response. Introduces delays to simulate real-time response times by APIs. - `random_examples` boolean — Randomly selects one example and returns it. This parameter requires the spec to have multiple examples configured. - `random_status_code` boolean — Determines whether to randomly select an HTTP status code from the responses of the corresponding API method. The default value is `false`, which means the minimum HTTP status code is always selected and returned. - `created_at` integer — Unix epoch when the resource was created. - `enabled` boolean — Whether the plugin is applied. - `id` string - `instance_name` string - `name` 'mocking' — 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#Mocking/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)