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

# Get a Session plugin

`GET /plugins/{PluginId}#Session`

Get a Session plugin

## Response `200`

Session plugin

- SessionPlugin — 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.
  - `config` object, required — The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).
    - `absolute_timeout` number — The session cookie absolute timeout, in seconds. Specifies how long the session can be used until it is no longer valid.
    - `audience` string — The session audience, which is the intended target application. For example `"my-application"`.
    - `cookie_domain` string — The domain with which the cookie is intended to be exchanged.
    - `cookie_http_only` boolean — Applies the `HttpOnly` tag so that the cookie is sent only to a server.
    - `cookie_name` string — The name of the cookie.
    - `cookie_path` string — The resource in the host where the cookie is available.
    - `cookie_same_site` 'Strict' | 'Lax' | 'None' | 'Default' — Determines whether and how a cookie may be sent with cross-site requests.
    - `cookie_secure` boolean — Applies the Secure directive so that the cookie may be sent to the server only with an encrypted request over the HTTPS protocol.
    - `idling_timeout` number — The session cookie idle time, in seconds.
    - `logout_methods` string[] — A set of HTTP methods that the plugin will respond to.
    - `logout_post_arg` string — The POST argument passed to logout requests. Do not change this property.
    - `logout_query_arg` string — The query argument passed to logout requests.
    - `read_body_for_logout` boolean
    - `remember` boolean — Enables or disables persistent sessions.
    - `remember_absolute_timeout` number — The persistent session absolute timeout limit, in seconds.
    - `remember_cookie_name` string — Persistent session cookie name. Use with the `remember` configuration parameter.
    - `remember_rolling_timeout` number — The persistent session rolling timeout window, in seconds.
    - `request_headers` string[] — List of information to include, as headers, in the response to the downstream.
    - `response_headers` string[] — List of information to include, as headers, in the response to the downstream.
    - `rolling_timeout` number — The session cookie rolling timeout, in seconds. Specifies how long the session can be used until it needs to be renewed.
    - `secret` string — The secret that is used in keyed HMAC generation.
    - `stale_ttl` number — The duration, in seconds, after which an old cookie is discarded, starting from the moment when the session becomes outdated and is replaced by a new one.
    - `storage` 'cookie' | 'kong' — Determines where the session data is stored. `kong`: Stores encrypted session data into Kong's current database strategy; the cookie will not contain any session data. `cookie`: Stores encrypted session data within the cookie itself.
  - `consumer` object, nullable — 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, nullable
    - `id` string
  - `created_at` integer — Unix epoch when the resource was created.
  - `enabled` boolean, nullable — Whether the plugin is applied.
  - `id` string, nullable
  - `instance_name` string, nullable
  - `name` 'session', 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[]
  - `protocols` string[], nullable — 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"`.
  - `route` object, nullable — 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, nullable — 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
  - `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.

## Other responses

- `401` — Unauthorized
- `404` — Resource does not exist

## Changes

> 4 revisions in range; 1 not diffed.

- **2024-11-26** `99e71588eb61` — 1 breaking, 15 info
  - the `allOf[#/components/schemas/Plugin]/` response's property type changed from no type to `object` for status `200`
  - added the optional property `allOf[#/components/schemas/Plugin]/consumer` to the response with the `200` status
  - added the optional property `allOf[#/components/schemas/Plugin]/consumer_group` to the response with the `200` status
  - added the optional property `allOf[#/components/schemas/Plugin]/created_at` to the response with the `200` status
  - …12 more
- **2024-09-11** `5bd52189d290` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/kong/apis/kong-enterprise-admin-api/changes/plugins/:PluginId#Session/get.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/99e71588eb61/schema)