---
title: "Get a Opa plugin"
method: GET
path: "/{workspace}/plugins/{PluginId}#Opa"
tags: ["Plugins"]
---

# Get a Opa plugin

`GET /{workspace}/plugins/{PluginId}#Opa`

Get a Opa plugin

## Response `200`

Opa plugin

- OpaPlugin — 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` 'opa', 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
    - `include_body_in_opa_input` boolean
    - `include_consumer_in_opa_input` boolean — If set to true, the Kong Gateway Consumer object in use for the current request (if any) is included as input to OPA.
    - `include_parsed_json_body_in_opa_input` boolean — If set to true and the `Content-Type` header of the current request is `application/json`, the request body will be JSON decoded and the decoded struct is included as input to OPA.
    - `include_route_in_opa_input` boolean — If set to true, the Kong Gateway Route object in use for the current request is included as input to OPA.
    - `include_service_in_opa_input` boolean — If set to true, the Kong Gateway Service object in use for the current request is included as input to OPA.
    - `include_uri_captures_in_opa_input` boolean — If set to true, the regex capture groups captured on the Kong Gateway Route's path field in the current request (if any) are included as input to OPA.
    - `opa_host` string — A string representing a host name, such as example.com.
    - `opa_path` string, required — A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
    - `opa_port` integer — An integer representing a port number between 0 and 65535, inclusive.
    - `opa_protocol` 'http' | 'https' — The protocol to use when talking to Open Policy Agent (OPA) server. Allowed protocols are `http` and `https`.
    - `ssl_verify` boolean — If set to true, the OPA certificate will be verified according to the CA certificates specified in lua_ssl_trusted_certificate.
  - `protocols` string[] — A set of strings representing HTTP protocols.
  - `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
- `404` — Resource does not exist

---

[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)