--- title: "get shared_rules object" method: GET path: "/shared_rules/{sharedRulesKey}" tags: ["Shared Rules"] --- # get shared_rules object `GET /shared_rules/{sharedRulesKey}` Get details for an existing shared_rules object ## Path parameters - `sharedRulesKey` string, required ## Response `200` a result containing a single shared_rules object - SharedRulesResult - `result` SharedRules - `shared_rules_key` string - `zone_key` string, required - `default` AllConstraints - `light` ClusterConstraint[], required - `constraint_key` string - `cluster_key` string - `metadata` Metadatum[] - `key` string - `value` string - `properties` Metadatum[] - `key` string - `value` string - `response_data` ResponseData - `headers` HeaderDatum[] - `name` string — The name of the header that will be attached to the response sent. This is case insensitive. - `value` string — A literal value to send as the header value or a reference to some metadatum value set on the Cluster Intsance that handles a specific request. If this value is empty after looking up an Instance metadatum value no header will be sent. - `value_is_literal` boolean — If true then the value attribute is treated as a literal and no attempt to resolve instance metadatum to find a value. - `always_send` boolean — If false or not set then this header will only be sent on HTTP response codes of 2xx and 3xx. If true then data will be returned for 4xx and 5xx responses as well. - `cookies` CookieDatum[] - `name` string — The name of the cookie that will be attached to the response sent. - `value` string — A literal value to send as the cookie value or a reference to some metadatum value set on the Cluster Intsance that handles a specific request. - `value_is_literal` boolean — If true then the value attribute is treated as a literal and no attempt to resolve to a server metadatum. - `always_send` boolean — If false or not set then this cookie will only be sent on HTTP response codes of 2xx and 3xx. If true then data will be returned for 4xx and 5xx responses as well. - `expires_in_sec` integer — This indicates how long a cookie will be valid, in seconds. If not set the default is to provide no expiration information. If set to 0 the cookie will have an 'Expires' attribute set to 'Mon, 1 Jan 0001 12:00:00 UTC'. For values greater than 0 the cookie's 'Max-Age' attribute will be set to that value. - `domain` string — Specifies the hosts to hich a cookie will be sent. Maps directly to a cookie's 'Domain' attribute. - `path` string — Specifies the path a cookie will be associated with. Maps directly to the 'Path' attribute. - `secure` boolean — If set the cookie will only be sent on subsequent requests when accessing a server via HTTPS. Maps directly to 'Secure' attribute. - `http_only` boolean — If set the cookie value will not be accessible via Document.cookie. Maps directly to 'HttpOnly' attribute. - `same_site` 'Strict' | 'Lax' — Allows assertions how a cookie should behave wend making cross-site requests. Maps directly to 'SameSite' attribute. If unset no guidance will be included in the cookie. - `weight` integer - `dark` ClusterConstraint[] - `constraint_key` string - `cluster_key` string - `metadata` Metadatum[] - `key` string - `value` string - `properties` Metadatum[] - `key` string - `value` string - `response_data` ResponseData - `headers` HeaderDatum[] - `name` string — The name of the header that will be attached to the response sent. This is case insensitive. - `value` string — A literal value to send as the header value or a reference to some metadatum value set on the Cluster Intsance that handles a specific request. If this value is empty after looking up an Instance metadatum value no header will be sent. - `value_is_literal` boolean — If true then the value attribute is treated as a literal and no attempt to resolve instance metadatum to find a value. - `always_send` boolean — If false or not set then this header will only be sent on HTTP response codes of 2xx and 3xx. If true then data will be returned for 4xx and 5xx responses as well. - `cookies` CookieDatum[] - `name` string — The name of the cookie that will be attached to the response sent. - `value` string — A literal value to send as the cookie value or a reference to some metadatum value set on the Cluster Intsance that handles a specific request. - `value_is_literal` boolean — If true then the value attribute is treated as a literal and no attempt to resolve to a server metadatum. - `always_send` boolean — If false or not set then this cookie will only be sent on HTTP response codes of 2xx and 3xx. If true then data will be returned for 4xx and 5xx responses as well. - `expires_in_sec` integer — This indicates how long a cookie will be valid, in seconds. If not set the default is to provide no expiration information. If set to 0 the cookie will have an 'Expires' attribute set to 'Mon, 1 Jan 0001 12:00:00 UTC'. For values greater than 0 the cookie's 'Max-Age' attribute will be set to that value. - `domain` string — Specifies the hosts to hich a cookie will be sent. Maps directly to a cookie's 'Domain' attribute. - `path` string — Specifies the path a cookie will be associated with. Maps directly to the 'Path' attribute. - `secure` boolean — If set the cookie will only be sent on subsequent requests when accessing a server via HTTPS. Maps directly to 'Secure' attribute. - `http_only` boolean — If set the cookie value will not be accessible via Document.cookie. Maps directly to 'HttpOnly' attribute. - `same_site` 'Strict' | 'Lax' — Allows assertions how a cookie should behave wend making cross-site requests. Maps directly to 'SameSite' attribute. If unset no guidance will be included in the cookie. - `weight` integer - `tap` ClusterConstraint[] - `constraint_key` string - `cluster_key` string - `metadata` Metadatum[] - `key` string - `value` string - `properties` Metadatum[] - `key` string - `value` string - `response_data` ResponseData - `headers` HeaderDatum[] - `name` string — The name of the header that will be attached to the response sent. This is case insensitive. - `value` string — A literal value to send as the header value or a reference to some metadatum value set on the Cluster Intsance that handles a specific request. If this value is empty after looking up an Instance metadatum value no header will be sent. - `value_is_literal` boolean — If true then the value attribute is treated as a literal and no attempt to resolve instance metadatum to find a value. - `always_send` boolean — If false or not set then this header will only be sent on HTTP response codes of 2xx and 3xx. If true then data will be returned for 4xx and 5xx responses as well. - `cookies` CookieDatum[] - `name` string — The name of the cookie that will be attached to the response sent. - `value` string — A literal value to send as the cookie value or a reference to some metadatum value set on the Cluster Intsance that handles a specific request. - `value_is_literal` boolean — If true then the value attribute is treated as a literal and no attempt to resolve to a server metadatum. - `always_send` boolean — If false or not set then this cookie will only be sent on HTTP response codes of 2xx and 3xx. If true then data will be returned for 4xx and 5xx responses as well. - `expires_in_sec` integer — This indicates how long a cookie will be valid, in seconds. If not set the default is to provide no expiration information. If set to 0 the cookie will have an 'Expires' attribute set to 'Mon, 1 Jan 0001 12:00:00 UTC'. For values greater than 0 the cookie's 'Max-Age' attribute will be set to that value. - `domain` string — Specifies the hosts to hich a cookie will be sent. Maps directly to a cookie's 'Domain' attribute. - `path` string — Specifies the path a cookie will be associated with. Maps directly to the 'Path' attribute. - `secure` boolean — If set the cookie will only be sent on subsequent requests when accessing a server via HTTPS. Maps directly to 'Secure' attribute. - `http_only` boolean — If set the cookie value will not be accessible via Document.cookie. Maps directly to 'HttpOnly' attribute. - `same_site` 'Strict' | 'Lax' — Allows assertions how a cookie should behave wend making cross-site requests. Maps directly to 'SameSite' attribute. If unset no guidance will be included in the cookie. - `weight` integer - `rules` Rule[] - `rule_key` string - `methods` string[] - `matches` Match[] - `kind` string - `from` Metadatum - `key` string - `value` string - `to` Metadatum - `key` string - `value` string - `constraints` AllConstraints - `light` ClusterConstraint[], required - `constraint_key` string - `cluster_key` string - `metadata` Metadatum[] - `key` string - `value` string - `properties` Metadatum[] - `key` string - `value` string - `response_data` ResponseData - `headers` HeaderDatum[] - … - `cookies` CookieDatum[] - … - `weight` integer - `dark` ClusterConstraint[] - `constraint_key` string - `cluster_key` string - `metadata` Metadatum[] - `key` string - `value` string - `properties` Metadatum[] - `key` string - `value` string - `response_data` ResponseData - `headers` HeaderDatum[] - … - `cookies` CookieDatum[] - … - `weight` integer - `tap` ClusterConstraint[] - `constraint_key` string - `cluster_key` string - `metadata` Metadatum[] - `key` string - `value` string - `properties` Metadatum[] - `key` string - `value` string - `response_data` ResponseData - `headers` HeaderDatum[] - … - `cookies` CookieDatum[] - … - `weight` integer - `response_data` ResponseData - `headers` HeaderDatum[] - `name` string — The name of the header that will be attached to the response sent. This is case insensitive. - `value` string — A literal value to send as the header value or a reference to some metadatum value set on the Cluster Intsance that handles a specific request. If this value is empty after looking up an Instance metadatum value no header will be sent. - `value_is_literal` boolean — If true then the value attribute is treated as a literal and no attempt to resolve instance metadatum to find a value. - `always_send` boolean — If false or not set then this header will only be sent on HTTP response codes of 2xx and 3xx. If true then data will be returned for 4xx and 5xx responses as well. - `cookies` CookieDatum[] - `name` string — The name of the cookie that will be attached to the response sent. - `value` string — A literal value to send as the cookie value or a reference to some metadatum value set on the Cluster Intsance that handles a specific request. - `value_is_literal` boolean — If true then the value attribute is treated as a literal and no attempt to resolve to a server metadatum. - `always_send` boolean — If false or not set then this cookie will only be sent on HTTP response codes of 2xx and 3xx. If true then data will be returned for 4xx and 5xx responses as well. - `expires_in_sec` integer — This indicates how long a cookie will be valid, in seconds. If not set the default is to provide no expiration information. If set to 0 the cookie will have an 'Expires' attribute set to 'Mon, 1 Jan 0001 12:00:00 UTC'. For values greater than 0 the cookie's 'Max-Age' attribute will be set to that value. - `domain` string — Specifies the hosts to hich a cookie will be sent. Maps directly to a cookie's 'Domain' attribute. - `path` string — Specifies the path a cookie will be associated with. Maps directly to the 'Path' attribute. - `secure` boolean — If set the cookie will only be sent on subsequent requests when accessing a server via HTTPS. Maps directly to 'Secure' attribute. - `http_only` boolean — If set the cookie value will not be accessible via Document.cookie. Maps directly to 'HttpOnly' attribute. - `same_site` 'Strict' | 'Lax' — Allows assertions how a cookie should behave wend making cross-site requests. Maps directly to 'SameSite' attribute. If unset no guidance will be included in the cookie. - `checksum` string, required ## Other responses - `default` — Unexpected error --- [API](https://skmtc.dev/turbinelabs/apis/turbine-labs-api.md) · [All operations](https://skmtc.dev/turbinelabs/apis/turbine-labs-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/turbinelabs/turbine-labs-api/revisions/66c0c19fb676/schema)