[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new service",["17"],"d60b0c7aa1fb3","post","/services",["18"],{},"create-service","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Services",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],[],["48"],{"id":"49","url":"50","name":"51","description":"52","variables":"53"},"a17c4a94d4d31","7a4d62fc164c1","200",[],["54"],"Successfully created Service","e4ed626aa7aef","400",[],["55"],"Invalid Service","e4dd626aa78a0","401",[],["56"],"Unauthorized","88362acaf4ba6",["57"],"The request body for creating a new service entity.",{"id":"58","key":"59","extensions":"60","description":"61","type":"62","name":"63","in":"64"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"65","path":"66","port":"67","protocol":"68"},{"id":"69","mediaType":"70","examples":"71","encodings":"72","schema":"73"},{"id":"74","mediaType":"70","examples":"75","encodings":"76","schema":"77"},{"id":"78","mediaType":"70","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"70","examples":"83","encodings":"84","schema":"85"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"86","description":"87"},{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93","enum":"94"},"e7d425d2c32bb","application/json",["95"],[],{"description":"96","properties":"97","type":"98","title":"99","examples":"100"},"7291057354cae",[],[],{"type":"98","$schema":"101","x-stoplight":"102"},"e04532aa16e4b",["103","104","105"],[],{"type":"98","properties":"106","required":"107","title":"108","$schema":"101","x-stoplight":"109"},"05a3bc878852b",["110"],[],{"type":"98","x-examples":"111","properties":"112","required":"113","$schema":"101","x-stoplight":"114"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["92","115"],{"id":"116","value":"117","key":"118"},"Service entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its `protocol`, `host`, `port` and `path` individually. Services are associated to routes (a Service can have many routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.",{"ca_certificates":"119","client_certificate":"120","connect_timeout":"121","created_at":"122","enabled":"123","host":"124","id":"125","name":"126","path":"127","port":"128","protocol":"129","read_timeout":"130","retries":"131","tags":"132","tls_verify":"133","tls_verify_depth":"134","updated_at":"135","url":"136","write_timeout":"137"},"object","Service",["117"],"http://json-schema.org/draft-07/schema#",{"id":"138"},{"id":"139","key":"140","value":"141","summary":"142"},{"id":"143","key":"144","value":"145","summary":"146"},{"id":"147","key":"148","value":"149","summary":"150"},{"status":"151","message":"152"},["153","154"],"UnauthorizedError",{"id":"155"},{"id":"156","key":"157","value":"158"},{"Example 1":"159"},{"name":"160","retries":"161","protocol":"162","host":"163","port":"164","path":"165","connect_timeout":"166","write_timeout":"167","read_timeout":"168","tags":"169","client_certificate":"170","tls_verify":"171","tls_verify_depth":"172","ca_certificates":"173","enabled":"174"},["175","176","177","178"],{"id":"179"},"https","4ffff7ca616a3",{"host":"180","id":"181","name":"182","path":"88","port":80,"protocol":"92"},"default",{"description":"183","items":"184","type":"185"},{"additionalProperties":false,"description":"186","properties":"187","type":"98"},{"default":60000,"description":"188","type":"189"},{"description":"190","type":"189"},{"default":true,"description":"191","type":"192"},{"description":"193","type":"194"},{"type":"194"},{"description":"195","type":"194"},{"description":"196","type":"194"},{"default":80,"description":"197","type":"189"},{"default":"92","description":"198","type":"194"},{"default":60000,"description":"199","type":"189"},{"default":5,"description":"200","type":"189"},{"description":"201","items":"202","type":"185"},{"description":"203","type":"192"},{"description":"204","type":"189"},{"description":"205","type":"189"},{"description":"206","type":"194"},{"default":60000,"description":"207","type":"189"},"f3f35847c319f","f8852e9850d94","DuplicateApiKey",{"message":"142","status":401},"Duplicate API key found","72e6a8ff61a15","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","91a1c22be6b01","NoAPIKey",{"message":"208","status":401},"No API key found",{"type":"189"},{"type":"194"},"status","message","470b68e5f0549","6c9fa7efa9fca","Example",{"name":"209","retries":5,"protocol":"92","host":"210","port":80,"path":"211","connect_timeout":6000,"write_timeout":6000,"read_timeout":6000,"tags":"212","client_certificate":"213","tls_verify":true,"tls_verify_depth":null,"ca_certificates":"214","enabled":true},{"id":"215","created_at":1422386534,"updated_at":1422386534,"name":"209","retries":5,"protocol":"92","host":"210","port":80,"path":"211","connect_timeout":60000,"write_timeout":60000,"read_timeout":60000,"tags":"216","client_certificate":"217","tls_verify":true,"tls_verify_depth":null,"ca_certificates":"218","enabled":true},{"type":"194","description":"219","examples":"220"},{"type":"189","description":"221","default":5,"examples":"222"},{"type":"194","description":"223","default":"92","enum":"224","examples":"225"},{"type":"194","description":"226","examples":"227"},{"type":"189","description":"228","default":80,"examples":"229"},{"type":"194","description":"230","examples":"231"},{"type":"189","description":"232","default":6000,"examples":"233"},{"type":"189","description":"234","default":6000,"examples":"235"},{"type":"189","description":"236","default":6000,"examples":"237"},{"type":"185","description":"238","items":"239"},{"type":"98","description":"240","properties":"241"},{"type":"192","description":"242","default":true},{"type":"243","description":"244","default":null,"examples":"245"},{"type":"185","description":"246","items":"247"},{"type":"192","default":true,"description":"248"},"protocol","host","port","enabled","793ad71c2cc6c","example.internal","49fd316e-c457-481c-9fc7-8079153e4f3c","example-service","Array of `CA Certificate` object UUIDs that are used to build the trust store while verifying upstream servers TLS certificate. If set to `null` when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).",{"type":"194"},"array","Certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"249"},"The timeout in milliseconds for establishing a connection to the upstream server.","integer","Unix epoch when the resource was created.","Whether the Service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404).","boolean","The host of the upstream server. Note that the host value is case sensitive.","string","The Service name.","The path to be used in requests to the upstream server.","The upstream server port.","The protocol used to communicate with the upstream.","The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.","The number of retries to execute upon failure to proxy.","An optional set of strings associated with the Service for grouping and filtering.",{"type":"194"},"Whether to enable verification of upstream server TLS certificate. If set to `null`, then the Nginx default is respected.","Maximum depth of chain while verifying Upstream server's TLS certificate. If set to `null`, then the Nginx default is respected.","Unix epoch when the resource was last updated.","Helper field to set `protocol`, `host`, `port` and `path` using a URL. This field is write-only and is not returned in responses.","The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.","No API key found in request","my-service","example.com","/some_api",["250"],{"id":"251"},["251"],"9748f662-7711-4a90-8186-dc02f10eb0f5",["250","252"],{"id":"251"},["251","253"],"The service name.\n",["209"],"The number of retries to execute upon failure to proxy. Default:`5`.\n",[5],"The protocol used to communicate with the upstream. Accepted values are: \"`grpc`\", \"`grpcs`\", \"`http`\", \"`https`\", \"`tcp`\", \"`tls`\", \"`tls_passthrough`\", \"`udp`\", \"`ws`\"\n, \"`wss`\"\n. Default: \"`http`\".",["254","255","92","115","256","257","258","259","260","261"],["92"],"The host of the upstream server. Note that the host value is case sensitive.\n",["210"],"The upstream server port. Default: `80`.\n",[80],"The path to be used in requests to the upstream server.\n",["211"],"The timeout in milliseconds for establishing a connection to the upstream server. Default `60000`.",[6000],"The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. Default: `60000`.\n",[6000],"The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server. Default: `60000`.\n",[6000],"An optional set of strings associated with the service for grouping and filtering.\n",{"type":"194","examples":"262"},"Certificate to be used as client certificate while TLS handshaking to the upstream server. With form-encoded, the notation is `client_certificate.id=<client_certificate id>`. With JSON, use `\"client_certificate\":{\"id\":\"<client_certificate id>\"}`.",{"id":"263"},"Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.\n",["194","264"],"Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected. Default: null.\n",["265"],"Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream servers TLS certificate. If set to null when Nginx default is respected. With form-encoded, the notation is `ca_certificates[]=4e3ad2e4-0bc4-4638-8e34-c84a417ba39b&ca_certificates[]=51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515`. With JSON, use an array.",{"type":"194","examples":"266"},"Whether the service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404).",{"type":"194"},"user-level","4e3ad2e4-0bc4-4638-8e34-c84a417ba39b","low-priority","51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515","grpc","grpcs","tcp","tls ","tls_passthrough","udp","ws","wss",["250"],{"type":"194","examples":"267"},"null","respected",["251"],["251"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a Service",["17"],"bf6316cd4aeb2","delete","/services/{service_id_or_name}",["18"],{},"delete-service","inheritedFromService",["19"],{"headers":"20","query":"21","cookie":"22","path":"23"},["24"],["25"],"Services",{"id":"26","name":"17"},{"id":"27","code":"28","headers":"29","contents":"30","description":"31"},[],[],[],["32"],["33"],{"id":"34","url":"35","name":"36","description":"37","variables":"38"},"a17c4a94d4d31","7a46abd0b2418","204",[],[],"Successfully deleted Service or the resource didn't exist",{"id":"39","name":"40","style":"41","examples":"42","description":"43","required":true,"schema":"44","explicitProperties":"45"},{"id":"46","key":"47","extensions":"48","description":"49","type":"50","name":"51","in":"52"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"53","path":"54","port":"55","protocol":"56"},"2fc67ef26c11c","service_id_or_name","simple",["57"],"ID **or** name of the service to lookup",{"type":"58","examples":"59","$schema":"60","x-stoplight":"61"},["62","63","64","65","66","67","68"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74"},{"default":"75","description":"76","enum":"77"},{"id":"78","value":"79","key":"80"},"string",["79"],"http://json-schema.org/draft-07/schema#",{"id":"81"},"name","description","example","in","required","schema","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["75","82"],"c6f6c4f51a7c2","test-service","default","20300ced07722","https"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a Service",["18"],"7405361a69f88","get","/services/{service_id_or_name}",["19"],{},"get-service","Get a Service using ID or name.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Services",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45"],["46"],{"id":"47","url":"48","name":"49","description":"50","variables":"51"},"a17c4a94d4d31","1684c2e5c0e3a","200",[],["52"],"Successfully fetched Service","8114c25450c8b","401",[],["53"],"Unauthorized","8164c25451508","404",[],[],"Resource does not exist",{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},{"id":"77","mediaType":"73","examples":"78","encodings":"79","schema":"80"},"2220d606e9434","service_id_or_name","simple",["81"],"ID **or** name of the service to lookup",{"type":"82","examples":"83","$schema":"84","x-stoplight":"85"},["86","87","88","89","90","91","92"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98"},{"default":"99","description":"100","enum":"101"},"611deda89eca6","application/json",["102"],[],{"description":"103","properties":"104","type":"105","title":"106","examples":"107"},"5166b065a1231",["108","109","110"],[],{"type":"105","properties":"111","required":"112","title":"113","$schema":"84","x-stoplight":"114"},{"id":"115","value":"116","key":"117"},"string",["116"],"http://json-schema.org/draft-07/schema#",{"id":"118"},"name","description","example","in","required","schema","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["99","119"],{"id":"120","value":"121","key":"117"},"Service entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its `protocol`, `host`, `port` and `path` individually. Services are associated to routes (a Service can have many routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.",{"ca_certificates":"122","client_certificate":"123","connect_timeout":"124","created_at":"125","enabled":"126","host":"127","id":"128","name":"129","path":"130","port":"131","protocol":"132","read_timeout":"133","retries":"134","tags":"135","tls_verify":"136","tls_verify_depth":"137","updated_at":"138","url":"139","write_timeout":"140"},"object","Service",["121"],{"id":"141","key":"142","value":"143","summary":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"status":"153","message":"154"},["155","156"],"UnauthorizedError",{"id":"157"},"88b11e7e91902","test-service","default","9e9ba2bf6cd35","https","29b3641675c97",{"host":"158","id":"159","name":"160","path":"95","port":80,"protocol":"99"},{"description":"161","items":"162","type":"163"},{"additionalProperties":false,"description":"164","properties":"165","type":"105"},{"default":60000,"description":"166","type":"167"},{"description":"168","type":"167"},{"default":true,"description":"169","type":"170"},{"description":"171","type":"82"},{"type":"82"},{"description":"172","type":"82"},{"description":"173","type":"82"},{"default":80,"description":"174","type":"167"},{"default":"99","description":"175","type":"82"},{"default":60000,"description":"176","type":"167"},{"default":5,"description":"177","type":"167"},{"description":"178","items":"179","type":"163"},{"description":"180","type":"170"},{"description":"181","type":"167"},{"description":"182","type":"167"},{"description":"183","type":"82"},{"default":60000,"description":"184","type":"167"},"a9721ad57d2bb","DuplicateApiKey",{"message":"144","status":401},"Duplicate API key found","e99310bccd694","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","2bfa6320a28d3","NoAPIKey",{"message":"185","status":401},"No API key found",{"type":"167"},{"type":"82"},"status","message","470b68e5f0549","example.internal","49fd316e-c457-481c-9fc7-8079153e4f3c","example-service","Array of `CA Certificate` object UUIDs that are used to build the trust store while verifying upstream servers TLS certificate. If set to `null` when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).",{"type":"82"},"array","Certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"186"},"The timeout in milliseconds for establishing a connection to the upstream server.","integer","Unix epoch when the resource was created.","Whether the Service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404).","boolean","The host of the upstream server. Note that the host value is case sensitive.","The Service name.","The path to be used in requests to the upstream server.","The upstream server port.","The protocol used to communicate with the upstream.","The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.","The number of retries to execute upon failure to proxy.","An optional set of strings associated with the Service for grouping and filtering.",{"type":"82"},"Whether to enable verification of upstream server TLS certificate. If set to `null`, then the Nginx default is respected.","Maximum depth of chain while verifying Upstream server's TLS certificate. If set to `null`, then the Nginx default is respected.","Unix epoch when the resource was last updated.","Helper field to set `protocol`, `host`, `port` and `path` using a URL. This field is write-only and is not returned in responses.","The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.","No API key found in request",{"type":"82"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update a Service",["17"],"2b8fa4e7089d8","patch","/services/{service_id_or_name}",["18"],{},"update-service","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Services",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54"],["55"],{"id":"56","url":"57","name":"58","description":"59","variables":"60"},"a17c4a94d4d31","90b1ba89a2031","200",[],["61"],"Successfully updated Service","3091b8acd2f3d","400",[],["62"],"Invalid Service","3081b8acd21ee","401",[],["63"],"Unauthorized","30d1b8acd3661","404",[],[],"Resource does not exist","83c0e45e28c1a",["64"],"The request body for creating a new service entity.",{"id":"65","name":"66","style":"67","examples":"68","description":"69","required":true,"schema":"70","explicitProperties":"71"},{"id":"72","key":"73","extensions":"74","description":"75","type":"76","name":"77","in":"78"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"79","path":"80","port":"81","protocol":"82"},{"id":"83","mediaType":"84","examples":"85","encodings":"86","schema":"87"},{"id":"88","mediaType":"84","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"84","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"84","examples":"97","encodings":"98","schema":"99"},"ed0e55e91d50a","service_id_or_name","simple",["100"],"ID **or** name of the service to lookup",{"type":"101","examples":"102","$schema":"103","x-stoplight":"104"},["105","106","107","108","109","110","111"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"112","description":"113"},{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119","enum":"120"},"aa7f6754bbc5a","application/json",["121"],[],{"description":"122","properties":"123","type":"124","title":"125","examples":"126"},"5875ca64652fd",[],[],{"type":"124","$schema":"103","x-stoplight":"127"},"7d70f5e659769",["128","129","130"],[],{"type":"124","properties":"131","required":"132","title":"133","$schema":"103","x-stoplight":"134"},"d39b9175167eb",["135"],[],{"type":"124","x-examples":"136","properties":"137","required":"138","$schema":"103","x-stoplight":"139"},{"id":"140","value":"141","key":"142"},"string",["141"],"http://json-schema.org/draft-07/schema#",{"id":"143"},"name","description","example","in","required","schema","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["118","144"],{"id":"145","value":"146","key":"142"},"Service entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its `protocol`, `host`, `port` and `path` individually. Services are associated to routes (a Service can have many routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.",{"ca_certificates":"147","client_certificate":"148","connect_timeout":"149","created_at":"150","enabled":"151","host":"152","id":"153","name":"154","path":"155","port":"156","protocol":"157","read_timeout":"158","retries":"159","tags":"160","tls_verify":"161","tls_verify_depth":"162","updated_at":"163","url":"164","write_timeout":"165"},"object","Service",["146"],{"id":"166"},{"id":"167","key":"168","value":"169","summary":"170"},{"id":"171","key":"172","value":"173","summary":"174"},{"id":"175","key":"176","value":"177","summary":"178"},{"status":"179","message":"180"},["181","182"],"UnauthorizedError",{"id":"183"},{"id":"184","key":"185","value":"186"},{"Example 1":"187"},{"name":"188","retries":"189","protocol":"190","host":"191","port":"192","path":"193","connect_timeout":"194","write_timeout":"195","read_timeout":"196","tags":"197","client_certificate":"198","tls_verify":"199","tls_verify_depth":"200","ca_certificates":"201","enabled":"202"},["203","204","205","206"],{"id":"207"},"30ceb3bb37be3","test-service","default","7e8db4fce3b18","https","00357f7070bfd",{"host":"208","id":"209","name":"210","path":"114","port":80,"protocol":"118"},{"description":"211","items":"212","type":"213"},{"additionalProperties":false,"description":"214","properties":"215","type":"124"},{"default":60000,"description":"216","type":"217"},{"description":"218","type":"217"},{"default":true,"description":"219","type":"220"},{"description":"221","type":"101"},{"type":"101"},{"description":"222","type":"101"},{"description":"223","type":"101"},{"default":80,"description":"224","type":"217"},{"default":"118","description":"225","type":"101"},{"default":60000,"description":"226","type":"217"},{"default":5,"description":"227","type":"217"},{"description":"228","items":"229","type":"213"},{"description":"230","type":"220"},{"description":"231","type":"217"},{"description":"232","type":"217"},{"description":"233","type":"101"},{"default":60000,"description":"234","type":"217"},"3ecc395d26d38","ee2b49fbb8c94","DuplicateApiKey",{"message":"170","status":401},"Duplicate API key found","154a5be2094c8","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","6e3e36e60cfb5","NoAPIKey",{"message":"235","status":401},"No API key found",{"type":"217"},{"type":"101"},"status","message","470b68e5f0549","6da495a87363e","Example",{"name":"236","retries":5,"protocol":"118","host":"237","port":80,"path":"238","connect_timeout":6000,"write_timeout":6000,"read_timeout":6000,"tags":"239","client_certificate":"240","tls_verify":true,"tls_verify_depth":null,"ca_certificates":"241","enabled":true},{"id":"242","created_at":1422386534,"updated_at":1422386534,"name":"236","retries":5,"protocol":"118","host":"237","port":80,"path":"238","connect_timeout":60000,"write_timeout":60000,"read_timeout":60000,"tags":"243","client_certificate":"244","tls_verify":true,"tls_verify_depth":null,"ca_certificates":"245","enabled":true},{"type":"101","description":"246","examples":"247"},{"type":"217","description":"248","default":5,"examples":"249"},{"type":"101","description":"250","default":"118","enum":"251","examples":"252"},{"type":"101","description":"253","examples":"254"},{"type":"217","description":"255","default":80,"examples":"256"},{"type":"101","description":"257","examples":"258"},{"type":"217","description":"259","default":6000,"examples":"260"},{"type":"217","description":"261","default":6000,"examples":"262"},{"type":"217","description":"263","default":6000,"examples":"264"},{"type":"213","description":"265","items":"266"},{"type":"124","description":"267","properties":"268"},{"type":"220","description":"269","default":true},{"type":"270","description":"271","default":null,"examples":"272"},{"type":"213","description":"273","items":"274"},{"type":"220","default":true,"description":"275"},"protocol","host","port","enabled","793ad71c2cc6c","example.internal","49fd316e-c457-481c-9fc7-8079153e4f3c","example-service","Array of `CA Certificate` object UUIDs that are used to build the trust store while verifying upstream servers TLS certificate. If set to `null` when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).",{"type":"101"},"array","Certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"276"},"The timeout in milliseconds for establishing a connection to the upstream server.","integer","Unix epoch when the resource was created.","Whether the Service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404).","boolean","The host of the upstream server. Note that the host value is case sensitive.","The Service name.","The path to be used in requests to the upstream server.","The upstream server port.","The protocol used to communicate with the upstream.","The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.","The number of retries to execute upon failure to proxy.","An optional set of strings associated with the Service for grouping and filtering.",{"type":"101"},"Whether to enable verification of upstream server TLS certificate. If set to `null`, then the Nginx default is respected.","Maximum depth of chain while verifying Upstream server's TLS certificate. If set to `null`, then the Nginx default is respected.","Unix epoch when the resource was last updated.","Helper field to set `protocol`, `host`, `port` and `path` using a URL. This field is write-only and is not returned in responses.","The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.","No API key found in request","my-service","example.com","/some_api",["277"],{"id":"278"},["278"],"9748f662-7711-4a90-8186-dc02f10eb0f5",["277","279"],{"id":"278"},["278","280"],"The service name.\n",["236"],"The number of retries to execute upon failure to proxy. Default:`5`.\n",[5],"The protocol used to communicate with the upstream. Accepted values are: \"`grpc`\", \"`grpcs`\", \"`http`\", \"`https`\", \"`tcp`\", \"`tls`\", \"`tls_passthrough`\", \"`udp`\", \"`ws`\"\n, \"`wss`\"\n. Default: \"`http`\".",["281","282","118","144","283","284","285","286","287","288"],["118"],"The host of the upstream server. Note that the host value is case sensitive.\n",["237"],"The upstream server port. Default: `80`.\n",[80],"The path to be used in requests to the upstream server.\n",["238"],"The timeout in milliseconds for establishing a connection to the upstream server. Default `60000`.",[6000],"The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. Default: `60000`.\n",[6000],"The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server. Default: `60000`.\n",[6000],"An optional set of strings associated with the service for grouping and filtering.\n",{"type":"101","examples":"289"},"Certificate to be used as client certificate while TLS handshaking to the upstream server. With form-encoded, the notation is `client_certificate.id=<client_certificate id>`. With JSON, use `\"client_certificate\":{\"id\":\"<client_certificate id>\"}`.",{"id":"290"},"Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.\n",["101","291"],"Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected. Default: null.\n",["292"],"Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream servers TLS certificate. If set to null when Nginx default is respected. With form-encoded, the notation is `ca_certificates[]=4e3ad2e4-0bc4-4638-8e34-c84a417ba39b&ca_certificates[]=51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515`. With JSON, use an array.",{"type":"101","examples":"293"},"Whether the service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404).",{"type":"101"},"user-level","4e3ad2e4-0bc4-4638-8e34-c84a417ba39b","low-priority","51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515","grpc","grpcs","tcp","tls ","tls_passthrough","udp","ws","wss",["277"],{"type":"101","examples":"294"},"null","respected",["278"],["278"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a Service",["18"],"e374cd79194ea","put","/services/{service_id_or_name}",["19"],{},"upsert-service","Create or Update Service using ID or name.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Services",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"a17c4a94d4d31","f3d655667aa94","200",[],["56"],"Successfully upserted Service","2e7654bdf0680","400",[],["57"],"Invalid Service","2e6654bdf04df","401",[],["58"],"Unauthorized","22b1241323800",["59"],"The request body for creating a new service entity.",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"79","examples":"84","encodings":"85","schema":"86"},{"id":"87","mediaType":"79","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"79","examples":"92","encodings":"93","schema":"94"},"b31937deee517","service_id_or_name","simple",["95"],"ID **or** name of the service to lookup",{"type":"96","examples":"97","$schema":"98","x-stoplight":"99"},["100","101","102","103","104","105","106"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"107","description":"108"},{"default":"109","description":"110"},{"default":"111","description":"112"},{"default":"113","description":"114","enum":"115"},"09690053cf12c","application/json",["116"],[],{"description":"117","properties":"118","type":"119","title":"120","examples":"121"},"14f2e2a28b67e",[],[],{"type":"119","$schema":"98","x-stoplight":"122"},"06b5a49e38c5c",["123","124","125"],[],{"type":"119","properties":"126","required":"127","title":"128","$schema":"98","x-stoplight":"129"},"d7cd73ce04e60",["130"],[],{"type":"119","x-examples":"131","properties":"132","required":"133","$schema":"98","x-stoplight":"134"},{"id":"135","value":"136","key":"137"},"string",["136"],"http://json-schema.org/draft-07/schema#",{"id":"138"},"name","description","example","in","required","schema","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["113","139"],{"id":"140","value":"141","key":"137"},"Service entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its `protocol`, `host`, `port` and `path` individually. Services are associated to routes (a Service can have many routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.",{"ca_certificates":"142","client_certificate":"143","connect_timeout":"144","created_at":"145","enabled":"146","host":"147","id":"148","name":"149","path":"150","port":"151","protocol":"152","read_timeout":"153","retries":"154","tags":"155","tls_verify":"156","tls_verify_depth":"157","updated_at":"158","url":"159","write_timeout":"160"},"object","Service",["141"],{"id":"161"},{"id":"162","key":"163","value":"164","summary":"165"},{"id":"166","key":"167","value":"168","summary":"169"},{"id":"170","key":"171","value":"172","summary":"173"},{"status":"174","message":"175"},["176","177"],"UnauthorizedError",{"id":"178"},{"id":"179","key":"180","value":"181"},{"Example 1":"182"},{"name":"183","retries":"184","protocol":"185","host":"186","port":"187","path":"188","connect_timeout":"189","write_timeout":"190","read_timeout":"191","tags":"192","client_certificate":"193","tls_verify":"194","tls_verify_depth":"195","ca_certificates":"196","enabled":"197"},["198","199","200","201"],{"id":"202"},"2e4c8b3e951c4","test-service","default","d313a774f959d","https","5feeac920d1bc",{"host":"203","id":"204","name":"205","path":"109","port":80,"protocol":"113"},{"description":"206","items":"207","type":"208"},{"additionalProperties":false,"description":"209","properties":"210","type":"119"},{"default":60000,"description":"211","type":"212"},{"description":"213","type":"212"},{"default":true,"description":"214","type":"215"},{"description":"216","type":"96"},{"type":"96"},{"description":"217","type":"96"},{"description":"218","type":"96"},{"default":80,"description":"219","type":"212"},{"default":"113","description":"220","type":"96"},{"default":60000,"description":"221","type":"212"},{"default":5,"description":"222","type":"212"},{"description":"223","items":"224","type":"208"},{"description":"225","type":"215"},{"description":"226","type":"212"},{"description":"227","type":"212"},{"description":"228","type":"96"},{"default":60000,"description":"229","type":"212"},"737e7774068db","4c1997d940c56","DuplicateApiKey",{"message":"165","status":401},"Duplicate API key found","101ce50405389","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","3d589098a0271","NoAPIKey",{"message":"230","status":401},"No API key found",{"type":"212"},{"type":"96"},"status","message","470b68e5f0549","27b6fbc468c21","Example",{"name":"231","retries":5,"protocol":"113","host":"232","port":80,"path":"233","connect_timeout":6000,"write_timeout":6000,"read_timeout":6000,"tags":"234","client_certificate":"235","tls_verify":true,"tls_verify_depth":null,"ca_certificates":"236","enabled":true},{"id":"237","created_at":1422386534,"updated_at":1422386534,"name":"231","retries":5,"protocol":"113","host":"232","port":80,"path":"233","connect_timeout":60000,"write_timeout":60000,"read_timeout":60000,"tags":"238","client_certificate":"239","tls_verify":true,"tls_verify_depth":null,"ca_certificates":"240","enabled":true},{"type":"96","description":"241","examples":"242"},{"type":"212","description":"243","default":5,"examples":"244"},{"type":"96","description":"245","default":"113","enum":"246","examples":"247"},{"type":"96","description":"248","examples":"249"},{"type":"212","description":"250","default":80,"examples":"251"},{"type":"96","description":"252","examples":"253"},{"type":"212","description":"254","default":6000,"examples":"255"},{"type":"212","description":"256","default":6000,"examples":"257"},{"type":"212","description":"258","default":6000,"examples":"259"},{"type":"208","description":"260","items":"261"},{"type":"119","description":"262","properties":"263"},{"type":"215","description":"264","default":true},{"type":"265","description":"266","default":null,"examples":"267"},{"type":"208","description":"268","items":"269"},{"type":"215","default":true,"description":"270"},"protocol","host","port","enabled","793ad71c2cc6c","example.internal","49fd316e-c457-481c-9fc7-8079153e4f3c","example-service","Array of `CA Certificate` object UUIDs that are used to build the trust store while verifying upstream servers TLS certificate. If set to `null` when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).",{"type":"96"},"array","Certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"271"},"The timeout in milliseconds for establishing a connection to the upstream server.","integer","Unix epoch when the resource was created.","Whether the Service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404).","boolean","The host of the upstream server. Note that the host value is case sensitive.","The Service name.","The path to be used in requests to the upstream server.","The upstream server port.","The protocol used to communicate with the upstream.","The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.","The number of retries to execute upon failure to proxy.","An optional set of strings associated with the Service for grouping and filtering.",{"type":"96"},"Whether to enable verification of upstream server TLS certificate. If set to `null`, then the Nginx default is respected.","Maximum depth of chain while verifying Upstream server's TLS certificate. If set to `null`, then the Nginx default is respected.","Unix epoch when the resource was last updated.","Helper field to set `protocol`, `host`, `port` and `path` using a URL. This field is write-only and is not returned in responses.","The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.","No API key found in request","my-service","example.com","/some_api",["272"],{"id":"273"},["273"],"9748f662-7711-4a90-8186-dc02f10eb0f5",["272","274"],{"id":"273"},["273","275"],"The service name.\n",["231"],"The number of retries to execute upon failure to proxy. Default:`5`.\n",[5],"The protocol used to communicate with the upstream. Accepted values are: \"`grpc`\", \"`grpcs`\", \"`http`\", \"`https`\", \"`tcp`\", \"`tls`\", \"`tls_passthrough`\", \"`udp`\", \"`ws`\"\n, \"`wss`\"\n. Default: \"`http`\".",["276","277","113","139","278","279","280","281","282","283"],["113"],"The host of the upstream server. Note that the host value is case sensitive.\n",["232"],"The upstream server port. Default: `80`.\n",[80],"The path to be used in requests to the upstream server.\n",["233"],"The timeout in milliseconds for establishing a connection to the upstream server. Default `60000`.",[6000],"The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. Default: `60000`.\n",[6000],"The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server. Default: `60000`.\n",[6000],"An optional set of strings associated with the service for grouping and filtering.\n",{"type":"96","examples":"284"},"Certificate to be used as client certificate while TLS handshaking to the upstream server. With form-encoded, the notation is `client_certificate.id=<client_certificate id>`. With JSON, use `\"client_certificate\":{\"id\":\"<client_certificate id>\"}`.",{"id":"285"},"Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.\n",["96","286"],"Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected. Default: null.\n",["287"],"Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream servers TLS certificate. If set to null when Nginx default is respected. With form-encoded, the notation is `ca_certificates[]=4e3ad2e4-0bc4-4638-8e34-c84a417ba39b&ca_certificates[]=51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515`. With JSON, use an array.",{"type":"96","examples":"288"},"Whether the service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404).",{"type":"96"},"user-level","4e3ad2e4-0bc4-4638-8e34-c84a417ba39b","low-priority","51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515","grpc","grpcs","tcp","tls ","tls_passthrough","udp","ws","wss",["272"],{"type":"96","examples":"289"},"null","respected",["273"],["273"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-service-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all Services in a workspace",["17"],"69d09c5bd6091","get","/{workspace}/services",["18"],{},"list-service-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Services",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],["41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"a17c4a94d4d31","2bd99725b7665","200",[],["48"],"A successful response listing Services","d3a99548f4bb9","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"71","examples":"72","description":"73","required":true,"schema":"74","explicitProperties":"75"},{"id":"76","key":"77","extensions":"78","description":"79","type":"80","name":"81","in":"82"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"83","path":"84","port":"85","protocol":"86"},{"id":"87","mediaType":"88","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"88","examples":"93","encodings":"94","schema":"95"},"6c6ed049690d5","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103"],"d8ca2c818c3d0","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"104","$schema":"97","x-stoplight":"105"},["99","100","101","102","103"],"a00f40216cd5f","tags",["106"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"104","examples":"107","x-stoplight":"108","$schema":"97"},["99","109","100","101","102","103"],"8e8d7d27be2a8","workspace","simple",[],"Name or ID of workspace",{"type":"104","examples":"110","$schema":"97","x-stoplight":"111"},["101","100","112","102","99","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"484948d03671c","application/json",["122"],[],{"description":"123","properties":"124","type":"125","title":"126","examples":"127"},"d4fbcfb75c94a",["128","129","130"],[],{"type":"125","properties":"131","required":"132","title":"133","$schema":"97","x-stoplight":"134"},"integer","http://json-schema.org/draft-07/schema#",{"id":"135"},"description","in","name","schema","title","string",{"id":"136"},{"id":"137","value":"138","key":"139"},["138"],{"explicitProperties":"140","id":"141"},"example",["142"],{"id":"143"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","144"],{"id":"145","value":"146","key":"139"},"Service entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its `protocol`, `host`, `port` and `path` individually. Services are associated to routes (a Service can have many routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.",{"ca_certificates":"147","client_certificate":"148","connect_timeout":"149","created_at":"150","enabled":"151","host":"152","id":"153","name":"154","path":"155","port":"156","protocol":"157","read_timeout":"158","retries":"159","tags":"160","tls_verify":"161","tls_verify_depth":"162","updated_at":"163","url":"164","write_timeout":"165"},"object","Service",["146"],{"id":"166","key":"167","value":"168","summary":"169"},{"id":"170","key":"171","value":"172","summary":"173"},{"id":"174","key":"175","value":"176","summary":"177"},{"status":"178","message":"179"},["180","181"],"UnauthorizedError",{"id":"182"},"ebf5b4c694c21","63be83b975231","0554a10f2a172","tag1,tag2","default",["183","184","185"],"5bfc9203af196","team-a","02ca778102ac6","https","fef0889745592",{"host":"186","id":"187","name":"188","path":"115","port":80,"protocol":"119"},{"description":"189","items":"190","type":"191"},{"additionalProperties":false,"description":"192","properties":"193","type":"125"},{"default":60000,"description":"194","type":"96"},{"description":"195","type":"96"},{"default":true,"description":"196","type":"197"},{"description":"198","type":"104"},{"type":"104"},{"description":"199","type":"104"},{"description":"200","type":"104"},{"default":80,"description":"201","type":"96"},{"default":"119","description":"202","type":"104"},{"default":60000,"description":"203","type":"96"},{"default":5,"description":"204","type":"96"},{"description":"205","items":"206","type":"191"},{"description":"207","type":"197"},{"description":"208","type":"96"},{"description":"209","type":"96"},{"description":"210","type":"104"},{"default":60000,"description":"211","type":"96"},"1633ae020b998","DuplicateApiKey",{"message":"169","status":401},"Duplicate API key found","2a27fa94f7dbe","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","5884047bbf471","NoAPIKey",{"message":"212","status":401},"No API key found",{"type":"96"},{"type":"104"},"status","message","470b68e5f0549","type","nullable","examples","example.internal","49fd316e-c457-481c-9fc7-8079153e4f3c","example-service","Array of `CA Certificate` object UUIDs that are used to build the trust store while verifying upstream servers TLS certificate. If set to `null` when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).",{"type":"104"},"array","Certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"213"},"The timeout in milliseconds for establishing a connection to the upstream server.","Unix epoch when the resource was created.","Whether the Service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404).","boolean","The host of the upstream server. Note that the host value is case sensitive.","The Service name.","The path to be used in requests to the upstream server.","The upstream server port.","The protocol used to communicate with the upstream.","The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.","The number of retries to execute upon failure to proxy.","An optional set of strings associated with the Service for grouping and filtering.",{"type":"104"},"Whether to enable verification of upstream server TLS certificate. If set to `null`, then the Nginx default is respected.","Maximum depth of chain while verifying Upstream server's TLS certificate. If set to `null`, then the Nginx default is respected.","Unix epoch when the resource was last updated.","Helper field to set `protocol`, `host`, `port` and `path` using a URL. This field is write-only and is not returned in responses.","The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.","No API key found in request",{"type":"104"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-service-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new Service in a workspace",["17"],"f9d77bee804fd","post","/{workspace}/services",["18"],{},"create-service-in-workspace","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Services",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48"],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"a17c4a94d4d31","e91ac857d0e2c","200",[],["55"],"Successfully created Service","53bac7c660e8f","400",[],["56"],"Invalid Service","53cac7c660c30","401",[],["57"],"Unauthorized","152889fcd6123",["58"],"The request body for creating a new service entity.",{"id":"59","name":"60","style":"61","examples":"62","description":"63","required":true,"schema":"64","explicitProperties":"65"},{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},{"id":"86","mediaType":"78","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"78","examples":"91","encodings":"92","schema":"93"},"f376b700c391e","workspace","simple",[],"Name or ID of workspace",{"type":"94","examples":"95","$schema":"96","x-stoplight":"97"},["98","99","100","101","102","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111","enum":"112"},"24a17d86d05e0","application/json",["113"],[],{"description":"114","properties":"115","type":"116","title":"117","examples":"118"},"aecb0754a2839",[],[],{"type":"116","$schema":"96","x-stoplight":"119"},"8dda5f38ba7f4",["120","121","122"],[],{"type":"116","properties":"123","required":"124","title":"125","$schema":"96","x-stoplight":"126"},"4f9b04727e386",["127"],[],{"type":"116","x-examples":"128","properties":"129","required":"130","$schema":"96","x-stoplight":"131"},"string",["132"],"http://json-schema.org/draft-07/schema#",{"id":"133"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["110","134"],{"id":"135","value":"136","key":"137"},"Service entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its `protocol`, `host`, `port` and `path` individually. Services are associated to routes (a Service can have many routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.",{"ca_certificates":"138","client_certificate":"139","connect_timeout":"140","created_at":"141","enabled":"142","host":"143","id":"144","name":"145","path":"146","port":"147","protocol":"148","read_timeout":"149","retries":"150","tags":"151","tls_verify":"152","tls_verify_depth":"153","updated_at":"154","url":"155","write_timeout":"156"},"object","Service",["136"],{"id":"157"},{"id":"158","key":"159","value":"160","summary":"161"},{"id":"162","key":"163","value":"164","summary":"165"},{"id":"166","key":"167","value":"168","summary":"169"},{"status":"170","message":"171"},["172","173"],"UnauthorizedError",{"id":"174"},{"id":"175","key":"176","value":"177"},{"Example 1":"178"},{"name":"179","retries":"180","protocol":"181","host":"182","port":"183","path":"184","connect_timeout":"185","write_timeout":"186","read_timeout":"187","tags":"188","client_certificate":"189","tls_verify":"190","tls_verify_depth":"191","ca_certificates":"192","enabled":"193"},["194","195","196","197"],{"id":"198"},"team-a","417004a3bb550","https","a603094d8a1ec",{"host":"199","id":"200","name":"201","path":"106","port":80,"protocol":"110"},"default",{"description":"202","items":"203","type":"204"},{"additionalProperties":false,"description":"205","properties":"206","type":"116"},{"default":60000,"description":"207","type":"208"},{"description":"209","type":"208"},{"default":true,"description":"210","type":"211"},{"description":"212","type":"94"},{"type":"94"},{"description":"213","type":"94"},{"description":"214","type":"94"},{"default":80,"description":"215","type":"208"},{"default":"110","description":"216","type":"94"},{"default":60000,"description":"217","type":"208"},{"default":5,"description":"218","type":"208"},{"description":"219","items":"220","type":"204"},{"description":"221","type":"211"},{"description":"222","type":"208"},{"description":"223","type":"208"},{"description":"224","type":"94"},{"default":60000,"description":"225","type":"208"},"5c62dee935513","c20d0f1065d7e","DuplicateApiKey",{"message":"161","status":401},"Duplicate API key found","e2cd49fc464d6","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","cf5c783ed364c","NoAPIKey",{"message":"226","status":401},"No API key found",{"type":"208"},{"type":"94"},"status","message","470b68e5f0549","11af3345553f4","Example",{"name":"227","retries":5,"protocol":"110","host":"228","port":80,"path":"229","connect_timeout":6000,"write_timeout":6000,"read_timeout":6000,"tags":"230","client_certificate":"231","tls_verify":true,"tls_verify_depth":null,"ca_certificates":"232","enabled":true},{"id":"233","created_at":1422386534,"updated_at":1422386534,"name":"227","retries":5,"protocol":"110","host":"228","port":80,"path":"229","connect_timeout":60000,"write_timeout":60000,"read_timeout":60000,"tags":"234","client_certificate":"235","tls_verify":true,"tls_verify_depth":null,"ca_certificates":"236","enabled":true},{"type":"94","description":"237","examples":"238"},{"type":"208","description":"239","default":5,"examples":"240"},{"type":"94","description":"241","default":"110","enum":"242","examples":"243"},{"type":"94","description":"244","examples":"245"},{"type":"208","description":"246","default":80,"examples":"247"},{"type":"94","description":"248","examples":"249"},{"type":"208","description":"250","default":6000,"examples":"251"},{"type":"208","description":"252","default":6000,"examples":"253"},{"type":"208","description":"254","default":6000,"examples":"255"},{"type":"204","description":"256","items":"257"},{"type":"116","description":"258","properties":"259"},{"type":"211","description":"260","default":true},{"type":"261","description":"262","default":null,"examples":"263"},{"type":"204","description":"264","items":"265"},{"type":"211","default":true,"description":"266"},"protocol","host","port","enabled","793ad71c2cc6c","example.internal","49fd316e-c457-481c-9fc7-8079153e4f3c","example-service","Array of `CA Certificate` object UUIDs that are used to build the trust store while verifying upstream servers TLS certificate. If set to `null` when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).",{"type":"94"},"array","Certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"267"},"The timeout in milliseconds for establishing a connection to the upstream server.","integer","Unix epoch when the resource was created.","Whether the Service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404).","boolean","The host of the upstream server. Note that the host value is case sensitive.","The Service name.","The path to be used in requests to the upstream server.","The upstream server port.","The protocol used to communicate with the upstream.","The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.","The number of retries to execute upon failure to proxy.","An optional set of strings associated with the Service for grouping and filtering.",{"type":"94"},"Whether to enable verification of upstream server TLS certificate. If set to `null`, then the Nginx default is respected.","Maximum depth of chain while verifying Upstream server's TLS certificate. If set to `null`, then the Nginx default is respected.","Unix epoch when the resource was last updated.","Helper field to set `protocol`, `host`, `port` and `path` using a URL. This field is write-only and is not returned in responses.","The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.","No API key found in request","my-service","example.com","/some_api",["268"],{"id":"269"},["269"],"9748f662-7711-4a90-8186-dc02f10eb0f5",["268","270"],{"id":"269"},["269","271"],"The service name.\n",["227"],"The number of retries to execute upon failure to proxy. Default:`5`.\n",[5],"The protocol used to communicate with the upstream. Accepted values are: \"`grpc`\", \"`grpcs`\", \"`http`\", \"`https`\", \"`tcp`\", \"`tls`\", \"`tls_passthrough`\", \"`udp`\", \"`ws`\"\n, \"`wss`\"\n. Default: \"`http`\".",["272","273","110","134","274","275","276","277","278","279"],["110"],"The host of the upstream server. Note that the host value is case sensitive.\n",["228"],"The upstream server port. Default: `80`.\n",[80],"The path to be used in requests to the upstream server.\n",["229"],"The timeout in milliseconds for establishing a connection to the upstream server. Default `60000`.",[6000],"The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. Default: `60000`.\n",[6000],"The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server. Default: `60000`.\n",[6000],"An optional set of strings associated with the service for grouping and filtering.\n",{"type":"94","examples":"280"},"Certificate to be used as client certificate while TLS handshaking to the upstream server. With form-encoded, the notation is `client_certificate.id=<client_certificate id>`. With JSON, use `\"client_certificate\":{\"id\":\"<client_certificate id>\"}`.",{"id":"281"},"Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.\n",["94","282"],"Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected. Default: null.\n",["283"],"Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream servers TLS certificate. If set to null when Nginx default is respected. With form-encoded, the notation is `ca_certificates[]=4e3ad2e4-0bc4-4638-8e34-c84a417ba39b&ca_certificates[]=51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515`. With JSON, use an array.",{"type":"94","examples":"284"},"Whether the service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404).",{"type":"94"},"user-level","4e3ad2e4-0bc4-4638-8e34-c84a417ba39b","low-priority","51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515","grpc","grpcs","tcp","tls ","tls_passthrough","udp","ws","wss",["268"],{"type":"94","examples":"285"},"null","respected",["269"],["269"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-service-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a Service in a workspace",["17"],"b4ba4d00f4efb","delete","/{workspace}/services/{service_id_or_name}",["18"],{},"delete-service-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Services",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38","39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"a17c4a94d4d31","f5dab02007b07","204",[],[],"Successfully deleted Service or the resource didn't exist","1daab1e5b0066","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","name":"55","style":"49","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","key":"61","extensions":"62","description":"63","type":"64","name":"65","in":"66"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"67","path":"68","port":"69","protocol":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},"bc11008efdb3e","workspace","simple",[],"Name or ID of workspace",{"type":"76","examples":"77","$schema":"78","x-stoplight":"79"},["80","81","82","83","84","85"],"95f94f279857f","service_id_or_name",["86"],"ID **or** name of the service to lookup",{"type":"76","examples":"87","$schema":"78","x-stoplight":"88"},["80","84","89","81","82","83","85"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95"},{"default":"96","description":"97","enum":"98"},"ff8195e1ceafc","application/json",["99","100","101"],[],{"type":"102","properties":"103","required":"104","title":"105","$schema":"78","x-stoplight":"106"},"string",["107"],"http://json-schema.org/draft-07/schema#",{"id":"108"},"name","in","required","schema","description","title",{"id":"109","value":"110","key":"111"},["110"],{"id":"112"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["96","113"],{"id":"114","key":"115","value":"116","summary":"117"},{"id":"118","key":"119","value":"120","summary":"121"},{"id":"122","key":"123","value":"124","summary":"125"},"object",{"status":"126","message":"127"},["128","129"],"UnauthorizedError",{"id":"130"},"team-a","9e70445a14097","349ec136b6333","test-service","default","6e96ad4290f13","https","5620ed288cc45","DuplicateApiKey",{"message":"117","status":401},"Duplicate API key found","ae8d2f6c5e92d","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","9acd6f396f125","NoAPIKey",{"message":"131","status":401},"No API key found",{"type":"132"},{"type":"76"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-service-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a Service in a workspace",["18"],"63f24a0fc920d","get","/{workspace}/services/{service_id_or_name}",["19"],{},"get-service-in-workspace","Get a Service using ID or name in a workspace.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Services",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46"],["47"],{"id":"48","url":"49","name":"50","description":"51","variables":"52"},"a17c4a94d4d31","e06f19665f1f6","200",[],["53"],"Successfully fetched Service","387f1b4322dae","401",[],["54"],"Unauthorized","384f1b4321285","404",[],[],"Resource does not exist",{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"57","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"33878bcff99cd","workspace","simple",[],"Name or ID of workspace",{"type":"88","examples":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96","97"],"63877fad4b298","service_id_or_name",["98"],"ID **or** name of the service to lookup",{"type":"88","examples":"99","$schema":"90","x-stoplight":"100"},["92","96","101","93","94","95","97"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109","enum":"110"},"2fe25f4568637","application/json",["111"],[],{"description":"112","properties":"113","type":"114","title":"115","examples":"116"},"4179e6d5c7176",["117","118","119"],[],{"type":"114","properties":"120","required":"121","title":"122","$schema":"90","x-stoplight":"123"},"string",["124"],"http://json-schema.org/draft-07/schema#",{"id":"125"},"name","in","required","schema","description","title",{"id":"126","value":"127","key":"128"},["127"],{"id":"129"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["108","130"],{"id":"131","value":"132","key":"128"},"Service entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its `protocol`, `host`, `port` and `path` individually. Services are associated to routes (a Service can have many routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.",{"ca_certificates":"133","client_certificate":"134","connect_timeout":"135","created_at":"136","enabled":"137","host":"138","id":"139","name":"140","path":"141","port":"142","protocol":"143","read_timeout":"144","retries":"145","tags":"146","tls_verify":"147","tls_verify_depth":"148","updated_at":"149","url":"150","write_timeout":"151"},"object","Service",["132"],{"id":"152","key":"153","value":"154","summary":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"id":"160","key":"161","value":"162","summary":"163"},{"status":"164","message":"165"},["166","167"],"UnauthorizedError",{"id":"168"},"team-a","589a6789174cb","59a675e3c1758","test-service","default","dd5a1e31b6a68","https","f36b4e3938e8b",{"host":"169","id":"170","name":"171","path":"104","port":80,"protocol":"108"},{"description":"172","items":"173","type":"174"},{"additionalProperties":false,"description":"175","properties":"176","type":"114"},{"default":60000,"description":"177","type":"178"},{"description":"179","type":"178"},{"default":true,"description":"180","type":"181"},{"description":"182","type":"88"},{"type":"88"},{"description":"183","type":"88"},{"description":"184","type":"88"},{"default":80,"description":"185","type":"178"},{"default":"108","description":"186","type":"88"},{"default":60000,"description":"187","type":"178"},{"default":5,"description":"188","type":"178"},{"description":"189","items":"190","type":"174"},{"description":"191","type":"181"},{"description":"192","type":"178"},{"description":"193","type":"178"},{"description":"194","type":"88"},{"default":60000,"description":"195","type":"178"},"c1e2902508fec","DuplicateApiKey",{"message":"155","status":401},"Duplicate API key found","b000f4cbec4ee","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","69449f74d04a7","NoAPIKey",{"message":"196","status":401},"No API key found",{"type":"178"},{"type":"88"},"status","message","470b68e5f0549","example.internal","49fd316e-c457-481c-9fc7-8079153e4f3c","example-service","Array of `CA Certificate` object UUIDs that are used to build the trust store while verifying upstream servers TLS certificate. If set to `null` when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).",{"type":"88"},"array","Certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"197"},"The timeout in milliseconds for establishing a connection to the upstream server.","integer","Unix epoch when the resource was created.","Whether the Service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404).","boolean","The host of the upstream server. Note that the host value is case sensitive.","The Service name.","The path to be used in requests to the upstream server.","The upstream server port.","The protocol used to communicate with the upstream.","The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.","The number of retries to execute upon failure to proxy.","An optional set of strings associated with the Service for grouping and filtering.",{"type":"88"},"Whether to enable verification of upstream server TLS certificate. If set to `null`, then the Nginx default is respected.","Maximum depth of chain while verifying Upstream server's TLS certificate. If set to `null`, then the Nginx default is respected.","Unix epoch when the resource was last updated.","Helper field to set `protocol`, `host`, `port` and `path` using a URL. This field is write-only and is not returned in responses.","The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.","No API key found in request",{"type":"88"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-service-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update a Service in a workspace",["17"],"0e18c9c306fe4","patch","/{workspace}/services/{service_id_or_name}",["18"],{},"update-service-in-workspace","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Services",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54","55"],["56"],{"id":"57","url":"58","name":"59","description":"60","variables":"61"},"a17c4a94d4d31","d62d0f3598676","200",[],["62"],"Successfully updated Service","7e0d0d58d6f4e","400",[],["63"],"Invalid Service","7e1d0d58d6c9d","401",[],["64"],"Unauthorized","7e4d0d58d6982","404",[],[],"Resource does not exist","029ddc0d23677",["65"],"The request body for creating a new service entity.",{"id":"66","name":"67","style":"68","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","name":"74","style":"68","examples":"75","description":"76","required":true,"schema":"77","explicitProperties":"78"},{"id":"79","key":"80","extensions":"81","description":"82","type":"83","name":"84","in":"85"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"86","path":"87","port":"88","protocol":"89"},{"id":"90","mediaType":"91","examples":"92","encodings":"93","schema":"94"},{"id":"95","mediaType":"91","examples":"96","encodings":"97","schema":"98"},{"id":"99","mediaType":"91","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"91","examples":"104","encodings":"105","schema":"106"},"5c01966ab84ca","workspace","simple",[],"Name or ID of workspace",{"type":"107","examples":"108","$schema":"109","x-stoplight":"110"},["111","112","113","114","115","116"],"a282c5a6b8f02","service_id_or_name",["117"],"ID **or** name of the service to lookup",{"type":"107","examples":"118","$schema":"109","x-stoplight":"119"},["111","115","120","112","113","114","116"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"121","description":"122"},{"default":"123","description":"124"},{"default":"125","description":"126"},{"default":"127","description":"128","enum":"129"},"c1fac044aae32","application/json",["130"],[],{"description":"131","properties":"132","type":"133","title":"134","examples":"135"},"189e3c22a0b05",[],[],{"type":"133","$schema":"109","x-stoplight":"136"},"01e4e8f440f18",["137","138","139"],[],{"type":"133","properties":"140","required":"141","title":"142","$schema":"109","x-stoplight":"143"},"213a8da8804c3",["144"],[],{"type":"133","x-examples":"145","properties":"146","required":"147","$schema":"109","x-stoplight":"148"},"string",["149"],"http://json-schema.org/draft-07/schema#",{"id":"150"},"name","in","required","schema","description","title",{"id":"151","value":"152","key":"153"},["152"],{"id":"154"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["127","155"],{"id":"156","value":"157","key":"153"},"Service entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its `protocol`, `host`, `port` and `path` individually. Services are associated to routes (a Service can have many routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.",{"ca_certificates":"158","client_certificate":"159","connect_timeout":"160","created_at":"161","enabled":"162","host":"163","id":"164","name":"165","path":"166","port":"167","protocol":"168","read_timeout":"169","retries":"170","tags":"171","tls_verify":"172","tls_verify_depth":"173","updated_at":"174","url":"175","write_timeout":"176"},"object","Service",["157"],{"id":"177"},{"id":"178","key":"179","value":"180","summary":"181"},{"id":"182","key":"183","value":"184","summary":"185"},{"id":"186","key":"187","value":"188","summary":"189"},{"status":"190","message":"191"},["192","193"],"UnauthorizedError",{"id":"194"},{"id":"195","key":"196","value":"197"},{"Example 1":"198"},{"name":"199","retries":"200","protocol":"201","host":"202","port":"203","path":"204","connect_timeout":"205","write_timeout":"206","read_timeout":"207","tags":"208","client_certificate":"209","tls_verify":"210","tls_verify_depth":"211","ca_certificates":"212","enabled":"213"},["214","215","216","217"],{"id":"218"},"team-a","cf226339b7123","1111d23ad9bdf","test-service","default","3d12322c3bb47","https","ed570ac4dabc0",{"host":"219","id":"220","name":"221","path":"123","port":80,"protocol":"127"},{"description":"222","items":"223","type":"224"},{"additionalProperties":false,"description":"225","properties":"226","type":"133"},{"default":60000,"description":"227","type":"228"},{"description":"229","type":"228"},{"default":true,"description":"230","type":"231"},{"description":"232","type":"107"},{"type":"107"},{"description":"233","type":"107"},{"description":"234","type":"107"},{"default":80,"description":"235","type":"228"},{"default":"127","description":"236","type":"107"},{"default":60000,"description":"237","type":"228"},{"default":5,"description":"238","type":"228"},{"description":"239","items":"240","type":"224"},{"description":"241","type":"231"},{"description":"242","type":"228"},{"description":"243","type":"228"},{"description":"244","type":"107"},{"default":60000,"description":"245","type":"228"},"7a43afb165c2e","e76747daee0d5","DuplicateApiKey",{"message":"181","status":401},"Duplicate API key found","296b08ea8e07e","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","e5232397cf853","NoAPIKey",{"message":"246","status":401},"No API key found",{"type":"228"},{"type":"107"},"status","message","470b68e5f0549","c5616a1dc73d2","Example",{"name":"247","retries":5,"protocol":"127","host":"248","port":80,"path":"249","connect_timeout":6000,"write_timeout":6000,"read_timeout":6000,"tags":"250","client_certificate":"251","tls_verify":true,"tls_verify_depth":null,"ca_certificates":"252","enabled":true},{"id":"253","created_at":1422386534,"updated_at":1422386534,"name":"247","retries":5,"protocol":"127","host":"248","port":80,"path":"249","connect_timeout":60000,"write_timeout":60000,"read_timeout":60000,"tags":"254","client_certificate":"255","tls_verify":true,"tls_verify_depth":null,"ca_certificates":"256","enabled":true},{"type":"107","description":"257","examples":"258"},{"type":"228","description":"259","default":5,"examples":"260"},{"type":"107","description":"261","default":"127","enum":"262","examples":"263"},{"type":"107","description":"264","examples":"265"},{"type":"228","description":"266","default":80,"examples":"267"},{"type":"107","description":"268","examples":"269"},{"type":"228","description":"270","default":6000,"examples":"271"},{"type":"228","description":"272","default":6000,"examples":"273"},{"type":"228","description":"274","default":6000,"examples":"275"},{"type":"224","description":"276","items":"277"},{"type":"133","description":"278","properties":"279"},{"type":"231","description":"280","default":true},{"type":"281","description":"282","default":null,"examples":"283"},{"type":"224","description":"284","items":"285"},{"type":"231","default":true,"description":"286"},"protocol","host","port","enabled","793ad71c2cc6c","example.internal","49fd316e-c457-481c-9fc7-8079153e4f3c","example-service","Array of `CA Certificate` object UUIDs that are used to build the trust store while verifying upstream servers TLS certificate. If set to `null` when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).",{"type":"107"},"array","Certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"287"},"The timeout in milliseconds for establishing a connection to the upstream server.","integer","Unix epoch when the resource was created.","Whether the Service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404).","boolean","The host of the upstream server. Note that the host value is case sensitive.","The Service name.","The path to be used in requests to the upstream server.","The upstream server port.","The protocol used to communicate with the upstream.","The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.","The number of retries to execute upon failure to proxy.","An optional set of strings associated with the Service for grouping and filtering.",{"type":"107"},"Whether to enable verification of upstream server TLS certificate. If set to `null`, then the Nginx default is respected.","Maximum depth of chain while verifying Upstream server's TLS certificate. If set to `null`, then the Nginx default is respected.","Unix epoch when the resource was last updated.","Helper field to set `protocol`, `host`, `port` and `path` using a URL. This field is write-only and is not returned in responses.","The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.","No API key found in request","my-service","example.com","/some_api",["288"],{"id":"289"},["289"],"9748f662-7711-4a90-8186-dc02f10eb0f5",["288","290"],{"id":"289"},["289","291"],"The service name.\n",["247"],"The number of retries to execute upon failure to proxy. Default:`5`.\n",[5],"The protocol used to communicate with the upstream. Accepted values are: \"`grpc`\", \"`grpcs`\", \"`http`\", \"`https`\", \"`tcp`\", \"`tls`\", \"`tls_passthrough`\", \"`udp`\", \"`ws`\"\n, \"`wss`\"\n. Default: \"`http`\".",["292","293","127","155","294","295","296","297","298","299"],["127"],"The host of the upstream server. Note that the host value is case sensitive.\n",["248"],"The upstream server port. Default: `80`.\n",[80],"The path to be used in requests to the upstream server.\n",["249"],"The timeout in milliseconds for establishing a connection to the upstream server. Default `60000`.",[6000],"The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. Default: `60000`.\n",[6000],"The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server. Default: `60000`.\n",[6000],"An optional set of strings associated with the service for grouping and filtering.\n",{"type":"107","examples":"300"},"Certificate to be used as client certificate while TLS handshaking to the upstream server. With form-encoded, the notation is `client_certificate.id=<client_certificate id>`. With JSON, use `\"client_certificate\":{\"id\":\"<client_certificate id>\"}`.",{"id":"301"},"Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.\n",["107","302"],"Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected. Default: null.\n",["303"],"Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream servers TLS certificate. If set to null when Nginx default is respected. With form-encoded, the notation is `ca_certificates[]=4e3ad2e4-0bc4-4638-8e34-c84a417ba39b&ca_certificates[]=51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515`. With JSON, use an array.",{"type":"107","examples":"304"},"Whether the service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404).",{"type":"107"},"user-level","4e3ad2e4-0bc4-4638-8e34-c84a417ba39b","low-priority","51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515","grpc","grpcs","tcp","tls ","tls_passthrough","udp","ws","wss",["288"],{"type":"107","examples":"305"},"null","respected",["289"],["289"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-service-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a Service in a workspace",["18"],"ad6852239e340","put","/{workspace}/services/{service_id_or_name}",["19"],{},"upsert-service-in-workspace","Create or Update Service using ID or name in a workspace.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Services",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"a17c4a94d4d31","177d82adbb205","200",[],["57"],"Successfully upserted Service","b75d80d0ebf0a","400",[],["58"],"Invalid Service","b74d80d0eb1d9","401",[],["59"],"Unauthorized","f7cba288b9681",["60"],"The request body for creating a new service entity.",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"101"},"dbc0c193ff520","workspace","simple",[],"Name or ID of workspace",{"type":"102","examples":"103","$schema":"104","x-stoplight":"105"},["106","107","108","109","110","111"],"56be0d9929612","service_id_or_name",["112"],"ID **or** name of the service to lookup",{"type":"102","examples":"113","$schema":"104","x-stoplight":"114"},["106","110","115","107","108","109","111"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121"},{"default":"122","description":"123","enum":"124"},"0eb28636df35a","application/json",["125"],[],{"description":"126","properties":"127","type":"128","title":"129","examples":"130"},"7d18ba18bbb11",[],[],{"type":"128","$schema":"104","x-stoplight":"131"},"2c2f61dd28e85",["132","133","134"],[],{"type":"128","properties":"135","required":"136","title":"137","$schema":"104","x-stoplight":"138"},"84db96f4555ed",["139"],[],{"type":"128","x-examples":"140","properties":"141","required":"142","$schema":"104","x-stoplight":"143"},"string",["144"],"http://json-schema.org/draft-07/schema#",{"id":"145"},"name","in","required","schema","description","title",{"id":"146","value":"147","key":"148"},["147"],{"id":"149"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["122","150"],{"id":"151","value":"152","key":"148"},"Service entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its `protocol`, `host`, `port` and `path` individually. Services are associated to routes (a Service can have many routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.",{"ca_certificates":"153","client_certificate":"154","connect_timeout":"155","created_at":"156","enabled":"157","host":"158","id":"159","name":"160","path":"161","port":"162","protocol":"163","read_timeout":"164","retries":"165","tags":"166","tls_verify":"167","tls_verify_depth":"168","updated_at":"169","url":"170","write_timeout":"171"},"object","Service",["152"],{"id":"172"},{"id":"173","key":"174","value":"175","summary":"176"},{"id":"177","key":"178","value":"179","summary":"180"},{"id":"181","key":"182","value":"183","summary":"184"},{"status":"185","message":"186"},["187","188"],"UnauthorizedError",{"id":"189"},{"id":"190","key":"191","value":"192"},{"Example 1":"193"},{"name":"194","retries":"195","protocol":"196","host":"197","port":"198","path":"199","connect_timeout":"200","write_timeout":"201","read_timeout":"202","tags":"203","client_certificate":"204","tls_verify":"205","tls_verify_depth":"206","ca_certificates":"207","enabled":"208"},["209","210","211","212"],{"id":"213"},"team-a","03518f5822028","c07d49d3dd1f4","test-service","default","96dc01bc3ec6c","https","85b7734809da4",{"host":"214","id":"215","name":"216","path":"118","port":80,"protocol":"122"},{"description":"217","items":"218","type":"219"},{"additionalProperties":false,"description":"220","properties":"221","type":"128"},{"default":60000,"description":"222","type":"223"},{"description":"224","type":"223"},{"default":true,"description":"225","type":"226"},{"description":"227","type":"102"},{"type":"102"},{"description":"228","type":"102"},{"description":"229","type":"102"},{"default":80,"description":"230","type":"223"},{"default":"122","description":"231","type":"102"},{"default":60000,"description":"232","type":"223"},{"default":5,"description":"233","type":"223"},{"description":"234","items":"235","type":"219"},{"description":"236","type":"226"},{"description":"237","type":"223"},{"description":"238","type":"223"},{"description":"239","type":"102"},{"default":60000,"description":"240","type":"223"},"0e3856258e945","7061df93c123c","DuplicateApiKey",{"message":"176","status":401},"Duplicate API key found","aca1a996c54cc","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","2805c67c8d931","NoAPIKey",{"message":"241","status":401},"No API key found",{"type":"223"},{"type":"102"},"status","message","470b68e5f0549","38e7735c63712","Example",{"name":"242","retries":5,"protocol":"122","host":"243","port":80,"path":"244","connect_timeout":6000,"write_timeout":6000,"read_timeout":6000,"tags":"245","client_certificate":"246","tls_verify":true,"tls_verify_depth":null,"ca_certificates":"247","enabled":true},{"id":"248","created_at":1422386534,"updated_at":1422386534,"name":"242","retries":5,"protocol":"122","host":"243","port":80,"path":"244","connect_timeout":60000,"write_timeout":60000,"read_timeout":60000,"tags":"249","client_certificate":"250","tls_verify":true,"tls_verify_depth":null,"ca_certificates":"251","enabled":true},{"type":"102","description":"252","examples":"253"},{"type":"223","description":"254","default":5,"examples":"255"},{"type":"102","description":"256","default":"122","enum":"257","examples":"258"},{"type":"102","description":"259","examples":"260"},{"type":"223","description":"261","default":80,"examples":"262"},{"type":"102","description":"263","examples":"264"},{"type":"223","description":"265","default":6000,"examples":"266"},{"type":"223","description":"267","default":6000,"examples":"268"},{"type":"223","description":"269","default":6000,"examples":"270"},{"type":"219","description":"271","items":"272"},{"type":"128","description":"273","properties":"274"},{"type":"226","description":"275","default":true},{"type":"276","description":"277","default":null,"examples":"278"},{"type":"219","description":"279","items":"280"},{"type":"226","default":true,"description":"281"},"protocol","host","port","enabled","793ad71c2cc6c","example.internal","49fd316e-c457-481c-9fc7-8079153e4f3c","example-service","Array of `CA Certificate` object UUIDs that are used to build the trust store while verifying upstream servers TLS certificate. If set to `null` when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).",{"type":"102"},"array","Certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"282"},"The timeout in milliseconds for establishing a connection to the upstream server.","integer","Unix epoch when the resource was created.","Whether the Service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404).","boolean","The host of the upstream server. Note that the host value is case sensitive.","The Service name.","The path to be used in requests to the upstream server.","The upstream server port.","The protocol used to communicate with the upstream.","The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.","The number of retries to execute upon failure to proxy.","An optional set of strings associated with the Service for grouping and filtering.",{"type":"102"},"Whether to enable verification of upstream server TLS certificate. If set to `null`, then the Nginx default is respected.","Maximum depth of chain while verifying Upstream server's TLS certificate. If set to `null`, then the Nginx default is respected.","Unix epoch when the resource was last updated.","Helper field to set `protocol`, `host`, `port` and `path` using a URL. This field is write-only and is not returned in responses.","The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.","No API key found in request","my-service","example.com","/some_api",["283"],{"id":"284"},["284"],"9748f662-7711-4a90-8186-dc02f10eb0f5",["283","285"],{"id":"284"},["284","286"],"The service name.\n",["242"],"The number of retries to execute upon failure to proxy. Default:`5`.\n",[5],"The protocol used to communicate with the upstream. Accepted values are: \"`grpc`\", \"`grpcs`\", \"`http`\", \"`https`\", \"`tcp`\", \"`tls`\", \"`tls_passthrough`\", \"`udp`\", \"`ws`\"\n, \"`wss`\"\n. Default: \"`http`\".",["287","288","122","150","289","290","291","292","293","294"],["122"],"The host of the upstream server. Note that the host value is case sensitive.\n",["243"],"The upstream server port. Default: `80`.\n",[80],"The path to be used in requests to the upstream server.\n",["244"],"The timeout in milliseconds for establishing a connection to the upstream server. Default `60000`.",[6000],"The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. Default: `60000`.\n",[6000],"The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server. Default: `60000`.\n",[6000],"An optional set of strings associated with the service for grouping and filtering.\n",{"type":"102","examples":"295"},"Certificate to be used as client certificate while TLS handshaking to the upstream server. With form-encoded, the notation is `client_certificate.id=<client_certificate id>`. With JSON, use `\"client_certificate\":{\"id\":\"<client_certificate id>\"}`.",{"id":"296"},"Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.\n",["102","297"],"Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected. Default: null.\n",["298"],"Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream servers TLS certificate. If set to null when Nginx default is respected. With form-encoded, the notation is `ca_certificates[]=4e3ad2e4-0bc4-4638-8e34-c84a417ba39b&ca_certificates[]=51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515`. With JSON, use an array.",{"type":"102","examples":"299"},"Whether the service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404).",{"type":"102"},"user-level","4e3ad2e4-0bc4-4638-8e34-c84a417ba39b","low-priority","51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515","grpc","grpcs","tcp","tls ","tls_passthrough","udp","ws","wss",["283"],{"type":"102","examples":"300"},"null","respected",["284"],["284"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-route",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all routes",["18"],"306525c57874b","get","/routes",["19"],{},"list-route","List all routes\n\nroute entities define rules to match client requests. Each route is associated with a service, and a service may have multiple routes associated to it. Every request matching a given route will be proxied to its associated service.\n\nNote: Path handling algorithms v1 was deprecated in Kong 3.0. From Kong 3.0, when router_flavor is set to expressions, route.path_handling will be unconfigurable and the path handling behavior will be \"v0\"; when router_flavor is set to traditional_compatible, the path handling behavior will be \"v0\" regardless of the value of route.path_handling. Only router_flavor = traditional will support path_handling \"v1' behavior.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Routes",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40","41"],[],[],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"062e7c14e65ff","05bbac3aca79e","200",[],["48"],"A successful response listing routes","386bab9233dc6","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","key":"70","extensions":"71","description":"72","type":"73","name":"74","in":"75"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"76","path":"77","port":"78","protocol":"79"},{"id":"80","mediaType":"81","examples":"82","encodings":"83","schema":"84"},{"id":"85","mediaType":"81","examples":"86","encodings":"87","schema":"88"},"1c6abd34f7216","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96"],"3bc49603c7a9f","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"97","$schema":"90","x-stoplight":"98"},["92","93","94","95","96"],"fb8a4d31baa08","tags",["99"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"97","examples":"100","x-stoplight":"101","$schema":"90"},["92","102","93","94","95","96"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"103","description":"104"},{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110","enum":"111"},"1dd7baa30c8b4","application/json",[],[],{"properties":"112","$schema":"90","x-stoplight":"113"},"20a6c2b34d86f",["114","115","116"],[],{"type":"117","properties":"118","required":"119","title":"120","$schema":"90","x-stoplight":"121"},"integer","http://json-schema.org/draft-07/schema#",{"id":"122"},"description","in","name","schema","title","string",{"id":"123"},{"id":"124","value":"125","key":"126"},["125"],{"explicitProperties":"127","id":"128"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["109","129"],{"data":"130","offset":"131"},{"id":"132"},{"id":"133","key":"134","value":"135","summary":"136"},{"id":"137","key":"138","value":"139","summary":"140"},{"id":"141","key":"142","value":"143","summary":"144"},"object",{"status":"145","message":"146"},["147","148"],"UnauthorizedError",{"id":"149"},"bd8362341a9cc","23daa77957add","4f1573f72b534","tag1,tag2","default",["150","151","152"],"4175559ee3687","https",{"items":"153","type":"154"},{"description":"155","type":"97","title":"156"},"84277df5f288d","ace753889146a","DuplicateApiKey",{"message":"136","status":401},"Duplicate API key found","055395cc63157","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","7d27fc0203b72","NoAPIKey",{"message":"157","status":401},"No API key found",{"type":"89"},{"type":"97"},"status","message","470b68e5f0549","type","nullable","examples",{"description":"158","properties":"159","type":"117","title":"160","examples":"161"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","No API key found in request","Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"162","destinations":"163","headers":"164","hosts":"165","https_redirect_status_code":"166","id":"167","methods":"168","name":"169","path_handling":"170","paths":"171","preserve_host":"172","protocols":"173","regex_priority":"174","request_buffering":"175","response_buffering":"176","service":"177","expression":"178","priority":"179","snis":"180","sources":"181","strip_path":"182","tags":"183","updated_at":"184"},"Route",["185"],{"description":"186","type":"89"},{"description":"187","items":"188","type":"154"},{"description":"189","type":"117"},{"description":"190","items":"191","type":"154"},{"default":426,"description":"192","type":"89"},{"type":"97"},{"description":"193","items":"194","type":"154"},{"description":"195","type":"97"},{"default":"196","description":"197","type":"97"},{"description":"198","items":"199","type":"154"},{"default":false,"description":"200","type":"201"},{"default":"202","description":"203","items":"204","type":"154"},{"default":0,"description":"205","type":"89"},{"default":true,"description":"206","type":"201"},{"default":true,"description":"207","type":"201"},{"additionalProperties":false,"description":"208","properties":"209","type":"117"},{"description":"210","type":"97"},{"description":"211","type":"89","default":0},{"description":"212","items":"213","type":"154"},{"description":"214","items":"215","type":"154"},{"default":true,"description":"216","type":"201"},{"description":"217","items":"218","type":"154"},{"description":"219","type":"89"},{"hosts":"220","id":"221","name":"222","paths":"223","service":"224"},"Unix epoch when the resource was created.","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"225","type":"117"},"One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"97"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"97"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"97"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["109","129"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"97"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"226"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"97"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"227","type":"117"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"97"},"Unix epoch when the resource was last updated.",["228","229"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["230","231"],{"id":"232"},{"default":"233"},{"type":"97"},{"default":"234"},"foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{},{}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-route",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new route",["17"],"2d3a4df9799a2","post","/routes",["18"],{},"create-route","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Routes",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],[],["48"],{"id":"49","url":"50","name":"51","description":"52","variables":"53"},"062e7c14e65ff","0b44133507c25","200",[],["54"],"Successfully created route","b3241158453a0","400",[],["55"],"Invalid route","b334115845273","401",[],["56"],"Unauthorized","a340c05f68cf5",["57"],"Route request body",{"id":"58","key":"59","extensions":"60","description":"61","type":"62","name":"63","in":"64"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"65","path":"66","port":"67","protocol":"68"},{"id":"69","mediaType":"70","examples":"71","encodings":"72","schema":"73"},{"id":"74","mediaType":"70","examples":"75","encodings":"76","schema":"77"},{"id":"78","mediaType":"70","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"70","examples":"83","encodings":"84","schema":"85"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"86","description":"87"},{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93","enum":"94"},"1daed6b1eab46","application/json",["95"],[],{"description":"96","properties":"97","type":"98","title":"99","examples":"100"},"15b948e2f75ee",[],[],{"type":"98","$schema":"101","x-stoplight":"102"},"55982362ab1ab",["103","104","105"],[],{"type":"98","properties":"106","required":"107","title":"108","$schema":"101","x-stoplight":"109"},"7b68b5b76b643",["110"],[],{"type":"98","x-examples":"111","properties":"112","required":"113","$schema":"101","x-stoplight":"114"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["92","115"],{"id":"116","value":"117","key":"118"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"119","destinations":"120","headers":"121","hosts":"122","https_redirect_status_code":"123","id":"124","methods":"125","name":"126","path_handling":"127","paths":"128","preserve_host":"129","protocols":"130","regex_priority":"131","request_buffering":"132","response_buffering":"133","service":"134","expression":"135","priority":"136","snis":"137","sources":"138","strip_path":"139","tags":"140","updated_at":"141"},"object","Route",["117"],"http://json-schema.org/draft-07/schema#",{"id":"142"},{"id":"143","key":"144","value":"145","summary":"146"},{"id":"147","key":"148","value":"149","summary":"150"},{"id":"151","key":"152","value":"153","summary":"154"},{"status":"155","message":"156"},["157","158"],"UnauthorizedError",{"id":"159"},{"id":"160","key":"161","value":"162"},{"Example 1":"163"},{"name":"164","protocols":"165","methods":"166","hosts":"167","paths":"168","headers":"169","https_redirect_status_code":"170","regex_priority":"171","strip_path":"172","path_handling":"173","preserve_host":"174","request_buffering":"175","response_buffering":"176","snis":"177","sources":"178","destinations":"179","tags":"180","service":"181"},["182","183","184","185","186"],{"id":"187"},"https","9fc3c93f8e597",{"hosts":"188","id":"189","name":"190","paths":"191","service":"192"},"default",{"description":"193","type":"194"},{"description":"195","items":"196","type":"197"},{"description":"198","type":"98"},{"description":"199","items":"200","type":"197"},{"default":426,"description":"201","type":"194"},{"type":"202"},{"description":"203","items":"204","type":"197"},{"description":"205","type":"202"},{"default":"206","description":"207","type":"202"},{"description":"208","items":"209","type":"197"},{"default":false,"description":"210","type":"211"},{"default":"212","description":"213","items":"214","type":"197"},{"default":0,"description":"215","type":"194"},{"default":true,"description":"216","type":"211"},{"default":true,"description":"217","type":"211"},{"additionalProperties":false,"description":"218","properties":"219","type":"98"},{"description":"220","type":"202"},{"description":"221","type":"194","default":0},{"description":"222","items":"223","type":"197"},{"description":"224","items":"225","type":"197"},{"default":true,"description":"226","type":"211"},{"description":"227","items":"228","type":"197"},{"description":"229","type":"194"},"ba14f7807016f","e31b3f27c6b0a","DuplicateApiKey",{"message":"146","status":401},"Duplicate API key found","bb43672a7e853","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","47fd82e9a1eb7","NoAPIKey",{"message":"230","status":401},"No API key found",{"type":"194"},{"type":"202"},"status","message","470b68e5f0549","60bd5aa6bdb2f","Create a route",{"name":"231","protocols":"232","methods":"233","hosts":"234","paths":"235","headers":"236","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"206","preserve_host":false,"request_buffering":true,"response_buffering":true,"tags":"237","service":"238"},{"name":"231","protocols":"239","methods":"240","hosts":"241","paths":"242","headers":"243","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"206","preserve_host":false,"request_buffering":true,"response_buffering":true,"snis":"244","sources":"245","destinations":"246","tags":"247","service":"248"},{"type":"202","description":"249"},{"type":"197","description":"250","items":"251"},{"type":"197","description":"252","items":"253"},{"type":"197","description":"254","items":"255"},{"type":"197","description":"256","items":"257"},{"type":"98","description":"258","properties":"259"},{"type":"194","description":"260","default":426,"enum":"261","examples":"262"},{"type":"194","description":"263","default":0,"examples":"264"},{"type":"211","description":"265","default":true},{"type":"202","description":"266","enum":"267","examples":"268"},{"type":"211","description":"269","default":true},{"type":"211","default":true,"description":"270"},{"type":"211","default":true,"description":"271"},{"type":"197","description":"272","items":"273"},{"type":"197","description":"274","items":"275"},{"type":"197","description":"276","items":"277"},{"type":"197","description":"278","items":"279"},{"type":"280","description":"281","properties":"282"},"protocols","https_redirect_status_code","preserve_host","request_buffering","response_buffering","8d186f937045e",["283","284"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["285","286"],{"id":"287"},"Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"288","type":"98"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"202"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","string","A list of HTTP methods that match this Route.",{"type":"202"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"202"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["92","115"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"202"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"289"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"202"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"290","type":"98"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"202"},"Unix epoch when the resource was last updated.","No API key found in request","my-route",["92","115"],["291","292"],["293","294"],["295","296"],{"x-my-header":"297","x-another-header":"298"},["299","300"],{"id":"301"},["92","115"],["291","292"],["293","294"],["295","296"],{"x-my-header":"302","x-another-header":"303"},["294","293"],["304","305","306"],["307","308","309"],["299","300"],{"id":"301"},"The name of the route. Route names must be unique, and they are case sensitive. For example, there can be two different routes named \"test\" and \"Test\".\n","An array of the protocols this route should allow",{"type":"202","default":"115","examples":"310"},"A list of HTTP methods that match this route.\n",{"type":"202","examples":"311"},"A list of domain names that match this route. Note that the hosts value is case sensitive. With form-encoded, the notation is `hosts[]=example.com&hosts[]=foo.test`. With JSON, use an Array.",{"type":"202"},"A list of paths that match this route. With form-encoded, the notation is `paths[]=/foo&paths[]=/bar`. With JSON, use an array. The path can be a regular expression, or a plain text pattern.",{"type":"202"},"One or more lists of values indexed by header name that will cause this route to match if present in the request. The Host header cannot be used with this attribute hosts should be specified using the `hosts` attribute. When headers contains only one value and that value starts with the special prefix` ~*`, the value is interpreted as a regular expression.",{"x-my-header":"312","x-another-header":"313"},"The status code Kong responds with when all properties of a route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`\nLocation header is injected by Kong if the field is set to `301`, `302`, `307` or `308`. Note: This config applies only if the route is configured to only accept the https protocol. Accepted values are: `426`, `301`, `302`, `307`, `308`. Default: `426`.",[426,301,302,307,308],[426],"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).",[0],"When matching a route via one of the paths, strip the matching prefix from the upstream request URL.","Controls how the service path, route path and requested path are combined when sending a request to the upstream. Accepted values are \"`v0`\", \"`v1`\".",["314","206"],["206"],"When matching a route via one of the `hosts` domain names, use the request `host` header in the upstream request headers. If set to `false`, the upstream Host header will be that of the service's host.","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding. Default: true.\n","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding. Default: `true`.\n","A list of SNIs that match this route when using stream routing.\n",{"type":"202"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"98","properties":"315"},"A list of IP destinations of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"98","properties":"316"},"An optional set of strings associated with the route for grouping and filtering.\n",{"type":"202"},["98","317"],"The service this route is associated to. This is where the route proxies traffic to. With form-encoded, the notation is service.id=<service id> or service.name=<service name>. With JSON, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",{"id":"318"},"foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"319"},{"type":"202"},{"default":"320"},"GET","POST","example.com","foo.test","/foo","/bar",["321","322"],["323"],"user-level","low-priority","af8330d3-dbdc-48bd-b1be-55b98608834b",["321","322"],["323"],{"ip":"324","port":1234},{"ip":"325"},{"port":9123},{"ip":"324","port":1234},{"ip":"325"},{"port":9123},["326"],["291"],{"type":"197","items":"327"},{"type":"197","items":"328"},"v1",{"ip":"329","port":"330"},{"ip":"331","port":"332"},"null",{"type":"202","examples":"333"},{},{},"foo","bar","bla","10.1.0.0/16","10.2.2.2","tcp",{"type":"202"},{"type":"202"},{"type":"202","examples":"334"},{"type":"194","examples":"335"},{"type":"202","examples":"336"},{"type":"194"},["301"],["324"],[1234],["337"],"0.1.0.0/16"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-route",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a route",["17"],"f6f27cd62e45d","delete","/routes/{route_id_or_name}",["18"],{},"delete-route","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Routes",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38"],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"062e7c14e65ff","50a0c519a74d6","204",[],[],"Successfully deleted route or the resource didn't exist","28b0c353fe2b4","401",[],["45"],"Unauthorized",{"id":"46","name":"47","style":"48","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},{"id":"64","mediaType":"65","examples":"66","encodings":"67","schema":"68"},"e8c8e183c11e9","route_id_or_name","simple",[],"The unique identifier or the name of the route to retrieve.",{"type":"69","examples":"70","$schema":"71","x-stoplight":"72"},["73","74","75","76","77","78"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86","enum":"87"},"2a03e4639ce3e","application/json",["88","89","90"],[],{"type":"91","properties":"92","required":"93","title":"94","$schema":"71","x-stoplight":"95"},"string",["96"],"http://json-schema.org/draft-07/schema#",{"id":"97"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["85","98"],{"id":"99","key":"100","value":"101","summary":"102"},{"id":"103","key":"104","value":"105","summary":"106"},{"id":"107","key":"108","value":"109","summary":"110"},"object",{"status":"111","message":"112"},["113","114"],"UnauthorizedError",{"id":"115"},"my-route","e70efa6b119dd","https","3734bdcbff755","DuplicateApiKey",{"message":"102","status":401},"Duplicate API key found","8fa1000fd163d","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","99549cd7d8127","NoAPIKey",{"message":"116","status":401},"No API key found",{"type":"117"},{"type":"69"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-route",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a route",["18"],"e74a0d86cfb71","get","/routes/{route_id_or_name}",["19"],{},"get-route","Get a route using ID or name.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Routes",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45"],["46"],{"id":"47","url":"48","name":"49","description":"50","variables":"51"},"062e7c14e65ff","f8203ef1f434e","200",[],["52"],"Successfully fetched route","8d703f8364743","401",[],["53"],"Unauthorized","8d403f836427c","404",[],[],"Resource does not exist",{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},{"id":"77","mediaType":"73","examples":"78","encodings":"79","schema":"80"},"b7cbf6cb20a37","route_id_or_name","simple",[],"The unique identifier or the name of the route to retrieve.",{"type":"81","examples":"82","$schema":"83","x-stoplight":"84"},["85","86","87","88","89","90"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"9e73825470676","application/json",["100"],[],{"description":"101","properties":"102","type":"103","title":"104","examples":"105"},"582b9f5d57328",["106","107","108"],[],{"type":"103","properties":"109","required":"110","title":"111","$schema":"83","x-stoplight":"112"},"string",["113"],"http://json-schema.org/draft-07/schema#",{"id":"114"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","115"],{"id":"116","value":"117","key":"118"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"119","destinations":"120","headers":"121","hosts":"122","https_redirect_status_code":"123","id":"124","methods":"125","name":"126","path_handling":"127","paths":"128","preserve_host":"129","protocols":"130","regex_priority":"131","request_buffering":"132","response_buffering":"133","service":"134","expression":"135","priority":"136","snis":"137","sources":"138","strip_path":"139","tags":"140","updated_at":"141"},"object","Route",["117"],{"id":"142","key":"143","value":"144","summary":"145"},{"id":"146","key":"147","value":"148","summary":"149"},{"id":"150","key":"151","value":"152","summary":"153"},{"status":"154","message":"155"},["156","157"],"UnauthorizedError",{"id":"158"},"my-route","09317fe53f199","https","717931ad1a150",{"hosts":"159","id":"160","name":"161","paths":"162","service":"163"},"default",{"description":"164","type":"165"},{"description":"166","items":"167","type":"168"},{"description":"169","type":"103"},{"description":"170","items":"171","type":"168"},{"default":426,"description":"172","type":"165"},{"type":"81"},{"description":"173","items":"174","type":"168"},{"description":"175","type":"81"},{"default":"176","description":"177","type":"81"},{"description":"178","items":"179","type":"168"},{"default":false,"description":"180","type":"181"},{"default":"182","description":"183","items":"184","type":"168"},{"default":0,"description":"185","type":"165"},{"default":true,"description":"186","type":"181"},{"default":true,"description":"187","type":"181"},{"additionalProperties":false,"description":"188","properties":"189","type":"103"},{"description":"190","type":"81"},{"description":"191","type":"165","default":0},{"description":"192","items":"193","type":"168"},{"description":"194","items":"195","type":"168"},{"default":true,"description":"196","type":"181"},{"description":"197","items":"198","type":"168"},{"description":"199","type":"165"},"1f371872f015e","DuplicateApiKey",{"message":"145","status":401},"Duplicate API key found","73fcc4521a183","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","bf3d218aafaa8","NoAPIKey",{"message":"200","status":401},"No API key found",{"type":"165"},{"type":"81"},"status","message","470b68e5f0549",["201","202"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["203","204"],{"id":"205"},"Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"206","type":"103"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"81"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"81"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"81"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["97","115"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"81"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"207"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"81"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"208","type":"103"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"81"},"Unix epoch when the resource was last updated.","No API key found in request","foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"209"},{"type":"81"},{"default":"210"},{},{}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-route",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update a route",["17"],"05960ed318e3a","patch","/routes/{route_id_or_name}",["18"],{},"update-route","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Routes",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54"],["55"],{"id":"56","url":"57","name":"58","description":"59","variables":"60"},"062e7c14e65ff","1ce02a189ca8a","200",[],["61"],"Successfully updated route","f4c02852f3ff0","400",[],["62"],"Invalid route","f4b02852f3943","401",[],["63"],"Unauthorized","f5002852f36cc","404",[],[],"Resource does not exist","5333c4b710767",["64"],"Route request body",{"id":"65","name":"66","style":"67","examples":"68","description":"69","required":true,"schema":"70","explicitProperties":"71"},{"id":"72","key":"73","extensions":"74","description":"75","type":"76","name":"77","in":"78"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"79","path":"80","port":"81","protocol":"82"},{"id":"83","mediaType":"84","examples":"85","encodings":"86","schema":"87"},{"id":"88","mediaType":"84","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"84","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"84","examples":"97","encodings":"98","schema":"99"},"127546fa2882a","route_id_or_name","simple",[],"The unique identifier or the name of the route to retrieve.",{"type":"100","examples":"101","$schema":"102","x-stoplight":"103"},["104","105","106","107","108","109"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"110","description":"111"},{"default":"112","description":"113"},{"default":"114","description":"115"},{"default":"116","description":"117","enum":"118"},"719a0b82c24c7","application/json",["119"],[],{"description":"120","properties":"121","type":"122","title":"123","examples":"124"},"a8d09352151a9",[],[],{"type":"122","$schema":"102","x-stoplight":"125"},"0d5c25efa8dea",["126","127","128"],[],{"type":"122","properties":"129","required":"130","title":"131","$schema":"102","x-stoplight":"132"},"7affe8e0c6200",["133"],[],{"type":"122","x-examples":"134","properties":"135","required":"136","$schema":"102","x-stoplight":"137"},"string",["138"],"http://json-schema.org/draft-07/schema#",{"id":"139"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["116","140"],{"id":"141","value":"142","key":"143"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"144","destinations":"145","headers":"146","hosts":"147","https_redirect_status_code":"148","id":"149","methods":"150","name":"151","path_handling":"152","paths":"153","preserve_host":"154","protocols":"155","regex_priority":"156","request_buffering":"157","response_buffering":"158","service":"159","expression":"160","priority":"161","snis":"162","sources":"163","strip_path":"164","tags":"165","updated_at":"166"},"object","Route",["142"],{"id":"167"},{"id":"168","key":"169","value":"170","summary":"171"},{"id":"172","key":"173","value":"174","summary":"175"},{"id":"176","key":"177","value":"178","summary":"179"},{"status":"180","message":"181"},["182","183"],"UnauthorizedError",{"id":"184"},{"id":"185","key":"186","value":"187"},{"Example 1":"188"},{"name":"189","protocols":"190","methods":"191","hosts":"192","paths":"193","headers":"194","https_redirect_status_code":"195","regex_priority":"196","strip_path":"197","path_handling":"198","preserve_host":"199","request_buffering":"200","response_buffering":"201","snis":"202","sources":"203","destinations":"204","tags":"205","service":"206"},["207","208","209","210","211"],{"id":"212"},"my-route","82b2190e5f220","https","e9fbb6de40ad2",{"hosts":"213","id":"214","name":"215","paths":"216","service":"217"},"default",{"description":"218","type":"219"},{"description":"220","items":"221","type":"222"},{"description":"223","type":"122"},{"description":"224","items":"225","type":"222"},{"default":426,"description":"226","type":"219"},{"type":"100"},{"description":"227","items":"228","type":"222"},{"description":"229","type":"100"},{"default":"230","description":"231","type":"100"},{"description":"232","items":"233","type":"222"},{"default":false,"description":"234","type":"235"},{"default":"236","description":"237","items":"238","type":"222"},{"default":0,"description":"239","type":"219"},{"default":true,"description":"240","type":"235"},{"default":true,"description":"241","type":"235"},{"additionalProperties":false,"description":"242","properties":"243","type":"122"},{"description":"244","type":"100"},{"description":"245","type":"219","default":0},{"description":"246","items":"247","type":"222"},{"description":"248","items":"249","type":"222"},{"default":true,"description":"250","type":"235"},{"description":"251","items":"252","type":"222"},{"description":"253","type":"219"},"2eaeb5337f0dc","a28cc6efa485f","DuplicateApiKey",{"message":"171","status":401},"Duplicate API key found","af1bbb9b19bd7","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","cf5d8b9bd07a6","NoAPIKey",{"message":"254","status":401},"No API key found",{"type":"219"},{"type":"100"},"status","message","470b68e5f0549","b1bfe7d3a9589","Create a route",{"name":"138","protocols":"255","methods":"256","hosts":"257","paths":"258","headers":"259","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"230","preserve_host":false,"request_buffering":true,"response_buffering":true,"tags":"260","service":"261"},{"name":"138","protocols":"262","methods":"263","hosts":"264","paths":"265","headers":"266","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"230","preserve_host":false,"request_buffering":true,"response_buffering":true,"snis":"267","sources":"268","destinations":"269","tags":"270","service":"271"},{"type":"100","description":"272"},{"type":"222","description":"273","items":"274"},{"type":"222","description":"275","items":"276"},{"type":"222","description":"277","items":"278"},{"type":"222","description":"279","items":"280"},{"type":"122","description":"281","properties":"282"},{"type":"219","description":"283","default":426,"enum":"284","examples":"285"},{"type":"219","description":"286","default":0,"examples":"287"},{"type":"235","description":"288","default":true},{"type":"100","description":"289","enum":"290","examples":"291"},{"type":"235","description":"292","default":true},{"type":"235","default":true,"description":"293"},{"type":"235","default":true,"description":"294"},{"type":"222","description":"295","items":"296"},{"type":"222","description":"297","items":"298"},{"type":"222","description":"299","items":"300"},{"type":"222","description":"301","items":"302"},{"type":"303","description":"304","properties":"305"},"protocols","https_redirect_status_code","preserve_host","request_buffering","response_buffering","8d186f937045e",["306","307"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["308","309"],{"id":"310"},"Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"311","type":"122"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"100"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"100"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"100"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["116","140"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"100"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"312"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"100"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"313","type":"122"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"100"},"Unix epoch when the resource was last updated.","No API key found in request",["116","140"],["314","315"],["316","317"],["318","319"],{"x-my-header":"320","x-another-header":"321"},["322","323"],{"id":"324"},["116","140"],["314","315"],["316","317"],["318","319"],{"x-my-header":"325","x-another-header":"326"},["317","316"],["327","328","329"],["330","331","332"],["322","323"],{"id":"324"},"The name of the route. Route names must be unique, and they are case sensitive. For example, there can be two different routes named \"test\" and \"Test\".\n","An array of the protocols this route should allow",{"type":"100","default":"140","examples":"333"},"A list of HTTP methods that match this route.\n",{"type":"100","examples":"334"},"A list of domain names that match this route. Note that the hosts value is case sensitive. With form-encoded, the notation is `hosts[]=example.com&hosts[]=foo.test`. With JSON, use an Array.",{"type":"100"},"A list of paths that match this route. With form-encoded, the notation is `paths[]=/foo&paths[]=/bar`. With JSON, use an array. The path can be a regular expression, or a plain text pattern.",{"type":"100"},"One or more lists of values indexed by header name that will cause this route to match if present in the request. The Host header cannot be used with this attribute hosts should be specified using the `hosts` attribute. When headers contains only one value and that value starts with the special prefix` ~*`, the value is interpreted as a regular expression.",{"x-my-header":"335","x-another-header":"336"},"The status code Kong responds with when all properties of a route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`\nLocation header is injected by Kong if the field is set to `301`, `302`, `307` or `308`. Note: This config applies only if the route is configured to only accept the https protocol. Accepted values are: `426`, `301`, `302`, `307`, `308`. Default: `426`.",[426,301,302,307,308],[426],"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).",[0],"When matching a route via one of the paths, strip the matching prefix from the upstream request URL.","Controls how the service path, route path and requested path are combined when sending a request to the upstream. Accepted values are \"`v0`\", \"`v1`\".",["337","230"],["230"],"When matching a route via one of the `hosts` domain names, use the request `host` header in the upstream request headers. If set to `false`, the upstream Host header will be that of the service's host.","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding. Default: true.\n","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding. Default: `true`.\n","A list of SNIs that match this route when using stream routing.\n",{"type":"100"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"122","properties":"338"},"A list of IP destinations of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"122","properties":"339"},"An optional set of strings associated with the route for grouping and filtering.\n",{"type":"100"},["122","340"],"The service this route is associated to. This is where the route proxies traffic to. With form-encoded, the notation is service.id=<service id> or service.name=<service name>. With JSON, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",{"id":"341"},"foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"342"},{"type":"100"},{"default":"343"},"GET","POST","example.com","foo.test","/foo","/bar",["344","345"],["346"],"user-level","low-priority","af8330d3-dbdc-48bd-b1be-55b98608834b",["344","345"],["346"],{"ip":"347","port":1234},{"ip":"348"},{"port":9123},{"ip":"347","port":1234},{"ip":"348"},{"port":9123},["349"],["314"],{"type":"222","items":"350"},{"type":"222","items":"351"},"v1",{"ip":"352","port":"353"},{"ip":"354","port":"355"},"null",{"type":"100","examples":"356"},{},{},"foo","bar","bla","10.1.0.0/16","10.2.2.2","tcp",{"type":"100"},{"type":"100"},{"type":"100","examples":"357"},{"type":"219","examples":"358"},{"type":"100","examples":"359"},{"type":"219"},["324"],["347"],[1234],["360"],"0.1.0.0/16"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-route",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a route",["18"],"3b72080f68e7d","put","/routes/{route_id_or_name}",["19"],{},"upsert-route","Create or update a route using ID or name.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Routes",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"062e7c14e65ff","ae34b21aef427","200",[],["56"],"Successfully upserted route","0e54b3f7bf12e","400",[],["57"],"Invalid route","0e44b3f7bf099","401",[],["58"],"Unauthorized","83a7dedeff453",["59"],"Route request body",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"79","examples":"84","encodings":"85","schema":"86"},{"id":"87","mediaType":"79","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"79","examples":"92","encodings":"93","schema":"94"},"f844b55ca6149","route_id_or_name","simple",[],"The unique identifier or the name of the route to retrieve.",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110"},{"default":"111","description":"112","enum":"113"},"409b267385089","application/json",["114"],[],{"description":"115","properties":"116","type":"117","title":"118","examples":"119"},"8fbe9453c726e",[],[],{"type":"117","$schema":"97","x-stoplight":"120"},"fafbf84c5b2c6",["121","122","123"],[],{"type":"117","properties":"124","required":"125","title":"126","$schema":"97","x-stoplight":"127"},"e75797fc940ec",["128"],[],{"type":"117","x-examples":"129","properties":"130","required":"131","$schema":"97","x-stoplight":"132"},"string",["133"],"http://json-schema.org/draft-07/schema#",{"id":"134"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["111","135"],{"id":"136","value":"137","key":"138"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"139","destinations":"140","headers":"141","hosts":"142","https_redirect_status_code":"143","id":"144","methods":"145","name":"146","path_handling":"147","paths":"148","preserve_host":"149","protocols":"150","regex_priority":"151","request_buffering":"152","response_buffering":"153","service":"154","expression":"155","priority":"156","snis":"157","sources":"158","strip_path":"159","tags":"160","updated_at":"161"},"object","Route",["137"],{"id":"162"},{"id":"163","key":"164","value":"165","summary":"166"},{"id":"167","key":"168","value":"169","summary":"170"},{"id":"171","key":"172","value":"173","summary":"174"},{"status":"175","message":"176"},["177","178"],"UnauthorizedError",{"id":"179"},{"id":"180","key":"181","value":"182"},{"Example 1":"183"},{"name":"184","protocols":"185","methods":"186","hosts":"187","paths":"188","headers":"189","https_redirect_status_code":"190","regex_priority":"191","strip_path":"192","path_handling":"193","preserve_host":"194","request_buffering":"195","response_buffering":"196","snis":"197","sources":"198","destinations":"199","tags":"200","service":"201"},["202","203","204","205","206"],{"id":"207"},"my-route","9593de0fb983e","https","f006cf0677934",{"hosts":"208","id":"209","name":"210","paths":"211","service":"212"},"default",{"description":"213","type":"214"},{"description":"215","items":"216","type":"217"},{"description":"218","type":"117"},{"description":"219","items":"220","type":"217"},{"default":426,"description":"221","type":"214"},{"type":"95"},{"description":"222","items":"223","type":"217"},{"description":"224","type":"95"},{"default":"225","description":"226","type":"95"},{"description":"227","items":"228","type":"217"},{"default":false,"description":"229","type":"230"},{"default":"231","description":"232","items":"233","type":"217"},{"default":0,"description":"234","type":"214"},{"default":true,"description":"235","type":"230"},{"default":true,"description":"236","type":"230"},{"additionalProperties":false,"description":"237","properties":"238","type":"117"},{"description":"239","type":"95"},{"description":"240","type":"214","default":0},{"description":"241","items":"242","type":"217"},{"description":"243","items":"244","type":"217"},{"default":true,"description":"245","type":"230"},{"description":"246","items":"247","type":"217"},{"description":"248","type":"214"},"07350ae272eb3","240a29f61f787","DuplicateApiKey",{"message":"166","status":401},"Duplicate API key found","625488e0f5ba7","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","9355d89badaec","NoAPIKey",{"message":"249","status":401},"No API key found",{"type":"214"},{"type":"95"},"status","message","470b68e5f0549","06f37eafffa69","Create a route",{"name":"133","protocols":"250","methods":"251","hosts":"252","paths":"253","headers":"254","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"225","preserve_host":false,"request_buffering":true,"response_buffering":true,"tags":"255","service":"256"},{"name":"133","protocols":"257","methods":"258","hosts":"259","paths":"260","headers":"261","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"225","preserve_host":false,"request_buffering":true,"response_buffering":true,"snis":"262","sources":"263","destinations":"264","tags":"265","service":"266"},{"type":"95","description":"267"},{"type":"217","description":"268","items":"269"},{"type":"217","description":"270","items":"271"},{"type":"217","description":"272","items":"273"},{"type":"217","description":"274","items":"275"},{"type":"117","description":"276","properties":"277"},{"type":"214","description":"278","default":426,"enum":"279","examples":"280"},{"type":"214","description":"281","default":0,"examples":"282"},{"type":"230","description":"283","default":true},{"type":"95","description":"284","enum":"285","examples":"286"},{"type":"230","description":"287","default":true},{"type":"230","default":true,"description":"288"},{"type":"230","default":true,"description":"289"},{"type":"217","description":"290","items":"291"},{"type":"217","description":"292","items":"293"},{"type":"217","description":"294","items":"295"},{"type":"217","description":"296","items":"297"},{"type":"298","description":"299","properties":"300"},"protocols","https_redirect_status_code","preserve_host","request_buffering","response_buffering","8d186f937045e",["301","302"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["303","304"],{"id":"305"},"Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"306","type":"117"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"95"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"95"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"95"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["111","135"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"95"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"307"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"95"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"308","type":"117"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"95"},"Unix epoch when the resource was last updated.","No API key found in request",["111","135"],["309","310"],["311","312"],["313","314"],{"x-my-header":"315","x-another-header":"316"},["317","318"],{"id":"319"},["111","135"],["309","310"],["311","312"],["313","314"],{"x-my-header":"320","x-another-header":"321"},["312","311"],["322","323","324"],["325","326","327"],["317","318"],{"id":"319"},"The name of the route. Route names must be unique, and they are case sensitive. For example, there can be two different routes named \"test\" and \"Test\".\n","An array of the protocols this route should allow",{"type":"95","default":"135","examples":"328"},"A list of HTTP methods that match this route.\n",{"type":"95","examples":"329"},"A list of domain names that match this route. Note that the hosts value is case sensitive. With form-encoded, the notation is `hosts[]=example.com&hosts[]=foo.test`. With JSON, use an Array.",{"type":"95"},"A list of paths that match this route. With form-encoded, the notation is `paths[]=/foo&paths[]=/bar`. With JSON, use an array. The path can be a regular expression, or a plain text pattern.",{"type":"95"},"One or more lists of values indexed by header name that will cause this route to match if present in the request. The Host header cannot be used with this attribute hosts should be specified using the `hosts` attribute. When headers contains only one value and that value starts with the special prefix` ~*`, the value is interpreted as a regular expression.",{"x-my-header":"330","x-another-header":"331"},"The status code Kong responds with when all properties of a route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`\nLocation header is injected by Kong if the field is set to `301`, `302`, `307` or `308`. Note: This config applies only if the route is configured to only accept the https protocol. Accepted values are: `426`, `301`, `302`, `307`, `308`. Default: `426`.",[426,301,302,307,308],[426],"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).",[0],"When matching a route via one of the paths, strip the matching prefix from the upstream request URL.","Controls how the service path, route path and requested path are combined when sending a request to the upstream. Accepted values are \"`v0`\", \"`v1`\".",["332","225"],["225"],"When matching a route via one of the `hosts` domain names, use the request `host` header in the upstream request headers. If set to `false`, the upstream Host header will be that of the service's host.","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding. Default: true.\n","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding. Default: `true`.\n","A list of SNIs that match this route when using stream routing.\n",{"type":"95"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"117","properties":"333"},"A list of IP destinations of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"117","properties":"334"},"An optional set of strings associated with the route for grouping and filtering.\n",{"type":"95"},["117","335"],"The service this route is associated to. This is where the route proxies traffic to. With form-encoded, the notation is service.id=<service id> or service.name=<service name>. With JSON, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",{"id":"336"},"foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"337"},{"type":"95"},{"default":"338"},"GET","POST","example.com","foo.test","/foo","/bar",["339","340"],["341"],"user-level","low-priority","af8330d3-dbdc-48bd-b1be-55b98608834b",["339","340"],["341"],{"ip":"342","port":1234},{"ip":"343"},{"port":9123},{"ip":"342","port":1234},{"ip":"343"},{"port":9123},["344"],["309"],{"type":"217","items":"345"},{"type":"217","items":"346"},"v1",{"ip":"347","port":"348"},{"ip":"349","port":"350"},"null",{"type":"95","examples":"351"},{},{},"foo","bar","bla","10.1.0.0/16","10.2.2.2","tcp",{"type":"95"},{"type":"95"},{"type":"95","examples":"352"},{"type":"214","examples":"353"},{"type":"95","examples":"354"},{"type":"214"},["319"],["342"],[1234],["355"],"0.1.0.0/16"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-routes-with-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all routes associated with a Service",["17"],"54476262582bd","get","/services/{service_id_or_name}/routes",["18"],{},"list-routes-with-service","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Routes",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],["41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"062e7c14e65ff","df95e6f720487","200",[],["48"],"A successful response listing routes","1245e66b70e22","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"71","examples":"72","description":"73","required":true,"schema":"74","explicitProperties":"75"},{"id":"76","key":"77","extensions":"78","description":"79","type":"80","name":"81","in":"82"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"83","path":"84","port":"85","protocol":"86"},{"id":"87","mediaType":"88","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"88","examples":"93","encodings":"94","schema":"95"},"3d36951ddb52d","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103"],"07cf9be0830d0","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"104","$schema":"97","x-stoplight":"105"},["99","100","101","102","103"],"ae55ea4beabda","tags",["106"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"104","examples":"107","x-stoplight":"108","$schema":"97"},["99","109","100","101","102","103"],"efb9f8f96019e","service_id_or_name","simple",["110"],"ID **or** name of the service to lookup",{"type":"104","examples":"111","$schema":"97","x-stoplight":"112"},["101","99","109","100","113","102","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121","enum":"122"},"65252a78e10bd","application/json",[],[],{"properties":"123","$schema":"97","x-stoplight":"124"},"afd1b8f9bcf40",["125","126","127"],[],{"type":"128","properties":"129","required":"130","title":"131","$schema":"97","x-stoplight":"132"},"integer","http://json-schema.org/draft-07/schema#",{"id":"133"},"description","in","name","schema","title","string",{"id":"134"},{"id":"135","value":"136","key":"137"},["136"],{"explicitProperties":"138","id":"139"},"example",{"id":"140","value":"141","key":"137"},["141"],{"id":"142"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["120","143"],{"data":"144","offset":"145"},{"id":"146"},{"id":"147","key":"148","value":"149","summary":"150"},{"id":"151","key":"152","value":"153","summary":"154"},{"id":"155","key":"156","value":"157","summary":"158"},"object",{"status":"159","message":"160"},["161","162"],"UnauthorizedError",{"id":"163"},"a7374492cfbbe","d75b64088014b","e0ea58d62b566","tag1,tag2","default",["164","165","166"],"3796c5e90bafd","df1ccdf5a36a3","test-service","937d1d8702d76","https",{"items":"167","type":"168"},{"description":"169","type":"104","title":"170"},"1ff44c87a6103","63f018b1e064a","DuplicateApiKey",{"message":"150","status":401},"Duplicate API key found","d50c8b4d4ef3d","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","8bfdee7e5097a","NoAPIKey",{"message":"171","status":401},"No API key found",{"type":"96"},{"type":"104"},"status","message","470b68e5f0549","type","nullable","examples",{"description":"172","properties":"173","type":"128","title":"174","examples":"175"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","No API key found in request","Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"176","destinations":"177","headers":"178","hosts":"179","https_redirect_status_code":"180","id":"181","methods":"182","name":"183","path_handling":"184","paths":"185","preserve_host":"186","protocols":"187","regex_priority":"188","request_buffering":"189","response_buffering":"190","service":"191","expression":"192","priority":"193","snis":"194","sources":"195","strip_path":"196","tags":"197","updated_at":"198"},"Route",["199"],{"description":"200","type":"96"},{"description":"201","items":"202","type":"168"},{"description":"203","type":"128"},{"description":"204","items":"205","type":"168"},{"default":426,"description":"206","type":"96"},{"type":"104"},{"description":"207","items":"208","type":"168"},{"description":"209","type":"104"},{"default":"210","description":"211","type":"104"},{"description":"212","items":"213","type":"168"},{"default":false,"description":"214","type":"215"},{"default":"216","description":"217","items":"218","type":"168"},{"default":0,"description":"219","type":"96"},{"default":true,"description":"220","type":"215"},{"default":true,"description":"221","type":"215"},{"additionalProperties":false,"description":"222","properties":"223","type":"128"},{"description":"224","type":"104"},{"description":"225","type":"96","default":0},{"description":"226","items":"227","type":"168"},{"description":"228","items":"229","type":"168"},{"default":true,"description":"230","type":"215"},{"description":"231","items":"232","type":"168"},{"description":"233","type":"96"},{"hosts":"234","id":"235","name":"236","paths":"237","service":"238"},"Unix epoch when the resource was created.","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"239","type":"128"},"One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"104"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"104"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"104"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["120","143"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"104"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"240"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"104"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"241","type":"128"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"104"},"Unix epoch when the resource was last updated.",["242","243"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["244","245"],{"id":"246"},{"default":"247"},{"type":"104"},{"default":"248"},"foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{},{}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-route-with-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new route associated with a Service",["17"],"13eb86d79f9ad","post","/services/{service_id_or_name}/routes",["18"],{},"create-route-with-service","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Routes",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48"],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"062e7c14e65ff","77398fd11d89d","200",[],["55"],"Successfully created route","cf5991addf511","400",[],["56"],"Invalid route","cf6991addf4c6","401",[],["57"],"Unauthorized","164ad592b0a16",["58"],"Route request body",{"id":"59","name":"60","style":"61","examples":"62","description":"63","required":true,"schema":"64","explicitProperties":"65"},{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},{"id":"86","mediaType":"78","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"78","examples":"91","encodings":"92","schema":"93"},"037ac53a6c8d3","service_id_or_name","simple",["94"],"ID **or** name of the service to lookup",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104","105"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111"},{"default":"112","description":"113","enum":"114"},"dec3933bc8bd4","application/json",["115"],[],{"description":"116","properties":"117","type":"118","title":"119","examples":"120"},"f29784050da61",[],[],{"type":"118","$schema":"97","x-stoplight":"121"},"0f3798d2100f7",["122","123","124"],[],{"type":"118","properties":"125","required":"126","title":"127","$schema":"97","x-stoplight":"128"},"fda8390012b03",["129"],[],{"type":"118","x-examples":"130","properties":"131","required":"132","$schema":"97","x-stoplight":"133"},{"id":"134","value":"135","key":"136"},"string",["135"],"http://json-schema.org/draft-07/schema#",{"id":"137"},"name","description","example","in","required","schema","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["112","138"],{"id":"139","value":"140","key":"136"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"141","destinations":"142","headers":"143","hosts":"144","https_redirect_status_code":"145","id":"146","methods":"147","name":"148","path_handling":"149","paths":"150","preserve_host":"151","protocols":"152","regex_priority":"153","request_buffering":"154","response_buffering":"155","service":"156","expression":"157","priority":"158","snis":"159","sources":"160","strip_path":"161","tags":"162","updated_at":"163"},"object","Route",["140"],{"id":"164"},{"id":"165","key":"166","value":"167","summary":"168"},{"id":"169","key":"170","value":"171","summary":"172"},{"id":"173","key":"174","value":"175","summary":"176"},{"status":"177","message":"178"},["179","180"],"UnauthorizedError",{"id":"181"},{"id":"182","key":"183","value":"184"},{"Example 1":"185"},{"name":"186","protocols":"187","methods":"188","hosts":"189","paths":"190","headers":"191","https_redirect_status_code":"192","regex_priority":"193","strip_path":"194","path_handling":"195","preserve_host":"196","request_buffering":"197","response_buffering":"198","snis":"199","sources":"200","destinations":"201","tags":"202","service":"203"},["204","205","206","207","208"],{"id":"209"},"16095b832cdfd","test-service","default","086ca1f93f4ea","https","b77f320edeaf7",{"hosts":"210","id":"211","name":"212","paths":"213","service":"214"},{"description":"215","type":"216"},{"description":"217","items":"218","type":"219"},{"description":"220","type":"118"},{"description":"221","items":"222","type":"219"},{"default":426,"description":"223","type":"216"},{"type":"95"},{"description":"224","items":"225","type":"219"},{"description":"226","type":"95"},{"default":"227","description":"228","type":"95"},{"description":"229","items":"230","type":"219"},{"default":false,"description":"231","type":"232"},{"default":"233","description":"234","items":"235","type":"219"},{"default":0,"description":"236","type":"216"},{"default":true,"description":"237","type":"232"},{"default":true,"description":"238","type":"232"},{"additionalProperties":false,"description":"239","properties":"240","type":"118"},{"description":"241","type":"95"},{"description":"242","type":"216","default":0},{"description":"243","items":"244","type":"219"},{"description":"245","items":"246","type":"219"},{"default":true,"description":"247","type":"232"},{"description":"248","items":"249","type":"219"},{"description":"250","type":"216"},"c03631cb4f0e2","978c473938de3","DuplicateApiKey",{"message":"168","status":401},"Duplicate API key found","9057e99a48392","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","8047cc2bc93d6","NoAPIKey",{"message":"251","status":401},"No API key found",{"type":"216"},{"type":"95"},"status","message","470b68e5f0549","faf13021af4b1","Create a route",{"name":"252","protocols":"253","methods":"254","hosts":"255","paths":"256","headers":"257","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"227","preserve_host":false,"request_buffering":true,"response_buffering":true,"tags":"258","service":"259"},{"name":"252","protocols":"260","methods":"261","hosts":"262","paths":"263","headers":"264","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"227","preserve_host":false,"request_buffering":true,"response_buffering":true,"snis":"265","sources":"266","destinations":"267","tags":"268","service":"269"},{"type":"95","description":"270"},{"type":"219","description":"271","items":"272"},{"type":"219","description":"273","items":"274"},{"type":"219","description":"275","items":"276"},{"type":"219","description":"277","items":"278"},{"type":"118","description":"279","properties":"280"},{"type":"216","description":"281","default":426,"enum":"282","examples":"283"},{"type":"216","description":"284","default":0,"examples":"285"},{"type":"232","description":"286","default":true},{"type":"95","description":"287","enum":"288","examples":"289"},{"type":"232","description":"290","default":true},{"type":"232","default":true,"description":"291"},{"type":"232","default":true,"description":"292"},{"type":"219","description":"293","items":"294"},{"type":"219","description":"295","items":"296"},{"type":"219","description":"297","items":"298"},{"type":"219","description":"299","items":"300"},{"type":"301","description":"302","properties":"303"},"protocols","https_redirect_status_code","preserve_host","request_buffering","response_buffering","8d186f937045e",["304","305"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["306","307"],{"id":"308"},"Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"309","type":"118"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"95"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"95"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"95"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["112","138"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"95"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"310"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"95"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"311","type":"118"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"95"},"Unix epoch when the resource was last updated.","No API key found in request","my-route",["112","138"],["312","313"],["314","315"],["316","317"],{"x-my-header":"318","x-another-header":"319"},["320","321"],{"id":"322"},["112","138"],["312","313"],["314","315"],["316","317"],{"x-my-header":"323","x-another-header":"324"},["315","314"],["325","326","327"],["328","329","330"],["320","321"],{"id":"322"},"The name of the route. Route names must be unique, and they are case sensitive. For example, there can be two different routes named \"test\" and \"Test\".\n","An array of the protocols this route should allow",{"type":"95","default":"138","examples":"331"},"A list of HTTP methods that match this route.\n",{"type":"95","examples":"332"},"A list of domain names that match this route. Note that the hosts value is case sensitive. With form-encoded, the notation is `hosts[]=example.com&hosts[]=foo.test`. With JSON, use an Array.",{"type":"95"},"A list of paths that match this route. With form-encoded, the notation is `paths[]=/foo&paths[]=/bar`. With JSON, use an array. The path can be a regular expression, or a plain text pattern.",{"type":"95"},"One or more lists of values indexed by header name that will cause this route to match if present in the request. The Host header cannot be used with this attribute hosts should be specified using the `hosts` attribute. When headers contains only one value and that value starts with the special prefix` ~*`, the value is interpreted as a regular expression.",{"x-my-header":"333","x-another-header":"334"},"The status code Kong responds with when all properties of a route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`\nLocation header is injected by Kong if the field is set to `301`, `302`, `307` or `308`. Note: This config applies only if the route is configured to only accept the https protocol. Accepted values are: `426`, `301`, `302`, `307`, `308`. Default: `426`.",[426,301,302,307,308],[426],"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).",[0],"When matching a route via one of the paths, strip the matching prefix from the upstream request URL.","Controls how the service path, route path and requested path are combined when sending a request to the upstream. Accepted values are \"`v0`\", \"`v1`\".",["335","227"],["227"],"When matching a route via one of the `hosts` domain names, use the request `host` header in the upstream request headers. If set to `false`, the upstream Host header will be that of the service's host.","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding. Default: true.\n","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding. Default: `true`.\n","A list of SNIs that match this route when using stream routing.\n",{"type":"95"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"118","properties":"336"},"A list of IP destinations of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"118","properties":"337"},"An optional set of strings associated with the route for grouping and filtering.\n",{"type":"95"},["118","338"],"The service this route is associated to. This is where the route proxies traffic to. With form-encoded, the notation is service.id=<service id> or service.name=<service name>. With JSON, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",{"id":"339"},"foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"340"},{"type":"95"},{"default":"341"},"GET","POST","example.com","foo.test","/foo","/bar",["342","343"],["344"],"user-level","low-priority","af8330d3-dbdc-48bd-b1be-55b98608834b",["342","343"],["344"],{"ip":"345","port":1234},{"ip":"346"},{"port":9123},{"ip":"345","port":1234},{"ip":"346"},{"port":9123},["347"],["312"],{"type":"219","items":"348"},{"type":"219","items":"349"},"v1",{"ip":"350","port":"351"},{"ip":"352","port":"353"},"null",{"type":"95","examples":"354"},{},{},"foo","bar","bla","10.1.0.0/16","10.2.2.2","tcp",{"type":"95"},{"type":"95"},{"type":"95","examples":"355"},{"type":"216","examples":"356"},{"type":"95","examples":"357"},{"type":"216"},["322"],["345"],[1234],["358"],"0.1.0.0/16"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-route-with-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a route associated with a Service",["18"],"9ea92cb1aba44","delete","/services/{service_id_or_name}/routes/{route_id_or_name}",["19"],{},"delete-route-with-service","Delete a route associated with a Service using ID or name.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Routes",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"062e7c14e65ff","d95a66c903c2c","204",[],[],"Successfully deleted route or the resource didn't exist","392a68a5d38d8","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"50","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},"677031180ba9e","service_id_or_name","simple",["77"],"ID **or** name of the service to lookup",{"type":"78","examples":"79","$schema":"80","x-stoplight":"81"},["82","83","84","85","86","87","88"],"fc8ad7cc81091","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"78","examples":"89","$schema":"80","x-stoplight":"90"},["82","85","86","87","83","88"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"f04e42c5be138","application/json",["100","101","102"],[],{"type":"103","properties":"104","required":"105","title":"106","$schema":"80","x-stoplight":"107"},{"id":"108","value":"109","key":"110"},"string",["109"],"http://json-schema.org/draft-07/schema#",{"id":"111"},"name","description","example","in","required","schema","title",["112"],{"id":"113"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","114"],{"id":"115","key":"116","value":"117","summary":"118"},{"id":"119","key":"120","value":"121","summary":"122"},{"id":"123","key":"124","value":"125","summary":"126"},"object",{"status":"127","message":"128"},["129","130"],"UnauthorizedError",{"id":"131"},"ee836d1891d1d","test-service","default","fb847724c5d97","my-route","4ce274f4ba26c","https","7e3dfbcbfaa1e","DuplicateApiKey",{"message":"118","status":401},"Duplicate API key found","999f445417abf","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","ec7a7fa77b552","NoAPIKey",{"message":"132","status":401},"No API key found",{"type":"133"},{"type":"78"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/fetch-route-with-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a route associated with a Service",["18"],"b8bb568f9c9cd","get","/services/{service_id_or_name}/routes/{route_id_or_name}",["19"],{},"fetch-route-with-service","Get a route associated with a service using ID or name.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Routes",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46"],["47"],{"id":"48","url":"49","name":"50","description":"51","variables":"52"},"062e7c14e65ff","73c3d918a50ad","200",[],["53"],"Successfully fetched route","4bb3d752fc207","401",[],["54"],"Unauthorized","4be3d752fc968","404",[],[],"Resource does not exist",{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"57","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"a97e4159089d4","service_id_or_name","simple",["88"],"ID **or** name of the service to lookup",{"type":"89","examples":"90","$schema":"91","x-stoplight":"92"},["93","94","95","96","97","98","99"],"feb1c84cc1a42","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"89","examples":"100","$schema":"91","x-stoplight":"101"},["93","96","97","98","94","99"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109","enum":"110"},"ac43d6bc1d2d3","application/json",["111"],[],{"description":"112","properties":"113","type":"114","title":"115","examples":"116"},"1cabc065ae4a5",["117","118","119"],[],{"type":"114","properties":"120","required":"121","title":"122","$schema":"91","x-stoplight":"123"},{"id":"124","value":"125","key":"126"},"string",["125"],"http://json-schema.org/draft-07/schema#",{"id":"127"},"name","description","example","in","required","schema","title",["128"],{"id":"129"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["108","130"],{"id":"131","value":"132","key":"126"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"133","destinations":"134","headers":"135","hosts":"136","https_redirect_status_code":"137","id":"138","methods":"139","name":"140","path_handling":"141","paths":"142","preserve_host":"143","protocols":"144","regex_priority":"145","request_buffering":"146","response_buffering":"147","service":"148","expression":"149","priority":"150","snis":"151","sources":"152","strip_path":"153","tags":"154","updated_at":"155"},"object","Route",["132"],{"id":"156","key":"157","value":"158","summary":"159"},{"id":"160","key":"161","value":"162","summary":"163"},{"id":"164","key":"165","value":"166","summary":"167"},{"status":"168","message":"169"},["170","171"],"UnauthorizedError",{"id":"172"},"70d0d668206b2","test-service","default","dfd9d889bf252","my-route","0c7dce4a2cfea","https","06f392a458559",{"hosts":"173","id":"174","name":"175","paths":"176","service":"177"},{"description":"178","type":"179"},{"description":"180","items":"181","type":"182"},{"description":"183","type":"114"},{"description":"184","items":"185","type":"182"},{"default":426,"description":"186","type":"179"},{"type":"89"},{"description":"187","items":"188","type":"182"},{"description":"189","type":"89"},{"default":"190","description":"191","type":"89"},{"description":"192","items":"193","type":"182"},{"default":false,"description":"194","type":"195"},{"default":"196","description":"197","items":"198","type":"182"},{"default":0,"description":"199","type":"179"},{"default":true,"description":"200","type":"195"},{"default":true,"description":"201","type":"195"},{"additionalProperties":false,"description":"202","properties":"203","type":"114"},{"description":"204","type":"89"},{"description":"205","type":"179","default":0},{"description":"206","items":"207","type":"182"},{"description":"208","items":"209","type":"182"},{"default":true,"description":"210","type":"195"},{"description":"211","items":"212","type":"182"},{"description":"213","type":"179"},"9d1c073753be8","DuplicateApiKey",{"message":"159","status":401},"Duplicate API key found","4608b9247dbb3","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","d12bf302770ac","NoAPIKey",{"message":"214","status":401},"No API key found",{"type":"179"},{"type":"89"},"status","message","470b68e5f0549",["215","216"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["217","218"],{"id":"219"},"Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"220","type":"114"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"89"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"89"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"89"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["108","130"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"89"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"221"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"89"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"222","type":"114"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"89"},"Unix epoch when the resource was last updated.","No API key found in request","foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"223"},{"type":"89"},{"default":"224"},{},{}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-route-with-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a route associated with a Service",["18"],"a65e736678d00","patch","/services/{service_id_or_name}/routes/{route_id_or_name}",["19"],{},"update-route-with-service","Update a route associated with a Service using ID or name.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"Routes",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55","56"],["57"],{"id":"58","url":"59","name":"60","description":"61","variables":"62"},"062e7c14e65ff","61694cf405d30","200",[],["63"],"Successfully updated route","c1894ed0d524c","400",[],["64"],"Invalid route","c1794ed0d501b","401",[],["65"],"Unauthorized","c1494ed0d5d00","404",[],[],"Resource does not exist","722dfa8c27e64",["66"],"Route request body",{"id":"67","name":"68","style":"69","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","name":"75","style":"69","examples":"76","description":"77","required":true,"schema":"78","explicitProperties":"79"},{"id":"80","key":"81","extensions":"82","description":"83","type":"84","name":"85","in":"86"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"87","path":"88","port":"89","protocol":"90"},{"id":"91","mediaType":"92","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"92","examples":"97","encodings":"98","schema":"99"},{"id":"100","mediaType":"92","examples":"101","encodings":"102","schema":"103"},{"id":"104","mediaType":"92","examples":"105","encodings":"106","schema":"107"},"7bf9b37f9697b","service_id_or_name","simple",["108"],"ID **or** name of the service to lookup",{"type":"109","examples":"110","$schema":"111","x-stoplight":"112"},["113","114","115","116","117","118","119"],"e342e8efb66f5","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"109","examples":"120","$schema":"111","x-stoplight":"121"},["113","116","117","118","114","119"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"122","description":"123"},{"default":"124","description":"125"},{"default":"126","description":"127"},{"default":"128","description":"129","enum":"130"},"9d184a4c17ef1","application/json",["131"],[],{"description":"132","properties":"133","type":"134","title":"135","examples":"136"},"1f5de5731a274",[],[],{"type":"134","$schema":"111","x-stoplight":"137"},"3b27f0c0e9161",["138","139","140"],[],{"type":"134","properties":"141","required":"142","title":"143","$schema":"111","x-stoplight":"144"},"395b2eab79471",["145"],[],{"type":"134","x-examples":"146","properties":"147","required":"148","$schema":"111","x-stoplight":"149"},{"id":"150","value":"151","key":"152"},"string",["151"],"http://json-schema.org/draft-07/schema#",{"id":"153"},"name","description","example","in","required","schema","title",["154"],{"id":"155"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["128","156"],{"id":"157","value":"158","key":"152"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"159","destinations":"160","headers":"161","hosts":"162","https_redirect_status_code":"163","id":"164","methods":"165","name":"166","path_handling":"167","paths":"168","preserve_host":"169","protocols":"170","regex_priority":"171","request_buffering":"172","response_buffering":"173","service":"174","expression":"175","priority":"176","snis":"177","sources":"178","strip_path":"179","tags":"180","updated_at":"181"},"object","Route",["158"],{"id":"182"},{"id":"183","key":"184","value":"185","summary":"186"},{"id":"187","key":"188","value":"189","summary":"190"},{"id":"191","key":"192","value":"193","summary":"194"},{"status":"195","message":"196"},["197","198"],"UnauthorizedError",{"id":"199"},{"id":"200","key":"201","value":"202"},{"Example 1":"203"},{"name":"204","protocols":"205","methods":"206","hosts":"207","paths":"208","headers":"209","https_redirect_status_code":"210","regex_priority":"211","strip_path":"212","path_handling":"213","preserve_host":"214","request_buffering":"215","response_buffering":"216","snis":"217","sources":"218","destinations":"219","tags":"220","service":"221"},["222","223","224","225","226"],{"id":"227"},"813df2fead812","test-service","default","40a1b5ae77b2b","my-route","d26756e792f42","https","be02c79eb62bb",{"hosts":"228","id":"229","name":"230","paths":"231","service":"232"},{"description":"233","type":"234"},{"description":"235","items":"236","type":"237"},{"description":"238","type":"134"},{"description":"239","items":"240","type":"237"},{"default":426,"description":"241","type":"234"},{"type":"109"},{"description":"242","items":"243","type":"237"},{"description":"244","type":"109"},{"default":"245","description":"246","type":"109"},{"description":"247","items":"248","type":"237"},{"default":false,"description":"249","type":"250"},{"default":"251","description":"252","items":"253","type":"237"},{"default":0,"description":"254","type":"234"},{"default":true,"description":"255","type":"250"},{"default":true,"description":"256","type":"250"},{"additionalProperties":false,"description":"257","properties":"258","type":"134"},{"description":"259","type":"109"},{"description":"260","type":"234","default":0},{"description":"261","items":"262","type":"237"},{"description":"263","items":"264","type":"237"},{"default":true,"description":"265","type":"250"},{"description":"266","items":"267","type":"237"},{"description":"268","type":"234"},"1953b683a1bf1","a48c20bc2af87","DuplicateApiKey",{"message":"186","status":401},"Duplicate API key found","86528cdbc53ee","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","2a8bbf336d8db","NoAPIKey",{"message":"269","status":401},"No API key found",{"type":"234"},{"type":"109"},"status","message","470b68e5f0549","0b6ba9b96789c","Create a route",{"name":"154","protocols":"270","methods":"271","hosts":"272","paths":"273","headers":"274","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"245","preserve_host":false,"request_buffering":true,"response_buffering":true,"tags":"275","service":"276"},{"name":"154","protocols":"277","methods":"278","hosts":"279","paths":"280","headers":"281","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"245","preserve_host":false,"request_buffering":true,"response_buffering":true,"snis":"282","sources":"283","destinations":"284","tags":"285","service":"286"},{"type":"109","description":"287"},{"type":"237","description":"288","items":"289"},{"type":"237","description":"290","items":"291"},{"type":"237","description":"292","items":"293"},{"type":"237","description":"294","items":"295"},{"type":"134","description":"296","properties":"297"},{"type":"234","description":"298","default":426,"enum":"299","examples":"300"},{"type":"234","description":"301","default":0,"examples":"302"},{"type":"250","description":"303","default":true},{"type":"109","description":"304","enum":"305","examples":"306"},{"type":"250","description":"307","default":true},{"type":"250","default":true,"description":"308"},{"type":"250","default":true,"description":"309"},{"type":"237","description":"310","items":"311"},{"type":"237","description":"312","items":"313"},{"type":"237","description":"314","items":"315"},{"type":"237","description":"316","items":"317"},{"type":"318","description":"319","properties":"320"},"protocols","https_redirect_status_code","preserve_host","request_buffering","response_buffering","8d186f937045e",["321","322"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["323","324"],{"id":"325"},"Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"326","type":"134"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"109"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"109"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"109"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["128","156"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"109"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"327"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"109"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"328","type":"134"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"109"},"Unix epoch when the resource was last updated.","No API key found in request",["128","156"],["329","330"],["331","332"],["333","334"],{"x-my-header":"335","x-another-header":"336"},["337","338"],{"id":"339"},["128","156"],["329","330"],["331","332"],["333","334"],{"x-my-header":"340","x-another-header":"341"},["332","331"],["342","343","344"],["345","346","347"],["337","338"],{"id":"339"},"The name of the route. Route names must be unique, and they are case sensitive. For example, there can be two different routes named \"test\" and \"Test\".\n","An array of the protocols this route should allow",{"type":"109","default":"156","examples":"348"},"A list of HTTP methods that match this route.\n",{"type":"109","examples":"349"},"A list of domain names that match this route. Note that the hosts value is case sensitive. With form-encoded, the notation is `hosts[]=example.com&hosts[]=foo.test`. With JSON, use an Array.",{"type":"109"},"A list of paths that match this route. With form-encoded, the notation is `paths[]=/foo&paths[]=/bar`. With JSON, use an array. The path can be a regular expression, or a plain text pattern.",{"type":"109"},"One or more lists of values indexed by header name that will cause this route to match if present in the request. The Host header cannot be used with this attribute hosts should be specified using the `hosts` attribute. When headers contains only one value and that value starts with the special prefix` ~*`, the value is interpreted as a regular expression.",{"x-my-header":"350","x-another-header":"351"},"The status code Kong responds with when all properties of a route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`\nLocation header is injected by Kong if the field is set to `301`, `302`, `307` or `308`. Note: This config applies only if the route is configured to only accept the https protocol. Accepted values are: `426`, `301`, `302`, `307`, `308`. Default: `426`.",[426,301,302,307,308],[426],"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).",[0],"When matching a route via one of the paths, strip the matching prefix from the upstream request URL.","Controls how the service path, route path and requested path are combined when sending a request to the upstream. Accepted values are \"`v0`\", \"`v1`\".",["352","245"],["245"],"When matching a route via one of the `hosts` domain names, use the request `host` header in the upstream request headers. If set to `false`, the upstream Host header will be that of the service's host.","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding. Default: true.\n","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding. Default: `true`.\n","A list of SNIs that match this route when using stream routing.\n",{"type":"109"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"134","properties":"353"},"A list of IP destinations of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"134","properties":"354"},"An optional set of strings associated with the route for grouping and filtering.\n",{"type":"109"},["134","355"],"The service this route is associated to. This is where the route proxies traffic to. With form-encoded, the notation is service.id=<service id> or service.name=<service name>. With JSON, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",{"id":"356"},"foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"357"},{"type":"109"},{"default":"358"},"GET","POST","example.com","foo.test","/foo","/bar",["359","360"],["361"],"user-level","low-priority","af8330d3-dbdc-48bd-b1be-55b98608834b",["359","360"],["361"],{"ip":"362","port":1234},{"ip":"363"},{"port":9123},{"ip":"362","port":1234},{"ip":"363"},{"port":9123},["364"],["329"],{"type":"237","items":"365"},{"type":"237","items":"366"},"v1",{"ip":"367","port":"368"},{"ip":"369","port":"370"},"null",{"type":"109","examples":"371"},{},{},"foo","bar","bla","10.1.0.0/16","10.2.2.2","tcp",{"type":"109"},{"type":"109"},{"type":"109","examples":"372"},{"type":"234","examples":"373"},{"type":"109","examples":"374"},{"type":"234"},["339"],["362"],[1234],["375"],"0.1.0.0/16"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-route-with-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a route associated with a Service",["18"],"f3383d643e0f2","put","/services/{service_id_or_name}/routes/{route_id_or_name}",["19"],{},"upsert-route-with-service","Create or Update a route associated with a Service using ID or name.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Routes",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"062e7c14e65ff","84021bc262c98","200",[],["57"],"Successfully upserted route","bea21b19d9ca7","400",[],["58"],"Invalid route","beb21b19d9e78","401",[],["59"],"Unauthorized","7106e4c7dc6dd",["60"],"Route request body",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"101"},"2c546fcd67fcb","service_id_or_name","simple",["102"],"ID **or** name of the service to lookup",{"type":"103","examples":"104","$schema":"105","x-stoplight":"106"},["107","108","109","110","111","112","113"],"ad2d889f4c3f0","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"103","examples":"114","$schema":"105","x-stoplight":"115"},["107","110","111","112","108","113"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121"},{"default":"122","description":"123","enum":"124"},"f7773c02db08a","application/json",["125"],[],{"description":"126","properties":"127","type":"128","title":"129","examples":"130"},"4687877071d9e",[],[],{"type":"128","$schema":"105","x-stoplight":"131"},"72692ba07cd1c",["132","133","134"],[],{"type":"128","properties":"135","required":"136","title":"137","$schema":"105","x-stoplight":"138"},"e1f619835388a",["139"],[],{"type":"128","x-examples":"140","properties":"141","required":"142","$schema":"105","x-stoplight":"143"},{"id":"144","value":"145","key":"146"},"string",["145"],"http://json-schema.org/draft-07/schema#",{"id":"147"},"name","description","example","in","required","schema","title",["148"],{"id":"149"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["122","150"],{"id":"151","value":"152","key":"146"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"153","destinations":"154","headers":"155","hosts":"156","https_redirect_status_code":"157","id":"158","methods":"159","name":"160","path_handling":"161","paths":"162","preserve_host":"163","protocols":"164","regex_priority":"165","request_buffering":"166","response_buffering":"167","service":"168","expression":"169","priority":"170","snis":"171","sources":"172","strip_path":"173","tags":"174","updated_at":"175"},"object","Route",["152"],{"id":"176"},{"id":"177","key":"178","value":"179","summary":"180"},{"id":"181","key":"182","value":"183","summary":"184"},{"id":"185","key":"186","value":"187","summary":"188"},{"status":"189","message":"190"},["191","192"],"UnauthorizedError",{"id":"193"},{"id":"194","key":"195","value":"196"},{"Example 1":"197"},{"name":"198","protocols":"199","methods":"200","hosts":"201","paths":"202","headers":"203","https_redirect_status_code":"204","regex_priority":"205","strip_path":"206","path_handling":"207","preserve_host":"208","request_buffering":"209","response_buffering":"210","snis":"211","sources":"212","destinations":"213","tags":"214","service":"215"},["216","217","218","219","220"],{"id":"221"},"4827cf6d52efb","test-service","default","f983c7e95c03d","my-route","303df9369d96a","https","6cea96f4360d4",{"hosts":"222","id":"223","name":"224","paths":"225","service":"226"},{"description":"227","type":"228"},{"description":"229","items":"230","type":"231"},{"description":"232","type":"128"},{"description":"233","items":"234","type":"231"},{"default":426,"description":"235","type":"228"},{"type":"103"},{"description":"236","items":"237","type":"231"},{"description":"238","type":"103"},{"default":"239","description":"240","type":"103"},{"description":"241","items":"242","type":"231"},{"default":false,"description":"243","type":"244"},{"default":"245","description":"246","items":"247","type":"231"},{"default":0,"description":"248","type":"228"},{"default":true,"description":"249","type":"244"},{"default":true,"description":"250","type":"244"},{"additionalProperties":false,"description":"251","properties":"252","type":"128"},{"description":"253","type":"103"},{"description":"254","type":"228","default":0},{"description":"255","items":"256","type":"231"},{"description":"257","items":"258","type":"231"},{"default":true,"description":"259","type":"244"},{"description":"260","items":"261","type":"231"},{"description":"262","type":"228"},"c191812ca4639","5fe06987958ba","DuplicateApiKey",{"message":"180","status":401},"Duplicate API key found","00e205bb43d7f","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","063865edb28da","NoAPIKey",{"message":"263","status":401},"No API key found",{"type":"228"},{"type":"103"},"status","message","470b68e5f0549","d89bf7aa1bcc6","Create a route",{"name":"148","protocols":"264","methods":"265","hosts":"266","paths":"267","headers":"268","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"239","preserve_host":false,"request_buffering":true,"response_buffering":true,"tags":"269","service":"270"},{"name":"148","protocols":"271","methods":"272","hosts":"273","paths":"274","headers":"275","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"239","preserve_host":false,"request_buffering":true,"response_buffering":true,"snis":"276","sources":"277","destinations":"278","tags":"279","service":"280"},{"type":"103","description":"281"},{"type":"231","description":"282","items":"283"},{"type":"231","description":"284","items":"285"},{"type":"231","description":"286","items":"287"},{"type":"231","description":"288","items":"289"},{"type":"128","description":"290","properties":"291"},{"type":"228","description":"292","default":426,"enum":"293","examples":"294"},{"type":"228","description":"295","default":0,"examples":"296"},{"type":"244","description":"297","default":true},{"type":"103","description":"298","enum":"299","examples":"300"},{"type":"244","description":"301","default":true},{"type":"244","default":true,"description":"302"},{"type":"244","default":true,"description":"303"},{"type":"231","description":"304","items":"305"},{"type":"231","description":"306","items":"307"},{"type":"231","description":"308","items":"309"},{"type":"231","description":"310","items":"311"},{"type":"312","description":"313","properties":"314"},"protocols","https_redirect_status_code","preserve_host","request_buffering","response_buffering","8d186f937045e",["315","316"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["317","318"],{"id":"319"},"Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"320","type":"128"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"103"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"103"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"103"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["122","150"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"103"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"321"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"103"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"322","type":"128"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"103"},"Unix epoch when the resource was last updated.","No API key found in request",["122","150"],["323","324"],["325","326"],["327","328"],{"x-my-header":"329","x-another-header":"330"},["331","332"],{"id":"333"},["122","150"],["323","324"],["325","326"],["327","328"],{"x-my-header":"334","x-another-header":"335"},["326","325"],["336","337","338"],["339","340","341"],["331","332"],{"id":"333"},"The name of the route. Route names must be unique, and they are case sensitive. For example, there can be two different routes named \"test\" and \"Test\".\n","An array of the protocols this route should allow",{"type":"103","default":"150","examples":"342"},"A list of HTTP methods that match this route.\n",{"type":"103","examples":"343"},"A list of domain names that match this route. Note that the hosts value is case sensitive. With form-encoded, the notation is `hosts[]=example.com&hosts[]=foo.test`. With JSON, use an Array.",{"type":"103"},"A list of paths that match this route. With form-encoded, the notation is `paths[]=/foo&paths[]=/bar`. With JSON, use an array. The path can be a regular expression, or a plain text pattern.",{"type":"103"},"One or more lists of values indexed by header name that will cause this route to match if present in the request. The Host header cannot be used with this attribute hosts should be specified using the `hosts` attribute. When headers contains only one value and that value starts with the special prefix` ~*`, the value is interpreted as a regular expression.",{"x-my-header":"344","x-another-header":"345"},"The status code Kong responds with when all properties of a route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`\nLocation header is injected by Kong if the field is set to `301`, `302`, `307` or `308`. Note: This config applies only if the route is configured to only accept the https protocol. Accepted values are: `426`, `301`, `302`, `307`, `308`. Default: `426`.",[426,301,302,307,308],[426],"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).",[0],"When matching a route via one of the paths, strip the matching prefix from the upstream request URL.","Controls how the service path, route path and requested path are combined when sending a request to the upstream. Accepted values are \"`v0`\", \"`v1`\".",["346","239"],["239"],"When matching a route via one of the `hosts` domain names, use the request `host` header in the upstream request headers. If set to `false`, the upstream Host header will be that of the service's host.","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding. Default: true.\n","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding. Default: `true`.\n","A list of SNIs that match this route when using stream routing.\n",{"type":"103"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"128","properties":"347"},"A list of IP destinations of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"128","properties":"348"},"An optional set of strings associated with the route for grouping and filtering.\n",{"type":"103"},["128","349"],"The service this route is associated to. This is where the route proxies traffic to. With form-encoded, the notation is service.id=<service id> or service.name=<service name>. With JSON, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",{"id":"350"},"foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"351"},{"type":"103"},{"default":"352"},"GET","POST","example.com","foo.test","/foo","/bar",["353","354"],["355"],"user-level","low-priority","af8330d3-dbdc-48bd-b1be-55b98608834b",["353","354"],["355"],{"ip":"356","port":1234},{"ip":"357"},{"port":9123},{"ip":"356","port":1234},{"ip":"357"},{"port":9123},["358"],["323"],{"type":"231","items":"359"},{"type":"231","items":"360"},"v1",{"ip":"361","port":"362"},{"ip":"363","port":"364"},"null",{"type":"103","examples":"365"},{},{},"foo","bar","bla","10.1.0.0/16","10.2.2.2","tcp",{"type":"103"},{"type":"103"},{"type":"103","examples":"366"},{"type":"228","examples":"367"},{"type":"103","examples":"368"},{"type":"228"},["333"],["356"],[1234],["369"],"0.1.0.0/16"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-route-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all routes in a workspace",["17"],"c16294744746b","get","/{workspace}/routes",["18"],{},"list-route-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Routes",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],["41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"062e7c14e65ff","f2dff11a2afd9","200",[],["48"],"A successful response listing routes","884ff1ab9af68","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"71","examples":"72","description":"73","required":true,"schema":"74","explicitProperties":"75"},{"id":"76","key":"77","extensions":"78","description":"79","type":"80","name":"81","in":"82"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"83","path":"84","port":"85","protocol":"86"},{"id":"87","mediaType":"88","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"88","examples":"93","encodings":"94","schema":"95"},"078d2fbb64d74","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103"],"403ce5788e1f3","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"104","$schema":"97","x-stoplight":"105"},["99","100","101","102","103"],"d96ea94a44480","tags",["106"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"104","examples":"107","x-stoplight":"108","$schema":"97"},["99","109","100","101","102","103"],"18b435e4d378d","workspace","simple",[],"Name or ID of workspace",{"type":"104","examples":"110","$schema":"97","x-stoplight":"111"},["101","100","112","102","99","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"a84d6cdd2e50e","application/json",[],[],{"properties":"122","$schema":"97","x-stoplight":"123"},"c5b2d7f8f734c",["124","125","126"],[],{"type":"127","properties":"128","required":"129","title":"130","$schema":"97","x-stoplight":"131"},"integer","http://json-schema.org/draft-07/schema#",{"id":"132"},"description","in","name","schema","title","string",{"id":"133"},{"id":"134","value":"135","key":"136"},["135"],{"explicitProperties":"137","id":"138"},"example",["139"],{"id":"140"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","141"],{"data":"142","offset":"143"},{"id":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},"object",{"status":"157","message":"158"},["159","160"],"UnauthorizedError",{"id":"161"},"664cd419db2d1","08a810ff208a9","7d86752aa6146","tag1,tag2","default",["162","163","164"],"747c71e6f8f48","team-a","24afaaf5ebf16","https",{"items":"165","type":"166"},{"description":"167","type":"104","title":"168"},"2cbe094423079","fdfc3197a52db","DuplicateApiKey",{"message":"148","status":401},"Duplicate API key found","ef62a712e602e","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","01400b11bede9","NoAPIKey",{"message":"169","status":401},"No API key found",{"type":"96"},{"type":"104"},"status","message","470b68e5f0549","type","nullable","examples",{"description":"170","properties":"171","type":"127","title":"172","examples":"173"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","No API key found in request","Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"174","destinations":"175","headers":"176","hosts":"177","https_redirect_status_code":"178","id":"179","methods":"180","name":"181","path_handling":"182","paths":"183","preserve_host":"184","protocols":"185","regex_priority":"186","request_buffering":"187","response_buffering":"188","service":"189","expression":"190","priority":"191","snis":"192","sources":"193","strip_path":"194","tags":"195","updated_at":"196"},"Route",["197"],{"description":"198","type":"96"},{"description":"199","items":"200","type":"166"},{"description":"201","type":"127"},{"description":"202","items":"203","type":"166"},{"default":426,"description":"204","type":"96"},{"type":"104"},{"description":"205","items":"206","type":"166"},{"description":"207","type":"104"},{"default":"208","description":"209","type":"104"},{"description":"210","items":"211","type":"166"},{"default":false,"description":"212","type":"213"},{"default":"214","description":"215","items":"216","type":"166"},{"default":0,"description":"217","type":"96"},{"default":true,"description":"218","type":"213"},{"default":true,"description":"219","type":"213"},{"additionalProperties":false,"description":"220","properties":"221","type":"127"},{"description":"222","type":"104"},{"description":"223","type":"96","default":0},{"description":"224","items":"225","type":"166"},{"description":"226","items":"227","type":"166"},{"default":true,"description":"228","type":"213"},{"description":"229","items":"230","type":"166"},{"description":"231","type":"96"},{"hosts":"232","id":"233","name":"234","paths":"235","service":"236"},"Unix epoch when the resource was created.","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"237","type":"127"},"One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"104"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"104"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"104"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["119","141"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"104"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"238"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"104"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"239","type":"127"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"104"},"Unix epoch when the resource was last updated.",["240","241"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["242","243"],{"id":"244"},{"default":"245"},{"type":"104"},{"default":"246"},"foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{},{}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-route-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new route in a workspace",["17"],"aa672355e48fe","post","/{workspace}/routes",["18"],{},"create-route-in-workspace","inheritedFromService",["19","20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Routes",{"id":"28","name":"17"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},{"id":"39","code":"40","headers":"41","contents":"42","description":"43"},[],[],[],["44"],["45"],{"id":"46","url":"47","name":"48","description":"49","variables":"50"},"062e7c14e65ff","2516c22bf4968","200",[],["51"],"Successfully created route","ccf6c04f32c65","400",[],["52"],"Invalid route","cce6c04f31216","401",[],["53"],"Unauthorized",{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},{"id":"77","mediaType":"73","examples":"78","encodings":"79","schema":"80"},{"id":"81","mediaType":"73","examples":"82","encodings":"83","schema":"84"},"8fda7c712bf07","workspace","simple",[],"Name or ID of workspace",{"type":"85","examples":"86","$schema":"87","x-stoplight":"88"},["89","90","91","92","93","94"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"95","description":"96"},{"default":"97","description":"98"},{"default":"99","description":"100"},{"default":"101","description":"102","enum":"103"},"5edc2946a09b8","application/json",["104"],[],{"description":"105","properties":"106","type":"107","title":"108","examples":"109"},"e0b40383eeb2c",[],[],{"type":"107","$schema":"87","x-stoplight":"110"},"418cea8c48cbf",["111","112","113"],[],{"type":"107","properties":"114","required":"115","title":"116","$schema":"87","x-stoplight":"117"},"string",["118"],"http://json-schema.org/draft-07/schema#",{"id":"119"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["101","120"],{"id":"121","value":"122","key":"123"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"124","destinations":"125","headers":"126","hosts":"127","https_redirect_status_code":"128","id":"129","methods":"130","name":"131","path_handling":"132","paths":"133","preserve_host":"134","protocols":"135","regex_priority":"136","request_buffering":"137","response_buffering":"138","service":"139","expression":"140","priority":"141","snis":"142","sources":"143","strip_path":"144","tags":"145","updated_at":"146"},"object","Route",["122"],{"id":"147"},{"id":"148","key":"149","value":"150","summary":"151"},{"id":"152","key":"153","value":"154","summary":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"status":"160","message":"161"},["162","163"],"UnauthorizedError",{"id":"164"},"team-a","95be74b08c187","https","7d9e456bfe9ce",{"hosts":"165","id":"166","name":"167","paths":"168","service":"169"},"default",{"description":"170","type":"171"},{"description":"172","items":"173","type":"174"},{"description":"175","type":"107"},{"description":"176","items":"177","type":"174"},{"default":426,"description":"178","type":"171"},{"type":"85"},{"description":"179","items":"180","type":"174"},{"description":"181","type":"85"},{"default":"182","description":"183","type":"85"},{"description":"184","items":"185","type":"174"},{"default":false,"description":"186","type":"187"},{"default":"188","description":"189","items":"190","type":"174"},{"default":0,"description":"191","type":"171"},{"default":true,"description":"192","type":"187"},{"default":true,"description":"193","type":"187"},{"additionalProperties":false,"description":"194","properties":"195","type":"107"},{"description":"196","type":"85"},{"description":"197","type":"171","default":0},{"description":"198","items":"199","type":"174"},{"description":"200","items":"201","type":"174"},{"default":true,"description":"202","type":"187"},{"description":"203","items":"204","type":"174"},{"description":"205","type":"171"},"2b9e69e36efe7","b0f924eda64b3","DuplicateApiKey",{"message":"151","status":401},"Duplicate API key found","c4ed7180936d7","InvalidAuthCred",{"message":"43","status":401},"Invalid authentication credentials","241a59e9d3163","NoAPIKey",{"message":"206","status":401},"No API key found",{"type":"171"},{"type":"85"},"status","message","470b68e5f0549",["207","208"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["209","210"],{"id":"211"},"Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"212","type":"107"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"85"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"85"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"85"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["101","120"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"85"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"213"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"85"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"214","type":"107"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"85"},"Unix epoch when the resource was last updated.","No API key found in request","foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"215"},{"type":"85"},{"default":"216"},{},{}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-route-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a route in a workspace",["17"],"c75cfa77e9b90","delete","/{workspace}/routes/{route_id_or_name}",["18"],{},"delete-route-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Routes",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38","39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"062e7c14e65ff","0076afdad1c8e","204",[],[],"Successfully deleted route or the resource didn't exist","cd86b08367ca1","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","name":"55","style":"49","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","key":"61","extensions":"62","description":"63","type":"64","name":"65","in":"66"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"67","path":"68","port":"69","protocol":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},"6648335a354c2","workspace","simple",[],"Name or ID of workspace",{"type":"76","examples":"77","$schema":"78","x-stoplight":"79"},["80","81","82","83","84","85"],"bd2bae1b0e558","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"76","examples":"86","$schema":"78","x-stoplight":"87"},["80","81","82","83","84","85"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95","enum":"96"},"9461d68df183e","application/json",["97","98","99"],[],{"type":"100","properties":"101","required":"102","title":"103","$schema":"78","x-stoplight":"104"},"string",["105"],"http://json-schema.org/draft-07/schema#",{"id":"106"},"name","in","required","schema","description","title",["107"],{"id":"108"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["94","109"],{"id":"110","key":"111","value":"112","summary":"113"},{"id":"114","key":"115","value":"116","summary":"117"},{"id":"118","key":"119","value":"120","summary":"121"},"object",{"status":"122","message":"123"},["124","125"],"UnauthorizedError",{"id":"126"},"team-a","627e74813027e","my-route","0bda246b93b16","https","59fc719d138a9","DuplicateApiKey",{"message":"113","status":401},"Duplicate API key found","ec082e113b65a","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","bd3a10d70ea88","NoAPIKey",{"message":"127","status":401},"No API key found",{"type":"128"},{"type":"76"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-route-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a route in a workspace",["18"],"1b0d69f657f5f","get","/{workspace}/routes/{route_id_or_name}",["19"],{},"get-route-in-workspace","Get a route using ID or name in a workspace.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Routes",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46"],["47"],{"id":"48","url":"49","name":"50","description":"51","variables":"52"},"062e7c14e65ff","c414b7d836a8b","200",[],["53"],"Successfully fetched route","c6c4b7356d092","401",[],["54"],"Unauthorized","c6f4b7356d589","404",[],[],"Resource does not exist",{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"57","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"f9431262d2906","workspace","simple",[],"Name or ID of workspace",{"type":"88","examples":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96","97"],"45c017f84b6bc","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"88","examples":"98","$schema":"90","x-stoplight":"99"},["92","93","94","95","96","97"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107","enum":"108"},"f42efdb520330","application/json",["109"],[],{"description":"110","properties":"111","type":"112","title":"113","examples":"114"},"7f10fd2258fc0",["115","116","117"],[],{"type":"112","properties":"118","required":"119","title":"120","$schema":"90","x-stoplight":"121"},"string",["122"],"http://json-schema.org/draft-07/schema#",{"id":"123"},"name","in","required","schema","description","title",["124"],{"id":"125"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["106","126"],{"id":"127","value":"128","key":"129"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"130","destinations":"131","headers":"132","hosts":"133","https_redirect_status_code":"134","id":"135","methods":"136","name":"137","path_handling":"138","paths":"139","preserve_host":"140","protocols":"141","regex_priority":"142","request_buffering":"143","response_buffering":"144","service":"145","expression":"146","priority":"147","snis":"148","sources":"149","strip_path":"150","tags":"151","updated_at":"152"},"object","Route",["128"],{"id":"153","key":"154","value":"155","summary":"156"},{"id":"157","key":"158","value":"159","summary":"160"},{"id":"161","key":"162","value":"163","summary":"164"},{"status":"165","message":"166"},["167","168"],"UnauthorizedError",{"id":"169"},"team-a","a3d47761aaf4a","my-route","bb0094c143248","https","c04fb7cd9acad",{"hosts":"170","id":"171","name":"172","paths":"173","service":"174"},"default",{"description":"175","type":"176"},{"description":"177","items":"178","type":"179"},{"description":"180","type":"112"},{"description":"181","items":"182","type":"179"},{"default":426,"description":"183","type":"176"},{"type":"88"},{"description":"184","items":"185","type":"179"},{"description":"186","type":"88"},{"default":"187","description":"188","type":"88"},{"description":"189","items":"190","type":"179"},{"default":false,"description":"191","type":"192"},{"default":"193","description":"194","items":"195","type":"179"},{"default":0,"description":"196","type":"176"},{"default":true,"description":"197","type":"192"},{"default":true,"description":"198","type":"192"},{"additionalProperties":false,"description":"199","properties":"200","type":"112"},{"description":"201","type":"88"},{"description":"202","type":"176","default":0},{"description":"203","items":"204","type":"179"},{"description":"205","items":"206","type":"179"},{"default":true,"description":"207","type":"192"},{"description":"208","items":"209","type":"179"},{"description":"210","type":"176"},"c83a899ac7fae","DuplicateApiKey",{"message":"156","status":401},"Duplicate API key found","959ea5fcd9139","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","d4ec6cd7ccf46","NoAPIKey",{"message":"211","status":401},"No API key found",{"type":"176"},{"type":"88"},"status","message","470b68e5f0549",["212","213"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["214","215"],{"id":"216"},"Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"217","type":"112"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"88"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"88"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"88"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["106","126"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"88"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"218"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"88"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"219","type":"112"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"88"},"Unix epoch when the resource was last updated.","No API key found in request","foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"220"},{"type":"88"},{"default":"221"},{},{}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-route-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update a route in a workspace",["17"],"2e552693eb6bf","patch","/{workspace}/routes/{route_id_or_name}",["18"],{},"update-route-in-workspace","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Routes",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54","55"],["56"],{"id":"57","url":"58","name":"59","description":"60","variables":"61"},"062e7c14e65ff","7257d1f4f25d6","200",[],["62"],"Successfully updated route","37b7d29d7bbcd","400",[],["63"],"Invalid route","37a7d29d7b97e","401",[],["64"],"Unauthorized","3777d29d7b411","404",[],[],"Resource does not exist","76fe2333e732c",["65"],"Route request body",{"id":"66","name":"67","style":"68","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","name":"74","style":"68","examples":"75","description":"76","required":true,"schema":"77","explicitProperties":"78"},{"id":"79","key":"80","extensions":"81","description":"82","type":"83","name":"84","in":"85"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"86","path":"87","port":"88","protocol":"89"},{"id":"90","mediaType":"91","examples":"92","encodings":"93","schema":"94"},{"id":"95","mediaType":"91","examples":"96","encodings":"97","schema":"98"},{"id":"99","mediaType":"91","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"91","examples":"104","encodings":"105","schema":"106"},"68a6d493f8446","workspace","simple",[],"Name or ID of workspace",{"type":"107","examples":"108","$schema":"109","x-stoplight":"110"},["111","112","113","114","115","116"],"4be52c1a49da2","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"107","examples":"117","$schema":"109","x-stoplight":"118"},["111","112","113","114","115","116"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"119","description":"120"},{"default":"121","description":"122"},{"default":"123","description":"124"},{"default":"125","description":"126","enum":"127"},"8e0028c6d62de","application/json",["128"],[],{"description":"129","properties":"130","type":"131","title":"132","examples":"133"},"4d5c8a4b58724",[],[],{"type":"131","$schema":"109","x-stoplight":"134"},"8eb3c4440fe13",["135","136","137"],[],{"type":"131","properties":"138","required":"139","title":"140","$schema":"109","x-stoplight":"141"},"bb193877f6cf9",["142"],[],{"type":"131","x-examples":"143","properties":"144","required":"145","$schema":"109","x-stoplight":"146"},"string",["147"],"http://json-schema.org/draft-07/schema#",{"id":"148"},"name","in","required","schema","description","title",["149"],{"id":"150"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["125","151"],{"id":"152","value":"153","key":"154"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"155","destinations":"156","headers":"157","hosts":"158","https_redirect_status_code":"159","id":"160","methods":"161","name":"162","path_handling":"163","paths":"164","preserve_host":"165","protocols":"166","regex_priority":"167","request_buffering":"168","response_buffering":"169","service":"170","expression":"171","priority":"172","snis":"173","sources":"174","strip_path":"175","tags":"176","updated_at":"177"},"object","Route",["153"],{"id":"178"},{"id":"179","key":"180","value":"181","summary":"182"},{"id":"183","key":"184","value":"185","summary":"186"},{"id":"187","key":"188","value":"189","summary":"190"},{"status":"191","message":"192"},["193","194"],"UnauthorizedError",{"id":"195"},{"id":"196","key":"197","value":"198"},{"Example 1":"199"},{"name":"200","protocols":"201","methods":"202","hosts":"203","paths":"204","headers":"205","https_redirect_status_code":"206","regex_priority":"207","strip_path":"208","path_handling":"209","preserve_host":"210","request_buffering":"211","response_buffering":"212","snis":"213","sources":"214","destinations":"215","tags":"216","service":"217"},["218","219","220","221","222"],{"id":"223"},"team-a","422338c3ef74e","my-route","2753d9f6bb3cd","https","014349ec5ac5d",{"hosts":"224","id":"225","name":"226","paths":"227","service":"228"},"default",{"description":"229","type":"230"},{"description":"231","items":"232","type":"233"},{"description":"234","type":"131"},{"description":"235","items":"236","type":"233"},{"default":426,"description":"237","type":"230"},{"type":"107"},{"description":"238","items":"239","type":"233"},{"description":"240","type":"107"},{"default":"241","description":"242","type":"107"},{"description":"243","items":"244","type":"233"},{"default":false,"description":"245","type":"246"},{"default":"247","description":"248","items":"249","type":"233"},{"default":0,"description":"250","type":"230"},{"default":true,"description":"251","type":"246"},{"default":true,"description":"252","type":"246"},{"additionalProperties":false,"description":"253","properties":"254","type":"131"},{"description":"255","type":"107"},{"description":"256","type":"230","default":0},{"description":"257","items":"258","type":"233"},{"description":"259","items":"260","type":"233"},{"default":true,"description":"261","type":"246"},{"description":"262","items":"263","type":"233"},{"description":"264","type":"230"},"71e4d3f956006","ff6767dc2f3fc","DuplicateApiKey",{"message":"182","status":401},"Duplicate API key found","2aa84b063237c","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","93311b4741dd9","NoAPIKey",{"message":"265","status":401},"No API key found",{"type":"230"},{"type":"107"},"status","message","470b68e5f0549","e792b1512ae57","Create a route",{"name":"149","protocols":"266","methods":"267","hosts":"268","paths":"269","headers":"270","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"241","preserve_host":false,"request_buffering":true,"response_buffering":true,"tags":"271","service":"272"},{"name":"149","protocols":"273","methods":"274","hosts":"275","paths":"276","headers":"277","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"241","preserve_host":false,"request_buffering":true,"response_buffering":true,"snis":"278","sources":"279","destinations":"280","tags":"281","service":"282"},{"type":"107","description":"283"},{"type":"233","description":"284","items":"285"},{"type":"233","description":"286","items":"287"},{"type":"233","description":"288","items":"289"},{"type":"233","description":"290","items":"291"},{"type":"131","description":"292","properties":"293"},{"type":"230","description":"294","default":426,"enum":"295","examples":"296"},{"type":"230","description":"297","default":0,"examples":"298"},{"type":"246","description":"299","default":true},{"type":"107","description":"300","enum":"301","examples":"302"},{"type":"246","description":"303","default":true},{"type":"246","default":true,"description":"304"},{"type":"246","default":true,"description":"305"},{"type":"233","description":"306","items":"307"},{"type":"233","description":"308","items":"309"},{"type":"233","description":"310","items":"311"},{"type":"233","description":"312","items":"313"},{"type":"314","description":"315","properties":"316"},"protocols","https_redirect_status_code","preserve_host","request_buffering","response_buffering","8d186f937045e",["317","318"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["319","320"],{"id":"321"},"Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"322","type":"131"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"107"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"107"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"107"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["125","151"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"107"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"323"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"107"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"324","type":"131"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"107"},"Unix epoch when the resource was last updated.","No API key found in request",["125","151"],["325","326"],["327","328"],["329","330"],{"x-my-header":"331","x-another-header":"332"},["333","334"],{"id":"335"},["125","151"],["325","326"],["327","328"],["329","330"],{"x-my-header":"336","x-another-header":"337"},["328","327"],["338","339","340"],["341","342","343"],["333","334"],{"id":"335"},"The name of the route. Route names must be unique, and they are case sensitive. For example, there can be two different routes named \"test\" and \"Test\".\n","An array of the protocols this route should allow",{"type":"107","default":"151","examples":"344"},"A list of HTTP methods that match this route.\n",{"type":"107","examples":"345"},"A list of domain names that match this route. Note that the hosts value is case sensitive. With form-encoded, the notation is `hosts[]=example.com&hosts[]=foo.test`. With JSON, use an Array.",{"type":"107"},"A list of paths that match this route. With form-encoded, the notation is `paths[]=/foo&paths[]=/bar`. With JSON, use an array. The path can be a regular expression, or a plain text pattern.",{"type":"107"},"One or more lists of values indexed by header name that will cause this route to match if present in the request. The Host header cannot be used with this attribute hosts should be specified using the `hosts` attribute. When headers contains only one value and that value starts with the special prefix` ~*`, the value is interpreted as a regular expression.",{"x-my-header":"346","x-another-header":"347"},"The status code Kong responds with when all properties of a route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`\nLocation header is injected by Kong if the field is set to `301`, `302`, `307` or `308`. Note: This config applies only if the route is configured to only accept the https protocol. Accepted values are: `426`, `301`, `302`, `307`, `308`. Default: `426`.",[426,301,302,307,308],[426],"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).",[0],"When matching a route via one of the paths, strip the matching prefix from the upstream request URL.","Controls how the service path, route path and requested path are combined when sending a request to the upstream. Accepted values are \"`v0`\", \"`v1`\".",["348","241"],["241"],"When matching a route via one of the `hosts` domain names, use the request `host` header in the upstream request headers. If set to `false`, the upstream Host header will be that of the service's host.","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding. Default: true.\n","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding. Default: `true`.\n","A list of SNIs that match this route when using stream routing.\n",{"type":"107"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"131","properties":"349"},"A list of IP destinations of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"131","properties":"350"},"An optional set of strings associated with the route for grouping and filtering.\n",{"type":"107"},["131","351"],"The service this route is associated to. This is where the route proxies traffic to. With form-encoded, the notation is service.id=<service id> or service.name=<service name>. With JSON, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",{"id":"352"},"foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"353"},{"type":"107"},{"default":"354"},"GET","POST","example.com","foo.test","/foo","/bar",["355","356"],["357"],"user-level","low-priority","af8330d3-dbdc-48bd-b1be-55b98608834b",["355","356"],["357"],{"ip":"358","port":1234},{"ip":"359"},{"port":9123},{"ip":"358","port":1234},{"ip":"359"},{"port":9123},["360"],["325"],{"type":"233","items":"361"},{"type":"233","items":"362"},"v1",{"ip":"363","port":"364"},{"ip":"365","port":"366"},"null",{"type":"107","examples":"367"},{},{},"foo","bar","bla","10.1.0.0/16","10.2.2.2","tcp",{"type":"107"},{"type":"107"},{"type":"107","examples":"368"},{"type":"230","examples":"369"},{"type":"107","examples":"370"},{"type":"230"},["335"],["358"],[1234],["371"],"0.1.0.0/16"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-route-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a route in a workspace",["18"],"6eeff860ce331","put","/{workspace}/routes/{route_id_or_name}",["19"],{},"upsert-route-in-workspace","Create or Update route using ID or name in a workspace.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Routes",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"062e7c14e65ff","56e239462bb46","200",[],["57"],"Successfully upserted route","8982389d95651","400",[],["58"],"Invalid route","8992389d950ae","401",[],["59"],"Unauthorized","fb147d93f66f0",["60"],"Route request body",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"101"},"709a03a5c0562","workspace","simple",[],"Name or ID of workspace",{"type":"102","examples":"103","$schema":"104","x-stoplight":"105"},["106","107","108","109","110","111"],"55e1c730ae879","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"102","examples":"112","$schema":"104","x-stoplight":"113"},["106","107","108","109","110","111"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121","enum":"122"},"ac64df8885302","application/json",["123"],[],{"description":"124","properties":"125","type":"126","title":"127","examples":"128"},"a799ee5c3a8f2",[],[],{"type":"126","$schema":"104","x-stoplight":"129"},"a9b2bd24b2b88",["130","131","132"],[],{"type":"126","properties":"133","required":"134","title":"135","$schema":"104","x-stoplight":"136"},"dbe1e4f8d8c09",["137"],[],{"type":"126","x-examples":"138","properties":"139","required":"140","$schema":"104","x-stoplight":"141"},"string",["142"],"http://json-schema.org/draft-07/schema#",{"id":"143"},"name","in","required","schema","description","title",["144"],{"id":"145"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["120","146"],{"id":"147","value":"148","key":"149"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"150","destinations":"151","headers":"152","hosts":"153","https_redirect_status_code":"154","id":"155","methods":"156","name":"157","path_handling":"158","paths":"159","preserve_host":"160","protocols":"161","regex_priority":"162","request_buffering":"163","response_buffering":"164","service":"165","expression":"166","priority":"167","snis":"168","sources":"169","strip_path":"170","tags":"171","updated_at":"172"},"object","Route",["148"],{"id":"173"},{"id":"174","key":"175","value":"176","summary":"177"},{"id":"178","key":"179","value":"180","summary":"181"},{"id":"182","key":"183","value":"184","summary":"185"},{"status":"186","message":"187"},["188","189"],"UnauthorizedError",{"id":"190"},{"id":"191","key":"192","value":"193"},{"Example 1":"194"},{"name":"195","protocols":"196","methods":"197","hosts":"198","paths":"199","headers":"200","https_redirect_status_code":"201","regex_priority":"202","strip_path":"203","path_handling":"204","preserve_host":"205","request_buffering":"206","response_buffering":"207","snis":"208","sources":"209","destinations":"210","tags":"211","service":"212"},["213","214","215","216","217"],{"id":"218"},"team-a","1bc378797684e","my-route","ba996973cf8d0","https","f2164a49779a8",{"hosts":"219","id":"220","name":"221","paths":"222","service":"223"},"default",{"description":"224","type":"225"},{"description":"226","items":"227","type":"228"},{"description":"229","type":"126"},{"description":"230","items":"231","type":"228"},{"default":426,"description":"232","type":"225"},{"type":"102"},{"description":"233","items":"234","type":"228"},{"description":"235","type":"102"},{"default":"236","description":"237","type":"102"},{"description":"238","items":"239","type":"228"},{"default":false,"description":"240","type":"241"},{"default":"242","description":"243","items":"244","type":"228"},{"default":0,"description":"245","type":"225"},{"default":true,"description":"246","type":"241"},{"default":true,"description":"247","type":"241"},{"additionalProperties":false,"description":"248","properties":"249","type":"126"},{"description":"250","type":"102"},{"description":"251","type":"225","default":0},{"description":"252","items":"253","type":"228"},{"description":"254","items":"255","type":"228"},{"default":true,"description":"256","type":"241"},{"description":"257","items":"258","type":"228"},{"description":"259","type":"225"},"7731370d39d3b","14ef9b59167d1","DuplicateApiKey",{"message":"177","status":401},"Duplicate API key found","4a3b7af988b71","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","d68d0c922d8fa","NoAPIKey",{"message":"260","status":401},"No API key found",{"type":"225"},{"type":"102"},"status","message","470b68e5f0549","bfe96a0a61b3e","Create a route",{"name":"144","protocols":"261","methods":"262","hosts":"263","paths":"264","headers":"265","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"236","preserve_host":false,"request_buffering":true,"response_buffering":true,"tags":"266","service":"267"},{"name":"144","protocols":"268","methods":"269","hosts":"270","paths":"271","headers":"272","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"236","preserve_host":false,"request_buffering":true,"response_buffering":true,"snis":"273","sources":"274","destinations":"275","tags":"276","service":"277"},{"type":"102","description":"278"},{"type":"228","description":"279","items":"280"},{"type":"228","description":"281","items":"282"},{"type":"228","description":"283","items":"284"},{"type":"228","description":"285","items":"286"},{"type":"126","description":"287","properties":"288"},{"type":"225","description":"289","default":426,"enum":"290","examples":"291"},{"type":"225","description":"292","default":0,"examples":"293"},{"type":"241","description":"294","default":true},{"type":"102","description":"295","enum":"296","examples":"297"},{"type":"241","description":"298","default":true},{"type":"241","default":true,"description":"299"},{"type":"241","default":true,"description":"300"},{"type":"228","description":"301","items":"302"},{"type":"228","description":"303","items":"304"},{"type":"228","description":"305","items":"306"},{"type":"228","description":"307","items":"308"},{"type":"309","description":"310","properties":"311"},"protocols","https_redirect_status_code","preserve_host","request_buffering","response_buffering","8d186f937045e",["312","313"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["314","315"],{"id":"316"},"Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"317","type":"126"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"102"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"102"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"102"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["120","146"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"102"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"318"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"102"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"319","type":"126"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"102"},"Unix epoch when the resource was last updated.","No API key found in request",["120","146"],["320","321"],["322","323"],["324","325"],{"x-my-header":"326","x-another-header":"327"},["328","329"],{"id":"330"},["120","146"],["320","321"],["322","323"],["324","325"],{"x-my-header":"331","x-another-header":"332"},["323","322"],["333","334","335"],["336","337","338"],["328","329"],{"id":"330"},"The name of the route. Route names must be unique, and they are case sensitive. For example, there can be two different routes named \"test\" and \"Test\".\n","An array of the protocols this route should allow",{"type":"102","default":"146","examples":"339"},"A list of HTTP methods that match this route.\n",{"type":"102","examples":"340"},"A list of domain names that match this route. Note that the hosts value is case sensitive. With form-encoded, the notation is `hosts[]=example.com&hosts[]=foo.test`. With JSON, use an Array.",{"type":"102"},"A list of paths that match this route. With form-encoded, the notation is `paths[]=/foo&paths[]=/bar`. With JSON, use an array. The path can be a regular expression, or a plain text pattern.",{"type":"102"},"One or more lists of values indexed by header name that will cause this route to match if present in the request. The Host header cannot be used with this attribute hosts should be specified using the `hosts` attribute. When headers contains only one value and that value starts with the special prefix` ~*`, the value is interpreted as a regular expression.",{"x-my-header":"341","x-another-header":"342"},"The status code Kong responds with when all properties of a route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`\nLocation header is injected by Kong if the field is set to `301`, `302`, `307` or `308`. Note: This config applies only if the route is configured to only accept the https protocol. Accepted values are: `426`, `301`, `302`, `307`, `308`. Default: `426`.",[426,301,302,307,308],[426],"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).",[0],"When matching a route via one of the paths, strip the matching prefix from the upstream request URL.","Controls how the service path, route path and requested path are combined when sending a request to the upstream. Accepted values are \"`v0`\", \"`v1`\".",["343","236"],["236"],"When matching a route via one of the `hosts` domain names, use the request `host` header in the upstream request headers. If set to `false`, the upstream Host header will be that of the service's host.","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding. Default: true.\n","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding. Default: `true`.\n","A list of SNIs that match this route when using stream routing.\n",{"type":"102"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"126","properties":"344"},"A list of IP destinations of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"126","properties":"345"},"An optional set of strings associated with the route for grouping and filtering.\n",{"type":"102"},["126","346"],"The service this route is associated to. This is where the route proxies traffic to. With form-encoded, the notation is service.id=<service id> or service.name=<service name>. With JSON, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",{"id":"347"},"foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"348"},{"type":"102"},{"default":"349"},"GET","POST","example.com","foo.test","/foo","/bar",["350","351"],["352"],"user-level","low-priority","af8330d3-dbdc-48bd-b1be-55b98608834b",["350","351"],["352"],{"ip":"353","port":1234},{"ip":"354"},{"port":9123},{"ip":"353","port":1234},{"ip":"354"},{"port":9123},["355"],["320"],{"type":"228","items":"356"},{"type":"228","items":"357"},"v1",{"ip":"358","port":"359"},{"ip":"360","port":"361"},"null",{"type":"102","examples":"362"},{},{},"foo","bar","bla","10.1.0.0/16","10.2.2.2","tcp",{"type":"102"},{"type":"102"},{"type":"102","examples":"363"},{"type":"225","examples":"364"},{"type":"102","examples":"365"},{"type":"225"},["330"],["353"],[1234],["366"],"0.1.0.0/16"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-routes-with-service-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all routes associated with a Service in a workspace",["17"],"2680e4d845e91","get","/{workspace}/services/{service_id_or_name}/routes",["18"],{},"list-routes-with-service-workspace","inheritedFromService",["19"],{"headers":"20","query":"21","cookie":"22","path":"23"},["24"],["25"],"Routes",{"id":"26","name":"17"},{"id":"27","code":"28","headers":"29","contents":"30","description":"31"},[],["32","33","34"],[],["35","36"],["37"],{"id":"38","url":"39","name":"40","description":"41","variables":"42"},"062e7c14e65ff","ab624a994cbc6","200",[],["43"],"A successful response listing routes",{"id":"44","name":"45","style":"46","examples":"47","description":"48","schema":"49","explicitProperties":"50"},{"id":"51","name":"52","style":"46","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"46","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"65","examples":"66","description":"67","required":true,"schema":"68","explicitProperties":"69"},{"id":"70","name":"71","style":"65","examples":"72","description":"73","required":true,"schema":"74","explicitProperties":"75"},{"id":"76","key":"77","extensions":"78","description":"79","type":"80","name":"81","in":"82"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"83","path":"84","port":"85","protocol":"86"},{"id":"87","mediaType":"88","examples":"89","encodings":"90","schema":"91"},"ebd0a1b0c9cbf","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"92","$schema":"93","x-stoplight":"94"},["95","96","97","98","99"],"d4ae2d6cb0b26","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"100","$schema":"93","x-stoplight":"101"},["95","96","97","98","99"],"ac74580187655","tags",["102"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"100","examples":"103","x-stoplight":"104","$schema":"93"},["95","105","96","97","98","99"],"0b3e582391658","workspace","simple",[],"Name or ID of workspace",{"type":"100","examples":"106","$schema":"93","x-stoplight":"107"},["97","96","108","98","95","99"],"3bdc2af229388","service_id_or_name",["109"],"ID **or** name of the service to lookup",{"type":"100","examples":"110","$schema":"93","x-stoplight":"111"},["97","95","105","96","108","98","99"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"112","description":"113"},{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119","enum":"120"},"6d4fd654c49fe","application/json",["121"],[],{"description":"122","properties":"123","type":"124","title":"125","examples":"126"},"integer","http://json-schema.org/draft-07/schema#",{"id":"127"},"description","in","name","schema","title","string",{"id":"128"},{"id":"129","value":"130","key":"131"},["130"],{"explicitProperties":"132","id":"133"},"example",["134"],{"id":"135"},"required",{"id":"136","value":"137","key":"131"},["137"],{"id":"138"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["118","139"],{"id":"140","value":"141","key":"131"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"142","destinations":"143","headers":"144","hosts":"145","https_redirect_status_code":"146","id":"147","methods":"148","name":"149","path_handling":"150","paths":"151","preserve_host":"152","protocols":"153","regex_priority":"154","request_buffering":"155","response_buffering":"156","service":"157","expression":"158","priority":"159","snis":"160","sources":"161","strip_path":"162","tags":"163","updated_at":"164"},"object","Route",["141"],"6e7a414dbe1a4","f1a0746b72ba1","1ba8d2efe9ba3","tag1,tag2","default",["165","166","167"],"c2619fc4d84b4","team-a","5666cdf358537","8bd92821cb4d2","test-service","e2ae4e252b2ba","https","00840588cdf40",{"hosts":"168","id":"169","name":"170","paths":"171","service":"172"},{"description":"173","type":"92"},{"description":"174","items":"175","type":"176"},{"description":"177","type":"124"},{"description":"178","items":"179","type":"176"},{"default":426,"description":"180","type":"92"},{"type":"100"},{"description":"181","items":"182","type":"176"},{"description":"183","type":"100"},{"default":"184","description":"185","type":"100"},{"description":"186","items":"187","type":"176"},{"default":false,"description":"188","type":"189"},{"default":"190","description":"191","items":"192","type":"176"},{"default":0,"description":"193","type":"92"},{"default":true,"description":"194","type":"189"},{"default":true,"description":"195","type":"189"},{"additionalProperties":false,"description":"196","properties":"197","type":"124"},{"description":"198","type":"100"},{"description":"199","type":"92","default":0},{"description":"200","items":"201","type":"176"},{"description":"202","items":"203","type":"176"},{"default":true,"description":"204","type":"189"},{"description":"205","items":"206","type":"176"},{"description":"207","type":"92"},"type","nullable","examples",["208","209"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["210","211"],{"id":"212"},"Unix epoch when the resource was created.","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"213","type":"124"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"100"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"100"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"100"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["118","139"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"100"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"214"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"100"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"215","type":"124"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"100"},"Unix epoch when the resource was last updated.","foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"216"},{"type":"100"},{"default":"217"},{},{}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-route-with-service-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new route associated with a Service in a workspace",["17"],"14b2b2298d245","post","/{workspace}/services/{service_id_or_name}/routes",["18"],{},"create-route-with-service-workspace","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Routes",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48","49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"062e7c14e65ff","117562b3f68be","200",[],["56"],"Successfully created route","ded5633fa6dd4","400",[],["57"],"Invalid route","dee5633fa6f87","401",[],["58"],"Unauthorized","233c787e9becf",["59"],"Route request body",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","name":"68","style":"62","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","key":"74","extensions":"75","description":"76","type":"77","name":"78","in":"79"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"80","path":"81","port":"82","protocol":"83"},{"id":"84","mediaType":"85","examples":"86","encodings":"87","schema":"88"},{"id":"89","mediaType":"85","examples":"90","encodings":"91","schema":"92"},{"id":"93","mediaType":"85","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"85","examples":"98","encodings":"99","schema":"100"},"b72fc99e0ab63","workspace","simple",[],"Name or ID of workspace",{"type":"101","examples":"102","$schema":"103","x-stoplight":"104"},["105","106","107","108","109","110"],"19ce3bef15ed4","service_id_or_name",["111"],"ID **or** name of the service to lookup",{"type":"101","examples":"112","$schema":"103","x-stoplight":"113"},["105","109","114","106","107","108","110"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120"},{"default":"121","description":"122","enum":"123"},"67f73d5f0be1a","application/json",["124"],[],{"description":"125","properties":"126","type":"127","title":"128","examples":"129"},"5264b3e6217b5",[],[],{"type":"127","$schema":"103","x-stoplight":"130"},"e75606d95f2f3",["131","132","133"],[],{"type":"127","properties":"134","required":"135","title":"136","$schema":"103","x-stoplight":"137"},"c185e61d8160b",["138"],[],{"type":"127","x-examples":"139","properties":"140","required":"141","$schema":"103","x-stoplight":"142"},"string",["143"],"http://json-schema.org/draft-07/schema#",{"id":"144"},"name","in","required","schema","description","title",{"id":"145","value":"146","key":"147"},["146"],{"id":"148"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["121","149"],{"id":"150","value":"151","key":"147"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"152","destinations":"153","headers":"154","hosts":"155","https_redirect_status_code":"156","id":"157","methods":"158","name":"159","path_handling":"160","paths":"161","preserve_host":"162","protocols":"163","regex_priority":"164","request_buffering":"165","response_buffering":"166","service":"167","expression":"168","priority":"169","snis":"170","sources":"171","strip_path":"172","tags":"173","updated_at":"174"},"object","Route",["151"],{"id":"175"},{"id":"176","key":"177","value":"178","summary":"179"},{"id":"180","key":"181","value":"182","summary":"183"},{"id":"184","key":"185","value":"186","summary":"187"},{"status":"188","message":"189"},["190","191"],"UnauthorizedError",{"id":"192"},{"id":"193","key":"194","value":"195"},{"Example 1":"196"},{"name":"197","protocols":"198","methods":"199","hosts":"200","paths":"201","headers":"202","https_redirect_status_code":"203","regex_priority":"204","strip_path":"205","path_handling":"206","preserve_host":"207","request_buffering":"208","response_buffering":"209","snis":"210","sources":"211","destinations":"212","tags":"213","service":"214"},["215","216","217","218","219"],{"id":"220"},"team-a","3c3b416f45766","03df8c4ecf93b","test-service","default","5fdb1f8e93bef","https","089021040c0a2",{"hosts":"221","id":"222","name":"223","paths":"224","service":"225"},{"description":"226","type":"227"},{"description":"228","items":"229","type":"230"},{"description":"231","type":"127"},{"description":"232","items":"233","type":"230"},{"default":426,"description":"234","type":"227"},{"type":"101"},{"description":"235","items":"236","type":"230"},{"description":"237","type":"101"},{"default":"238","description":"239","type":"101"},{"description":"240","items":"241","type":"230"},{"default":false,"description":"242","type":"243"},{"default":"244","description":"245","items":"246","type":"230"},{"default":0,"description":"247","type":"227"},{"default":true,"description":"248","type":"243"},{"default":true,"description":"249","type":"243"},{"additionalProperties":false,"description":"250","properties":"251","type":"127"},{"description":"252","type":"101"},{"description":"253","type":"227","default":0},{"description":"254","items":"255","type":"230"},{"description":"256","items":"257","type":"230"},{"default":true,"description":"258","type":"243"},{"description":"259","items":"260","type":"230"},{"description":"261","type":"227"},"04968036bdd2d","bc6d9eabb078b","DuplicateApiKey",{"message":"179","status":401},"Duplicate API key found","8869abec2513d","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","40ffc98e3670b","NoAPIKey",{"message":"262","status":401},"No API key found",{"type":"227"},{"type":"101"},"status","message","470b68e5f0549","b675cc8dd6ca1","Create a route",{"name":"263","protocols":"264","methods":"265","hosts":"266","paths":"267","headers":"268","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"238","preserve_host":false,"request_buffering":true,"response_buffering":true,"tags":"269","service":"270"},{"name":"263","protocols":"271","methods":"272","hosts":"273","paths":"274","headers":"275","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"238","preserve_host":false,"request_buffering":true,"response_buffering":true,"snis":"276","sources":"277","destinations":"278","tags":"279","service":"280"},{"type":"101","description":"281"},{"type":"230","description":"282","items":"283"},{"type":"230","description":"284","items":"285"},{"type":"230","description":"286","items":"287"},{"type":"230","description":"288","items":"289"},{"type":"127","description":"290","properties":"291"},{"type":"227","description":"292","default":426,"enum":"293","examples":"294"},{"type":"227","description":"295","default":0,"examples":"296"},{"type":"243","description":"297","default":true},{"type":"101","description":"298","enum":"299","examples":"300"},{"type":"243","description":"301","default":true},{"type":"243","default":true,"description":"302"},{"type":"243","default":true,"description":"303"},{"type":"230","description":"304","items":"305"},{"type":"230","description":"306","items":"307"},{"type":"230","description":"308","items":"309"},{"type":"230","description":"310","items":"311"},{"type":"312","description":"313","properties":"314"},"protocols","https_redirect_status_code","preserve_host","request_buffering","response_buffering","8d186f937045e",["315","316"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["317","318"],{"id":"319"},"Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"320","type":"127"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"101"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"101"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"101"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["121","149"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"101"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"321"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"101"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"322","type":"127"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"101"},"Unix epoch when the resource was last updated.","No API key found in request","my-route",["121","149"],["323","324"],["325","326"],["327","328"],{"x-my-header":"329","x-another-header":"330"},["331","332"],{"id":"333"},["121","149"],["323","324"],["325","326"],["327","328"],{"x-my-header":"334","x-another-header":"335"},["326","325"],["336","337","338"],["339","340","341"],["331","332"],{"id":"333"},"The name of the route. Route names must be unique, and they are case sensitive. For example, there can be two different routes named \"test\" and \"Test\".\n","An array of the protocols this route should allow",{"type":"101","default":"149","examples":"342"},"A list of HTTP methods that match this route.\n",{"type":"101","examples":"343"},"A list of domain names that match this route. Note that the hosts value is case sensitive. With form-encoded, the notation is `hosts[]=example.com&hosts[]=foo.test`. With JSON, use an Array.",{"type":"101"},"A list of paths that match this route. With form-encoded, the notation is `paths[]=/foo&paths[]=/bar`. With JSON, use an array. The path can be a regular expression, or a plain text pattern.",{"type":"101"},"One or more lists of values indexed by header name that will cause this route to match if present in the request. The Host header cannot be used with this attribute hosts should be specified using the `hosts` attribute. When headers contains only one value and that value starts with the special prefix` ~*`, the value is interpreted as a regular expression.",{"x-my-header":"344","x-another-header":"345"},"The status code Kong responds with when all properties of a route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`\nLocation header is injected by Kong if the field is set to `301`, `302`, `307` or `308`. Note: This config applies only if the route is configured to only accept the https protocol. Accepted values are: `426`, `301`, `302`, `307`, `308`. Default: `426`.",[426,301,302,307,308],[426],"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).",[0],"When matching a route via one of the paths, strip the matching prefix from the upstream request URL.","Controls how the service path, route path and requested path are combined when sending a request to the upstream. Accepted values are \"`v0`\", \"`v1`\".",["346","238"],["238"],"When matching a route via one of the `hosts` domain names, use the request `host` header in the upstream request headers. If set to `false`, the upstream Host header will be that of the service's host.","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding. Default: true.\n","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding. Default: `true`.\n","A list of SNIs that match this route when using stream routing.\n",{"type":"101"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"127","properties":"347"},"A list of IP destinations of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"127","properties":"348"},"An optional set of strings associated with the route for grouping and filtering.\n",{"type":"101"},["127","349"],"The service this route is associated to. This is where the route proxies traffic to. With form-encoded, the notation is service.id=<service id> or service.name=<service name>. With JSON, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",{"id":"350"},"foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"351"},{"type":"101"},{"default":"352"},"GET","POST","example.com","foo.test","/foo","/bar",["353","354"],["355"],"user-level","low-priority","af8330d3-dbdc-48bd-b1be-55b98608834b",["353","354"],["355"],{"ip":"356","port":1234},{"ip":"357"},{"port":9123},{"ip":"356","port":1234},{"ip":"357"},{"port":9123},["358"],["323"],{"type":"230","items":"359"},{"type":"230","items":"360"},"v1",{"ip":"361","port":"362"},{"ip":"363","port":"364"},"null",{"type":"101","examples":"365"},{},{},"foo","bar","bla","10.1.0.0/16","10.2.2.2","tcp",{"type":"101"},{"type":"101"},{"type":"101","examples":"366"},{"type":"227","examples":"367"},{"type":"101","examples":"368"},{"type":"227"},["333"],["356"],[1234],["369"],"0.1.0.0/16"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-route-with-service-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a route associated with a Service in a workspace",["18"],"a3373fd9d7daf","delete","/{workspace}/services/{service_id_or_name}/routes/{route_id_or_name}",["19"],{},"delete-route-with-service-workspace","Delete a route associated with a Service using ID or name in a workspace.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Routes",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40","41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"062e7c14e65ff","c5657374a33ff","204",[],[],"Successfully deleted route or the resource didn't exist","303572e334a53","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","required":true,"schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"51","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},"7129bda81b65a","workspace","simple",[],"Name or ID of workspace",{"type":"84","examples":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92","93"],"7b86f21d267b9","service_id_or_name",["94"],"ID **or** name of the service to lookup",{"type":"84","examples":"95","$schema":"86","x-stoplight":"96"},["88","92","97","89","90","91","93"],"9758ca536cd00","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"84","examples":"98","$schema":"86","x-stoplight":"99"},["88","89","90","91","92","93"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107","enum":"108"},"c237ee41e585b","application/json",["109","110","111"],[],{"type":"112","properties":"113","required":"114","title":"115","$schema":"86","x-stoplight":"116"},"string",["117"],"http://json-schema.org/draft-07/schema#",{"id":"118"},"name","in","required","schema","description","title",{"id":"119","value":"120","key":"121"},["120"],{"id":"122"},"example",["123"],{"id":"124"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["106","125"],{"id":"126","key":"127","value":"128","summary":"129"},{"id":"130","key":"131","value":"132","summary":"133"},{"id":"134","key":"135","value":"136","summary":"137"},"object",{"status":"138","message":"139"},["140","141"],"UnauthorizedError",{"id":"142"},"team-a","34159f92c0771","13ed010d5c931","test-service","default","4890dba6667f6","my-route","5db3ad90d4584","https","2b7a4b0f41815","DuplicateApiKey",{"message":"129","status":401},"Duplicate API key found","05674e02445ff","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","4023aa7ad989b","NoAPIKey",{"message":"143","status":401},"No API key found",{"type":"144"},{"type":"84"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/fetch-route-with-service-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a route associated with a Service in a workspace",["18"],"08e49d58a525e","get","/{workspace}/services/{service_id_or_name}/routes/{route_id_or_name}",["19"],{},"fetch-route-with-service-workspace","Get a route associated with a Service using ID or name in a workspace.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Routes",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46","47"],["48"],{"id":"49","url":"50","name":"51","description":"52","variables":"53"},"062e7c14e65ff","ecacde674870f","200",[],["54"],"Successfully fetched route","ba1cdef2f8c35","401",[],["55"],"Unauthorized","b9ccdef2f84ba","404",[],[],"Resource does not exist",{"id":"56","name":"57","style":"58","examples":"59","description":"60","required":true,"schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"58","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"58","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","key":"76","extensions":"77","description":"78","type":"79","name":"80","in":"81"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"82","path":"83","port":"84","protocol":"85"},{"id":"86","mediaType":"87","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"87","examples":"92","encodings":"93","schema":"94"},"4a21d79151d4d","workspace","simple",[],"Name or ID of workspace",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"272ef22a0e6f2","service_id_or_name",["105"],"ID **or** name of the service to lookup",{"type":"95","examples":"106","$schema":"97","x-stoplight":"107"},["99","103","108","100","101","102","104"],"32b044f90ecee","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"95","examples":"109","$schema":"97","x-stoplight":"110"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"111","description":"112"},{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118","enum":"119"},"15e30f46b47e8","application/json",["120"],[],{"description":"121","properties":"122","type":"123","title":"124","examples":"125"},"2820f62c16ab3",["126","127","128"],[],{"type":"123","properties":"129","required":"130","title":"131","$schema":"97","x-stoplight":"132"},"string",["133"],"http://json-schema.org/draft-07/schema#",{"id":"134"},"name","in","required","schema","description","title",{"id":"135","value":"136","key":"137"},["136"],{"id":"138"},"example",["139"],{"id":"140"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["117","141"],{"id":"142","value":"143","key":"137"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"144","destinations":"145","headers":"146","hosts":"147","https_redirect_status_code":"148","id":"149","methods":"150","name":"151","path_handling":"152","paths":"153","preserve_host":"154","protocols":"155","regex_priority":"156","request_buffering":"157","response_buffering":"158","service":"159","expression":"160","priority":"161","snis":"162","sources":"163","strip_path":"164","tags":"165","updated_at":"166"},"object","Route",["143"],{"id":"167","key":"168","value":"169","summary":"170"},{"id":"171","key":"172","value":"173","summary":"174"},{"id":"175","key":"176","value":"177","summary":"178"},{"status":"179","message":"180"},["181","182"],"UnauthorizedError",{"id":"183"},"team-a","e20594878f513","35fe09e30d2ed","test-service","default","ec3e2609239ab","my-route","454e25b1d93c6","https","9d4421815e65b",{"hosts":"184","id":"185","name":"186","paths":"187","service":"188"},{"description":"189","type":"190"},{"description":"191","items":"192","type":"193"},{"description":"194","type":"123"},{"description":"195","items":"196","type":"193"},{"default":426,"description":"197","type":"190"},{"type":"95"},{"description":"198","items":"199","type":"193"},{"description":"200","type":"95"},{"default":"201","description":"202","type":"95"},{"description":"203","items":"204","type":"193"},{"default":false,"description":"205","type":"206"},{"default":"207","description":"208","items":"209","type":"193"},{"default":0,"description":"210","type":"190"},{"default":true,"description":"211","type":"206"},{"default":true,"description":"212","type":"206"},{"additionalProperties":false,"description":"213","properties":"214","type":"123"},{"description":"215","type":"95"},{"description":"216","type":"190","default":0},{"description":"217","items":"218","type":"193"},{"description":"219","items":"220","type":"193"},{"default":true,"description":"221","type":"206"},{"description":"222","items":"223","type":"193"},{"description":"224","type":"190"},"5db8a9e75d0e9","DuplicateApiKey",{"message":"170","status":401},"Duplicate API key found","4fd80f667a07c","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","235824bfea01e","NoAPIKey",{"message":"225","status":401},"No API key found",{"type":"190"},{"type":"95"},"status","message","470b68e5f0549",["226","227"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["228","229"],{"id":"230"},"Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"231","type":"123"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"95"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"95"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"95"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["117","141"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"95"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"232"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"95"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"233","type":"123"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"95"},"Unix epoch when the resource was last updated.","No API key found in request","foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"234"},{"type":"95"},{"default":"235"},{},{}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-route-with-service-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a route associated with a Service in a workspace",["18"],"6c5a2da694001","patch","/{workspace}/services/{service_id_or_name}/routes/{route_id_or_name}",["19"],{},"update-route-with-service-workspace","Update a route associated with a Service using ID or name in a workspace.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"Routes",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55","56","57"],["58"],{"id":"59","url":"60","name":"61","description":"62","variables":"63"},"062e7c14e65ff","57612f6a661ce","200",[],["64"],"Successfully updated route","af81314729fd6","400",[],["65"],"Invalid route","af71314729e01","401",[],["66"],"Unauthorized","af4131472852a","404",[],[],"Resource does not exist","0e9bec583bd97",["67"],"Route request body",{"id":"68","name":"69","style":"70","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","name":"76","style":"70","examples":"77","description":"78","required":true,"schema":"79","explicitProperties":"80"},{"id":"81","name":"82","style":"70","examples":"83","description":"84","required":true,"schema":"85","explicitProperties":"86"},{"id":"87","key":"88","extensions":"89","description":"90","type":"91","name":"92","in":"93"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"94","path":"95","port":"96","protocol":"97"},{"id":"98","mediaType":"99","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"99","examples":"104","encodings":"105","schema":"106"},{"id":"107","mediaType":"99","examples":"108","encodings":"109","schema":"110"},{"id":"111","mediaType":"99","examples":"112","encodings":"113","schema":"114"},"f980b76d54b16","workspace","simple",[],"Name or ID of workspace",{"type":"115","examples":"116","$schema":"117","x-stoplight":"118"},["119","120","121","122","123","124"],"b014ce90782fd","service_id_or_name",["125"],"ID **or** name of the service to lookup",{"type":"115","examples":"126","$schema":"117","x-stoplight":"127"},["119","123","128","120","121","122","124"],"9ec85423d1c23","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"115","examples":"129","$schema":"117","x-stoplight":"130"},["119","120","121","122","123","124"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"131","description":"132"},{"default":"133","description":"134"},{"default":"135","description":"136"},{"default":"137","description":"138","enum":"139"},"0980705d5a5b8","application/json",["140"],[],{"description":"141","properties":"142","type":"143","title":"144","examples":"145"},"9cdb9156d0620",[],[],{"type":"143","$schema":"117","x-stoplight":"146"},"ff5a3d34e71d9",["147","148","149"],[],{"type":"143","properties":"150","required":"151","title":"152","$schema":"117","x-stoplight":"153"},"73613590ae7ad",["154"],[],{"type":"143","x-examples":"155","properties":"156","required":"157","$schema":"117","x-stoplight":"158"},"string",["159"],"http://json-schema.org/draft-07/schema#",{"id":"160"},"name","in","required","schema","description","title",{"id":"161","value":"162","key":"163"},["162"],{"id":"164"},"example",["165"],{"id":"166"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["137","167"],{"id":"168","value":"169","key":"163"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"170","destinations":"171","headers":"172","hosts":"173","https_redirect_status_code":"174","id":"175","methods":"176","name":"177","path_handling":"178","paths":"179","preserve_host":"180","protocols":"181","regex_priority":"182","request_buffering":"183","response_buffering":"184","service":"185","expression":"186","priority":"187","snis":"188","sources":"189","strip_path":"190","tags":"191","updated_at":"192"},"object","Route",["169"],{"id":"193"},{"id":"194","key":"195","value":"196","summary":"197"},{"id":"198","key":"199","value":"200","summary":"201"},{"id":"202","key":"203","value":"204","summary":"205"},{"status":"206","message":"207"},["208","209"],"UnauthorizedError",{"id":"210"},{"id":"211","key":"212","value":"213"},{"Example 1":"214"},{"name":"215","protocols":"216","methods":"217","hosts":"218","paths":"219","headers":"220","https_redirect_status_code":"221","regex_priority":"222","strip_path":"223","path_handling":"224","preserve_host":"225","request_buffering":"226","response_buffering":"227","snis":"228","sources":"229","destinations":"230","tags":"231","service":"232"},["233","234","235","236","237"],{"id":"238"},"team-a","6c4e1fa3b6fdf","0a273741fc0cb","test-service","default","780767ef89918","my-route","86a5ad23bbc1b","https","e62ee1dc3f502",{"hosts":"239","id":"240","name":"241","paths":"242","service":"243"},{"description":"244","type":"245"},{"description":"246","items":"247","type":"248"},{"description":"249","type":"143"},{"description":"250","items":"251","type":"248"},{"default":426,"description":"252","type":"245"},{"type":"115"},{"description":"253","items":"254","type":"248"},{"description":"255","type":"115"},{"default":"256","description":"257","type":"115"},{"description":"258","items":"259","type":"248"},{"default":false,"description":"260","type":"261"},{"default":"262","description":"263","items":"264","type":"248"},{"default":0,"description":"265","type":"245"},{"default":true,"description":"266","type":"261"},{"default":true,"description":"267","type":"261"},{"additionalProperties":false,"description":"268","properties":"269","type":"143"},{"description":"270","type":"115"},{"description":"271","type":"245","default":0},{"description":"272","items":"273","type":"248"},{"description":"274","items":"275","type":"248"},{"default":true,"description":"276","type":"261"},{"description":"277","items":"278","type":"248"},{"description":"279","type":"245"},"5d99ec00f0378","ba76abab5e1b5","DuplicateApiKey",{"message":"197","status":401},"Duplicate API key found","83dfc1917d79c","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","0e79f10ad5913","NoAPIKey",{"message":"280","status":401},"No API key found",{"type":"245"},{"type":"115"},"status","message","470b68e5f0549","2b4d1f46a6a0a","Create a route",{"name":"165","protocols":"281","methods":"282","hosts":"283","paths":"284","headers":"285","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"256","preserve_host":false,"request_buffering":true,"response_buffering":true,"tags":"286","service":"287"},{"name":"165","protocols":"288","methods":"289","hosts":"290","paths":"291","headers":"292","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"256","preserve_host":false,"request_buffering":true,"response_buffering":true,"snis":"293","sources":"294","destinations":"295","tags":"296","service":"297"},{"type":"115","description":"298"},{"type":"248","description":"299","items":"300"},{"type":"248","description":"301","items":"302"},{"type":"248","description":"303","items":"304"},{"type":"248","description":"305","items":"306"},{"type":"143","description":"307","properties":"308"},{"type":"245","description":"309","default":426,"enum":"310","examples":"311"},{"type":"245","description":"312","default":0,"examples":"313"},{"type":"261","description":"314","default":true},{"type":"115","description":"315","enum":"316","examples":"317"},{"type":"261","description":"318","default":true},{"type":"261","default":true,"description":"319"},{"type":"261","default":true,"description":"320"},{"type":"248","description":"321","items":"322"},{"type":"248","description":"323","items":"324"},{"type":"248","description":"325","items":"326"},{"type":"248","description":"327","items":"328"},{"type":"329","description":"330","properties":"331"},"protocols","https_redirect_status_code","preserve_host","request_buffering","response_buffering","8d186f937045e",["332","333"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["334","335"],{"id":"336"},"Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"337","type":"143"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"115"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"115"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"115"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["137","167"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"115"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"338"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"115"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"339","type":"143"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"115"},"Unix epoch when the resource was last updated.","No API key found in request",["137","167"],["340","341"],["342","343"],["344","345"],{"x-my-header":"346","x-another-header":"347"},["348","349"],{"id":"350"},["137","167"],["340","341"],["342","343"],["344","345"],{"x-my-header":"351","x-another-header":"352"},["343","342"],["353","354","355"],["356","357","358"],["348","349"],{"id":"350"},"The name of the route. Route names must be unique, and they are case sensitive. For example, there can be two different routes named \"test\" and \"Test\".\n","An array of the protocols this route should allow",{"type":"115","default":"167","examples":"359"},"A list of HTTP methods that match this route.\n",{"type":"115","examples":"360"},"A list of domain names that match this route. Note that the hosts value is case sensitive. With form-encoded, the notation is `hosts[]=example.com&hosts[]=foo.test`. With JSON, use an Array.",{"type":"115"},"A list of paths that match this route. With form-encoded, the notation is `paths[]=/foo&paths[]=/bar`. With JSON, use an array. The path can be a regular expression, or a plain text pattern.",{"type":"115"},"One or more lists of values indexed by header name that will cause this route to match if present in the request. The Host header cannot be used with this attribute hosts should be specified using the `hosts` attribute. When headers contains only one value and that value starts with the special prefix` ~*`, the value is interpreted as a regular expression.",{"x-my-header":"361","x-another-header":"362"},"The status code Kong responds with when all properties of a route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`\nLocation header is injected by Kong if the field is set to `301`, `302`, `307` or `308`. Note: This config applies only if the route is configured to only accept the https protocol. Accepted values are: `426`, `301`, `302`, `307`, `308`. Default: `426`.",[426,301,302,307,308],[426],"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).",[0],"When matching a route via one of the paths, strip the matching prefix from the upstream request URL.","Controls how the service path, route path and requested path are combined when sending a request to the upstream. Accepted values are \"`v0`\", \"`v1`\".",["363","256"],["256"],"When matching a route via one of the `hosts` domain names, use the request `host` header in the upstream request headers. If set to `false`, the upstream Host header will be that of the service's host.","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding. Default: true.\n","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding. Default: `true`.\n","A list of SNIs that match this route when using stream routing.\n",{"type":"115"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"143","properties":"364"},"A list of IP destinations of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"143","properties":"365"},"An optional set of strings associated with the route for grouping and filtering.\n",{"type":"115"},["143","366"],"The service this route is associated to. This is where the route proxies traffic to. With form-encoded, the notation is service.id=<service id> or service.name=<service name>. With JSON, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",{"id":"367"},"foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"368"},{"type":"115"},{"default":"369"},"GET","POST","example.com","foo.test","/foo","/bar",["370","371"],["372"],"user-level","low-priority","af8330d3-dbdc-48bd-b1be-55b98608834b",["370","371"],["372"],{"ip":"373","port":1234},{"ip":"374"},{"port":9123},{"ip":"373","port":1234},{"ip":"374"},{"port":9123},["375"],["340"],{"type":"248","items":"376"},{"type":"248","items":"377"},"v1",{"ip":"378","port":"379"},{"ip":"380","port":"381"},"null",{"type":"115","examples":"382"},{},{},"foo","bar","bla","10.1.0.0/16","10.2.2.2","tcp",{"type":"115"},{"type":"115"},{"type":"115","examples":"383"},{"type":"245","examples":"384"},{"type":"115","examples":"385"},{"type":"245"},["350"],["373"],[1234],["386"],"0.1.0.0/16"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-route-with-service-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a route associated with a Service in a workspace",["18"],"82663ce062df2","put","/{workspace}/services/{service_id_or_name}/routes/{route_id_or_name}",["19"],{},"upsert-route-with-service-workspace","Create or Update a route associated with a Service using ID or name in a workspace.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Routes",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50","51"],["52"],{"id":"53","url":"54","name":"55","description":"56","variables":"57"},"062e7c14e65ff","1f22bde024b4e","200",[],["58"],"Successfully upserted route","51c2bd5474827","400",[],["59"],"Invalid route","51d2bd5474fe8","401",[],["60"],"Unauthorized","0908e85c7e726",["61"],"Route request body",{"id":"62","name":"63","style":"64","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"64","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","name":"76","style":"64","examples":"77","description":"78","required":true,"schema":"79","explicitProperties":"80"},{"id":"81","key":"82","extensions":"83","description":"84","type":"85","name":"86","in":"87"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"88","path":"89","port":"90","protocol":"91"},{"id":"92","mediaType":"93","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"93","examples":"98","encodings":"99","schema":"100"},{"id":"101","mediaType":"93","examples":"102","encodings":"103","schema":"104"},{"id":"105","mediaType":"93","examples":"106","encodings":"107","schema":"108"},"b5822c19145b1","workspace","simple",[],"Name or ID of workspace",{"type":"109","examples":"110","$schema":"111","x-stoplight":"112"},["113","114","115","116","117","118"],"8dc0d5ce7e4a0","service_id_or_name",["119"],"ID **or** name of the service to lookup",{"type":"109","examples":"120","$schema":"111","x-stoplight":"121"},["113","117","122","114","115","116","118"],"c1b60be536f8e","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"109","examples":"123","$schema":"111","x-stoplight":"124"},["113","114","115","116","117","118"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"125","description":"126"},{"default":"127","description":"128"},{"default":"129","description":"130"},{"default":"131","description":"132","enum":"133"},"d17264e30bc33","application/json",["134"],[],{"description":"135","properties":"136","type":"137","title":"138","examples":"139"},"a3c70acd304df",[],[],{"type":"137","$schema":"111","x-stoplight":"140"},"d83b364681362",["141","142","143"],[],{"type":"137","properties":"144","required":"145","title":"146","$schema":"111","x-stoplight":"147"},"9a49cbc3b17cf",["148"],[],{"type":"137","x-examples":"149","properties":"150","required":"151","$schema":"111","x-stoplight":"152"},"string",["153"],"http://json-schema.org/draft-07/schema#",{"id":"154"},"name","in","required","schema","description","title",{"id":"155","value":"156","key":"157"},["156"],{"id":"158"},"example",["159"],{"id":"160"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["131","161"],{"id":"162","value":"163","key":"157"},"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"created_at":"164","destinations":"165","headers":"166","hosts":"167","https_redirect_status_code":"168","id":"169","methods":"170","name":"171","path_handling":"172","paths":"173","preserve_host":"174","protocols":"175","regex_priority":"176","request_buffering":"177","response_buffering":"178","service":"179","expression":"180","priority":"181","snis":"182","sources":"183","strip_path":"184","tags":"185","updated_at":"186"},"object","Route",["163"],{"id":"187"},{"id":"188","key":"189","value":"190","summary":"191"},{"id":"192","key":"193","value":"194","summary":"195"},{"id":"196","key":"197","value":"198","summary":"199"},{"status":"200","message":"201"},["202","203"],"UnauthorizedError",{"id":"204"},{"id":"205","key":"206","value":"207"},{"Example 1":"208"},{"name":"209","protocols":"210","methods":"211","hosts":"212","paths":"213","headers":"214","https_redirect_status_code":"215","regex_priority":"216","strip_path":"217","path_handling":"218","preserve_host":"219","request_buffering":"220","response_buffering":"221","snis":"222","sources":"223","destinations":"224","tags":"225","service":"226"},["227","228","229","230","231"],{"id":"232"},"team-a","fa901477c903a","1ce543f6405c0","test-service","default","c77a06c7adcae","my-route","3abb8856f9e4e","https","81bd0a8d0226c",{"hosts":"233","id":"234","name":"235","paths":"236","service":"237"},{"description":"238","type":"239"},{"description":"240","items":"241","type":"242"},{"description":"243","type":"137"},{"description":"244","items":"245","type":"242"},{"default":426,"description":"246","type":"239"},{"type":"109"},{"description":"247","items":"248","type":"242"},{"description":"249","type":"109"},{"default":"250","description":"251","type":"109"},{"description":"252","items":"253","type":"242"},{"default":false,"description":"254","type":"255"},{"default":"256","description":"257","items":"258","type":"242"},{"default":0,"description":"259","type":"239"},{"default":true,"description":"260","type":"255"},{"default":true,"description":"261","type":"255"},{"additionalProperties":false,"description":"262","properties":"263","type":"137"},{"description":"264","type":"109"},{"description":"265","type":"239","default":0},{"description":"266","items":"267","type":"242"},{"description":"268","items":"269","type":"242"},{"default":true,"description":"270","type":"255"},{"description":"271","items":"272","type":"242"},{"description":"273","type":"239"},"0b17e8cb04225","1cf4116e3c3cc","DuplicateApiKey",{"message":"191","status":401},"Duplicate API key found","c9ba8417b0bfd","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","9d233d24a7ef8","NoAPIKey",{"message":"274","status":401},"No API key found",{"type":"239"},{"type":"109"},"status","message","470b68e5f0549","fc5dbdb2a7cc3","Create a route",{"name":"159","protocols":"275","methods":"276","hosts":"277","paths":"278","headers":"279","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"250","preserve_host":false,"request_buffering":true,"response_buffering":true,"tags":"280","service":"281"},{"name":"159","protocols":"282","methods":"283","hosts":"284","paths":"285","headers":"286","https_redirect_status_code":426,"regex_priority":0,"strip_path":true,"path_handling":"250","preserve_host":false,"request_buffering":true,"response_buffering":true,"snis":"287","sources":"288","destinations":"289","tags":"290","service":"291"},{"type":"109","description":"292"},{"type":"242","description":"293","items":"294"},{"type":"242","description":"295","items":"296"},{"type":"242","description":"297","items":"298"},{"type":"242","description":"299","items":"300"},{"type":"137","description":"301","properties":"302"},{"type":"239","description":"303","default":426,"enum":"304","examples":"305"},{"type":"239","description":"306","default":0,"examples":"307"},{"type":"255","description":"308","default":true},{"type":"109","description":"309","enum":"310","examples":"311"},{"type":"255","description":"312","default":true},{"type":"255","default":true,"description":"313"},{"type":"255","default":true,"description":"314"},{"type":"242","description":"315","items":"316"},{"type":"242","description":"317","items":"318"},{"type":"242","description":"319","items":"320"},{"type":"242","description":"321","items":"322"},{"type":"323","description":"324","properties":"325"},"protocols","https_redirect_status_code","preserve_host","request_buffering","response_buffering","8d186f937045e",["326","327"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["328","329"],{"id":"330"},"Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"331","type":"137"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"109"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","A list of HTTP methods that match this Route.",{"type":"109"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"109"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["131","161"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"109"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"332"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"109"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"333","type":"137"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"109"},"Unix epoch when the resource was last updated.","No API key found in request",["131","161"],["334","335"],["336","337"],["338","339"],{"x-my-header":"340","x-another-header":"341"},["342","343"],{"id":"344"},["131","161"],["334","335"],["336","337"],["338","339"],{"x-my-header":"345","x-another-header":"346"},["337","336"],["347","348","349"],["350","351","352"],["342","343"],{"id":"344"},"The name of the route. Route names must be unique, and they are case sensitive. For example, there can be two different routes named \"test\" and \"Test\".\n","An array of the protocols this route should allow",{"type":"109","default":"161","examples":"353"},"A list of HTTP methods that match this route.\n",{"type":"109","examples":"354"},"A list of domain names that match this route. Note that the hosts value is case sensitive. With form-encoded, the notation is `hosts[]=example.com&hosts[]=foo.test`. With JSON, use an Array.",{"type":"109"},"A list of paths that match this route. With form-encoded, the notation is `paths[]=/foo&paths[]=/bar`. With JSON, use an array. The path can be a regular expression, or a plain text pattern.",{"type":"109"},"One or more lists of values indexed by header name that will cause this route to match if present in the request. The Host header cannot be used with this attribute hosts should be specified using the `hosts` attribute. When headers contains only one value and that value starts with the special prefix` ~*`, the value is interpreted as a regular expression.",{"x-my-header":"355","x-another-header":"356"},"The status code Kong responds with when all properties of a route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`\nLocation header is injected by Kong if the field is set to `301`, `302`, `307` or `308`. Note: This config applies only if the route is configured to only accept the https protocol. Accepted values are: `426`, `301`, `302`, `307`, `308`. Default: `426`.",[426,301,302,307,308],[426],"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).",[0],"When matching a route via one of the paths, strip the matching prefix from the upstream request URL.","Controls how the service path, route path and requested path are combined when sending a request to the upstream. Accepted values are \"`v0`\", \"`v1`\".",["357","250"],["250"],"When matching a route via one of the `hosts` domain names, use the request `host` header in the upstream request headers. If set to `false`, the upstream Host header will be that of the service's host.","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding. Default: true.\n","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding. Default: `true`.\n","A list of SNIs that match this route when using stream routing.\n",{"type":"109"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"137","properties":"358"},"A list of IP destinations of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".\n",{"type":"137","properties":"359"},"An optional set of strings associated with the route for grouping and filtering.\n",{"type":"109"},["137","360"],"The service this route is associated to. This is where the route proxies traffic to. With form-encoded, the notation is service.id=<service id> or service.name=<service name>. With JSON, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",{"id":"361"},"foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218",{"default":"362"},{"type":"109"},{"default":"363"},"GET","POST","example.com","foo.test","/foo","/bar",["364","365"],["366"],"user-level","low-priority","af8330d3-dbdc-48bd-b1be-55b98608834b",["364","365"],["366"],{"ip":"367","port":1234},{"ip":"368"},{"port":9123},{"ip":"367","port":1234},{"ip":"368"},{"port":9123},["369"],["334"],{"type":"242","items":"370"},{"type":"242","items":"371"},"v1",{"ip":"372","port":"373"},{"ip":"374","port":"375"},"null",{"type":"109","examples":"376"},{},{},"foo","bar","bla","10.1.0.0/16","10.2.2.2","tcp",{"type":"109"},{"type":"109"},{"type":"109","examples":"377"},{"type":"239","examples":"378"},{"type":"109","examples":"379"},{"type":"239"},["344"],["367"],[1234],["380"],"0.1.0.0/16"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-plugins-with-consumer",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all plugins associated with a consumer",["18"],"2b2a3f57aaed7","get","/consumers/{consumer_username_or_id}/plugins",["19"],{},"list-plugins-with-consumer","Retrieve a list of all plugins associated with a consumer.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Plugins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40","41"],[],["42"],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"c26fb55b0a58f","ab276354b6131","200",[],["49"],"A successful response listing plugins","033765317816b","401",[],["50"],"Unauthorized",{"id":"51","name":"52","style":"53","examples":"54","description":"55","schema":"56","explicitProperties":"57"},{"id":"58","name":"59","style":"53","examples":"60","description":"61","schema":"62","explicitProperties":"63"},{"id":"64","name":"65","style":"53","examples":"66","description":"67","schema":"68","explicitProperties":"69"},{"id":"70","name":"71","style":"72","examples":"73","description":"74","required":true,"schema":"75","explicitProperties":"76"},{"id":"77","key":"78","extensions":"79","description":"80","type":"81","name":"82","in":"83"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"84","path":"85","port":"86","protocol":"87"},{"id":"88","mediaType":"89","examples":"90","encodings":"91","schema":"92"},{"id":"93","mediaType":"89","examples":"94","encodings":"95","schema":"96"},"65018ee7078d1","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"97","$schema":"98","x-stoplight":"99"},["100","101","102","103","104"],"201492b40bf6e","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"105","$schema":"98","x-stoplight":"106"},["100","101","102","103","104"],"d9e01084509e4","tags",["107"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"105","examples":"108","x-stoplight":"109","$schema":"98"},["100","110","101","102","103","104"],"60b7ececf0bd5","consumer_username_or_id","simple",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"105","examples":"111","$schema":"98","x-stoplight":"112"},["102","101","113","103","100","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121","enum":"122"},"261282a76e017","application/json",[],[],{"properties":"123","$schema":"98","x-stoplight":"124"},"3469b1229d947",["125","126","127"],[],{"type":"128","properties":"129","required":"130","title":"131","$schema":"98","x-stoplight":"132"},"integer","http://json-schema.org/draft-07/schema#",{"id":"133"},"description","in","name","schema","title","string",{"id":"134"},{"id":"135","value":"136","key":"137"},["136"],{"explicitProperties":"138","id":"139"},"example",["140"],{"id":"141"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["120","142"],{"data":"143","offset":"144"},{"id":"145"},{"id":"146","key":"147","value":"148","summary":"149"},{"id":"150","key":"151","value":"152","summary":"153"},{"id":"154","key":"155","value":"156","summary":"157"},"object",{"status":"158","message":"159"},["160","161"],"UnauthorizedError",{"id":"162"},"7ad4caeb318ef","ab04a801a017c","4455a7bc43cd0","tag1,tag2","default",["163","164","165"],"efacbd45bb5a8","my-username","14574ce8b6393","https",{"items":"166","type":"167"},{"description":"168","type":"105","title":"169"},"96f954df88f73","0d6b1d11be4d1","DuplicateApiKey",{"message":"149","status":401},"Duplicate API key found","ee91209dffd78","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","edd1fced23a40","NoAPIKey",{"message":"170","status":401},"No API key found",{"type":"97"},{"type":"105"},"status","message","470b68e5f0549","type","nullable","examples",{"description":"171","properties":"172","type":"128","title":"173","examples":"174"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","No API key found in request","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":"175","consumer":"176","consumer_group":"177","created_at":"178","enabled":"179","id":"180","name":"181","ordering":"182","protocols":"183","route":"184","service":"185","tags":"186","updated_at":"187"},"Plugin",["188"],{"description":"189","type":"128"},{"additionalProperties":false,"description":"190","properties":"191","type":"128"},{"additionalProperties":false,"description":"192","properties":"193","type":"128"},{"description":"194","type":"97"},{"default":true,"description":"195","type":"196"},{"type":"105"},{"description":"197","type":"105"},{"type":"128"},{"default":"198","description":"199","items":"200","type":"167"},{"additionalProperties":false,"description":"201","properties":"202","type":"128"},{"additionalProperties":false,"description":"203","properties":"204","type":"128"},{"description":"205","items":"206","type":"167"},{"description":"207","type":"97"},{"config":"208","enabled":true,"id":"209","name":"210","protocols":"211"},"The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).","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":"212"},"If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",{"id":"213"},"Unix epoch when the resource was created.","Whether the plugin is applied.","boolean","The name of the plugin that's going to be added. The plugin must be installed in every Kong instance separately.",["214","215","120","142"],"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`.",{"type":"105"},"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":"216"},"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":"217"},"An optional set of strings associated with the plugin for grouping and filtering.",{"type":"105"},"Unix epoch when the resource was last updated.",{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":"218","run_on_preflight":true},"3fd1eea1-885a-4011-b986-289943ff8177","key-auth",["214","215","120","142"],{"type":"105"},{"type":"105"},"grpc","grpcs",{"type":"105"},{"type":"105"},["219"],"apikey"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-plugin-for-consumer",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create a new plugin associated with a consumer",["18"],"86e5fe72774a9","post","/consumers/{consumer_username_or_id}/plugins",["19"],{},"create-plugin-for-consumer","Create a new plugin associated with a Consumer","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Plugins",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"c26fb55b0a58f","9a7ed22a674cb","200",[],["56"],"Successfully created plugin","f29ed407290cb","400",[],["57"],"Invalid plugin","f28ed407292bc","401",[],["58"],"Unauthorized","1759f8fe16f66",["59"],"Plugin request body",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"79","examples":"84","encodings":"85","schema":"86"},{"id":"87","mediaType":"79","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"79","examples":"92","encodings":"93","schema":"94"},"26f1939b2fde8","consumer_username_or_id","simple",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110"},{"default":"111","description":"112","enum":"113"},"5c9534810da92","application/json",["114"],[],{"description":"115","properties":"116","type":"117","title":"118","examples":"119"},"27a85280a1ea1",[],[],{"type":"117","$schema":"97","x-stoplight":"120"},"3fabae058a997",["121","122","123"],[],{"type":"117","properties":"124","required":"125","title":"126","$schema":"97","x-stoplight":"127"},"bea1099ff96f1",["128"],[],{"type":"117","x-examples":"129","properties":"130","$schema":"97","x-stoplight":"131"},"string",["132"],"http://json-schema.org/draft-07/schema#",{"id":"133"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["111","134"],{"id":"135","value":"136","key":"137"},"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":"138","consumer":"139","consumer_group":"140","created_at":"141","enabled":"142","id":"143","name":"144","ordering":"145","protocols":"146","route":"147","service":"148","tags":"149","updated_at":"150"},"object","Plugin",["136"],{"id":"151"},{"id":"152","key":"153","value":"154","summary":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"id":"160","key":"161","value":"162","summary":"163"},{"status":"164","message":"165"},["166","167"],"UnauthorizedError",{"id":"168"},{"id":"169","key":"170","value":"171"},{"Example 1":"172"},{"name":"173","route":"174","service":"175","consumer":"176","instance_name":"177","config":"178","protocols":"179","enabled":"180","tags":"181","ordering":"182"},{"id":"183"},"my-username","607f6f488c4cf","https","80c2b3583340c",{"config":"184","enabled":true,"id":"185","name":"186","protocols":"187"},"default",{"description":"188","type":"117"},{"additionalProperties":false,"description":"189","properties":"190","type":"117"},{"additionalProperties":false,"description":"191","properties":"192","type":"117"},{"description":"193","type":"194"},{"default":true,"description":"195","type":"196"},{"type":"95"},{"description":"197","type":"95"},{"type":"117"},{"default":"198","description":"199","items":"200","type":"201"},{"additionalProperties":false,"description":"202","properties":"203","type":"117"},{"additionalProperties":false,"description":"204","properties":"205","type":"117"},{"description":"206","items":"207","type":"201"},{"description":"208","type":"194"},"e0169a507d8a5","77ee6c8eb7a75","DuplicateApiKey",{"message":"155","status":401},"Duplicate API key found","9b348e3437b05","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","49e5a5574fe9c","NoAPIKey",{"message":"209","status":401},"No API key found",{"type":"194"},{"type":"95"},"status","message","470b68e5f0549","3b636e55dc4c0","request example",{"name":"210","route":"95","service":"95","consumer":"95","instance_name":"211","config":"212","protocols":"213","enabled":true,"tags":"214","ordering":"215"},{"name":"210","route":null,"service":null,"consumer":null,"instance_name":"211","config":"216","protocols":"217","enabled":true,"tags":"218","ordering":"219"},{"type":"95","description":"220","examples":"221"},{"type":"222","description":"223"},{"type":"224","description":"225"},{"type":"226","description":"227"},{"type":"95","description":"228","examples":"229"},{"type":"117","description":"230","properties":"231"},{"type":"201","description":"232","items":"233"},{"type":"196","description":"234","default":true},{"type":"201","description":"235","items":"236"},{"type":"117","description":"237","properties":"238"},"7a1b17d9c7f1c",{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":"239","run_on_preflight":true},"3fd1eea1-885a-4011-b986-289943ff8177","key-auth",["240","241","111","134"],"The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).","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":"242"},"If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",{"id":"243"},"Unix epoch when the resource was created.","integer","Whether the plugin is applied.","boolean","The name of the plugin that's going to be added. The plugin must be installed in every Kong instance separately.",["240","241","111","134"],"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`.",{"type":"95"},"array","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":"244"},"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":"245"},"An optional set of strings associated with the plugin for grouping and filtering.",{"type":"95"},"Unix epoch when the resource was last updated.","No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["111"],["95"],{"before":"246"},{"hour":500,"minute":20},["111","134"],["247","248"],{"before":"249"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["210"],["95","250"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["95","250"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["95","250"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["211"],"The configuration properties for the plugin",{"hour":"251","minute":"252"},"A list of the request protocols that will trigger this plugin.",{"type":"95","enum":"253","default":"111"},"Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"95"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"254"},["255"],"grpc","grpcs",{"type":"95"},{"type":"95"},{"type":"95"},{"type":"95"},["95"],"user-level","low-priority",["256"],"null",{"type":"194","examples":"257"},{"type":"194","examples":"258"},["111","240","241","259","260"],{"type":"201","items":"261"},"apikey","plugin-name",[500],[500],"tls","tcp",{"type":"95"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-plugin-for-consumer",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a plugin associated with a consumer",["18"],"49440e60ea0a3","delete","/consumers/{consumer_name_or_id}/plugins/{plugin_id}",["19"],{},"delete-plugin-for-consumer","Delete a plugin associated with a aconsumer using ID.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Plugins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"c26fb55b0a58f","d1f620421f9e1","204",[],[],"Successfully deleted plugin or the resource didn't exist","29c6221ee1267","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"50","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},"6b45c01c5733c","consumer_name_or_id","simple",[],"The name or UUID of the consumer to remove.",{"type":"77","$schema":"78","x-stoplight":"79"},["80","81","82","83","84","85"],"11f1e0f0972d9","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"77","examples":"86","$schema":"78","x-stoplight":"87"},["80","81","82","83","84","85"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95","enum":"96"},"fdf032f9bc9be","application/json",["97","98","99"],[],{"type":"100","properties":"101","required":"102","title":"103","$schema":"78","x-stoplight":"104"},"string","http://json-schema.org/draft-07/schema#",{"id":"105"},"name","in","required","schema","description","title",["106"],{"id":"107"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["94","108"],{"id":"109","key":"110","value":"111","summary":"112"},{"id":"113","key":"114","value":"115","summary":"116"},{"id":"117","key":"118","value":"119","summary":"120"},"object",{"status":"121","message":"122"},["123","124"],"UnauthorizedError",{"id":"125"},"5c8adabb81d14","response-ratelimiting","8bf5c92090277","https","dbbd1d25c6ea8","DuplicateApiKey",{"message":"112","status":401},"Duplicate API key found","0cb73d2ec2d4b","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","f7ff6b4a57ebf","NoAPIKey",{"message":"126","status":401},"No API key found",{"type":"127"},{"type":"77"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/fetch-plugin-with-consumer",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a plugin associated with a Consumer",["18"],"32766f55691d6","get","/consumers/{consumer_name_or_id}/plugins/{plugin_id}",["19"],{},"fetch-plugin-with-consumer","Get a plugin associated with a Consumer using ID.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46"],["47"],{"id":"48","url":"49","name":"50","description":"51","variables":"52"},"c26fb55b0a58f","90a280f250afe","200",[],["53"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","e8b282cf12ca1","401",[],["54"],"Unauthorized","e88282cf127ba","404",[],["55"],"Not Found",{"id":"56","name":"57","style":"58","examples":"59","description":"60","required":true,"schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"58","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","key":"70","extensions":"71","description":"72","type":"73","name":"74","in":"75"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"76","path":"77","port":"78","protocol":"79"},{"id":"80","mediaType":"81","examples":"82","encodings":"83","schema":"84"},{"id":"85","mediaType":"81","examples":"86","encodings":"87","schema":"88"},{"id":"89","mediaType":"81","examples":"90","encodings":"91","schema":"92"},"25e8c8817c8bd","consumer_name_or_id","simple",[],"The name or UUID of the consumer to remove.",{"type":"93","$schema":"94","x-stoplight":"95"},["96","97","98","99","100","101"],"bb142bb7ff9c4","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"93","examples":"102","$schema":"94","x-stoplight":"103"},["96","97","98","99","100","101"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111","enum":"112"},"8bfc6cb3b2cdb","application/json",["113"],[],{"type":"114","properties":"115","$schema":"94","x-stoplight":"116"},"c27a49e635dd5",["117","118","119"],[],{"type":"114","properties":"120","required":"121","title":"122","$schema":"94","x-stoplight":"123"},"9f76299c0d425",["124"],[],{"type":"114","x-examples":"125","properties":"126","$schema":"94","x-stoplight":"127"},"string","http://json-schema.org/draft-07/schema#",{"id":"128"},"name","in","required","schema","description","title",["129"],{"id":"130"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["110","131"],{"id":"132","key":"133","value":"134"},"object",{"id":"135","name":"136","created_at":"137","route":"138","service":"139","consumer":"140","instance_name":"141","config":"142","protocols":"143","enabled":"144","tags":"145","ordering":"146"},{"id":"147"},{"id":"148","key":"149","value":"150","summary":"151"},{"id":"152","key":"153","value":"154","summary":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"status":"160","message":"161"},["162","163"],"UnauthorizedError",{"id":"164"},{"id":"165","key":"44","value":"166"},{"Example 1":"167"},{"message":"168"},{"id":"169"},"f878a4c8046d9","response-ratelimiting","f54b69e1f3b48","https","5a0a74d0703d5","Plugin response",{"data":"170","next":"171"},{"type":"93"},{"type":"93","description":"172","examples":"173"},{"type":"174","description":"175"},{"type":"176","description":"177"},{"type":"178","description":"179"},{"type":"180","description":"181"},{"type":"93","description":"182","examples":"183"},{"type":"114","description":"184","properties":"185"},{"type":"186","description":"187","items":"188"},{"type":"189","description":"190","default":true},{"type":"186","description":"191","items":"192"},{"type":"114","description":"193","properties":"194"},"1129d1ef33e52","8601cfed777ea","DuplicateApiKey",{"message":"151","status":401},"Duplicate API key found","c44c2ed84dbb4","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","fbf78e788ba08","NoAPIKey",{"message":"195","status":401},"No API key found",{"type":"174"},{"type":"93"},"status","message","470b68e5f0549","47406fc2fca7f",{"message":"44"},{"message":"196"},{"type":"93","description":"197","examples":"198"},"3cf79b0a47ea9",["199","200"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["201"],"integer","Unix epoch when the resource was created.",["93","202"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["93","202"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["93","202"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["203"],"The configuration properties for the plugin",{"hour":"204","minute":"205"},"array","A list of the request protocols that will trigger this plugin.",{"type":"93","enum":"206","default":"110"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"93"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"207"},"No API key found in request","Not found","404 Not Found",["44"],{"id":"208","name":"201","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"209","protocols":"210","enabled":true,"tags":"211","ordering":"212"},{"id":"213","name":"201","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"214","protocols":"215","enabled":true,"tags":"216","ordering":"217"},"rate-limiting","null","rate-limiting-foo",{"type":"174","examples":"218"},{"type":"174","examples":"219"},["110","220","221","222","223"],{"type":"186","items":"224"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["110","131"],["225","226"],{"before":"227"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["223","222"],["228","229","230"],{"after":"231"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"93"},"user-level","low-priority",["232"],"admin","high-priority","critical",["232"],"plugin-name"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-plugin-with-consumer",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a plugin associated with a consumer",["18"],"1f20c0a2bf88a","patch","/consumers/{consumer_name_or_id}/plugins/{plugin_id}",["19"],{},"update-plugin-with-consumer","Update a plugin associated with a consumer using the consumer username or ID.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"Plugins",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55","56"],["57"],{"id":"58","url":"59","name":"60","description":"61","variables":"62"},"c26fb55b0a58f","5180431a89134","200",[],["63"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","a9a044f74b288","400",[],["64"],"Invalid plugin","a99044f74b0df","401",[],["65"],"Unauthorized","a96044f74b5c4","404",[],[],"Resource does not exist","cf194212ae91e",["66"],"Plugin request body",{"id":"67","name":"68","style":"69","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","name":"75","style":"69","examples":"76","description":"77","required":true,"schema":"78","explicitProperties":"79"},{"id":"80","key":"81","extensions":"82","description":"83","type":"84","name":"85","in":"86"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"87","path":"88","port":"89","protocol":"90"},{"id":"91","mediaType":"92","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"92","examples":"97","encodings":"98","schema":"99"},{"id":"100","mediaType":"92","examples":"101","encodings":"102","schema":"103"},{"id":"104","mediaType":"92","examples":"105","encodings":"106","schema":"107"},"feef456175e17","consumer_name_or_id","simple",[],"The name or UUID of the consumer to remove.",{"type":"108","$schema":"109","x-stoplight":"110"},["111","112","113","114","115","116"],"1f3d238967b68","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"108","examples":"117","$schema":"109","x-stoplight":"118"},["111","112","113","114","115","116"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"119","description":"120"},{"default":"121","description":"122"},{"default":"123","description":"124"},{"default":"125","description":"126","enum":"127"},"24c7519f77fe3","application/json",["128"],[],{"type":"129","properties":"130","$schema":"109","x-stoplight":"131"},"b7421793c2cf9",[],[],{"type":"129","$schema":"109","x-stoplight":"132"},"484219433cd84",["133","134","135"],[],{"type":"129","properties":"136","required":"137","title":"138","$schema":"109","x-stoplight":"139"},"3fdd8facad7b8",["140"],[],{"type":"129","x-examples":"141","properties":"142","$schema":"109","x-stoplight":"143"},"string","http://json-schema.org/draft-07/schema#",{"id":"144"},"name","in","required","schema","description","title",["145"],{"id":"146"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["125","147"],{"id":"148","key":"149","value":"150"},"object",{"id":"151","name":"152","created_at":"153","route":"154","service":"155","consumer":"156","instance_name":"157","config":"158","protocols":"159","enabled":"160","tags":"161","ordering":"162"},{"id":"163"},{"id":"164"},{"id":"165","key":"166","value":"167","summary":"168"},{"id":"169","key":"170","value":"171","summary":"172"},{"id":"173","key":"174","value":"175","summary":"176"},{"status":"177","message":"178"},["179","180"],"UnauthorizedError",{"id":"181"},{"id":"182","key":"183","value":"184"},{"Example 1":"185"},{"name":"186","route":"187","service":"188","consumer":"189","instance_name":"190","config":"191","protocols":"192","enabled":"193","tags":"194","ordering":"195"},{"id":"196"},"0ef2a8aef960e","response-ratelimiting","4d0cdd930f821","https","042c766813f28","Plugin response",{"data":"197","next":"198"},{"type":"108"},{"type":"108","description":"199","examples":"200"},{"type":"201","description":"202"},{"type":"203","description":"204"},{"type":"205","description":"206"},{"type":"207","description":"208"},{"type":"108","description":"209","examples":"210"},{"type":"129","description":"211","properties":"212"},{"type":"213","description":"214","items":"215"},{"type":"216","description":"217","default":true},{"type":"213","description":"218","items":"219"},{"type":"129","description":"220","properties":"221"},"1129d1ef33e52","eefae9fd85fcf","dc7a03565bd31","DuplicateApiKey",{"message":"168","status":401},"Duplicate API key found","3bb5121b01854","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","a7723fe97d988","NoAPIKey",{"message":"222","status":401},"No API key found",{"type":"201"},{"type":"108"},"status","message","470b68e5f0549","2804121d0f1a7","request example",{"name":"223","route":"108","service":"108","consumer":"108","instance_name":"224","config":"225","protocols":"226","enabled":true,"tags":"227","ordering":"228"},{"name":"223","route":null,"service":null,"consumer":null,"instance_name":"224","config":"229","protocols":"230","enabled":true,"tags":"231","ordering":"232"},{"type":"108","description":"233","examples":"234"},{"type":"235","description":"236"},{"type":"237","description":"206"},{"type":"238","description":"208"},{"type":"108","description":"209","examples":"239"},{"type":"129","description":"211","properties":"240"},{"type":"213","description":"214","items":"241"},{"type":"216","description":"217","default":true},{"type":"213","description":"218","items":"242"},{"type":"129","description":"220","properties":"243"},"7a1b17d9c7f1c",["244","245"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["223"],"integer","Unix epoch when the resource was created.",["108","246"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["108","246"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["108","246"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["224"],"The configuration properties for the plugin",{"hour":"247","minute":"248"},"array","A list of the request protocols that will trigger this plugin.",{"type":"108","enum":"249","default":"125"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"108"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"250"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["125"],["108"],{"before":"251"},{"hour":500,"minute":20},["125","147"],["252","253"],{"before":"254"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["223"],["108","246"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["108","246"],["108","246"],["224"],{"hour":"255","minute":"256"},{"type":"108","enum":"257","default":"125"},{"type":"108"},{"before":"258"},{"id":"259","name":"223","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"260","protocols":"261","enabled":true,"tags":"262","ordering":"263"},{"id":"264","name":"223","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"265","protocols":"266","enabled":true,"tags":"267","ordering":"268"},"null",{"type":"201","examples":"269"},{"type":"201","examples":"270"},["125","271","272","273","274"],{"type":"213","items":"275"},["108"],"user-level","low-priority",["276"],{"type":"201","examples":"277"},{"type":"201","examples":"278"},["125","271","272","273","274"],{"type":"213","items":"279"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["125","147"],["252","253"],{"before":"280"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["274","273"],["281","282","283"],{"after":"284"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"108"},"plugin-name",[500],[500],{"type":"108"},["276"],"admin","high-priority","critical",["276"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-plugin-for-customer",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a plugin associated with a Consumer",["18"],"91042df837930","put","/consumers/{consumer_name_or_id}/plugins/{plugin_id}",["19"],{},"upsert-plugin-for-customer","Create or Update a plugin associated with a Consumer using ID.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Plugins",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"c26fb55b0a58f","fe4590b9db91d","200",[],["57"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","38e5901152f09","400",[],["58"],"Invalid plugin","38d5901152946","401",[],["59"],"Unauthorized","898ff84dab138",["60"],"Plugin request body",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"101"},"a26b50a59c232","consumer_name_or_id","simple",[],"The name or UUID of the consumer to remove.",{"type":"102","$schema":"103","x-stoplight":"104"},["105","106","107","108","109","110"],"af4edc1e202d3","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"102","examples":"111","$schema":"103","x-stoplight":"112"},["105","106","107","108","109","110"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"0ddd036d131d2","application/json",["122"],[],{"type":"123","properties":"124","$schema":"103","x-stoplight":"125"},"8df2f188a2f78",[],[],{"type":"123","$schema":"103","x-stoplight":"126"},"92a8f739878dc",["127","128","129"],[],{"type":"123","properties":"130","required":"131","title":"132","$schema":"103","x-stoplight":"133"},"0fef70bc73a10",["134"],[],{"type":"123","x-examples":"135","properties":"136","$schema":"103","x-stoplight":"137"},"string","http://json-schema.org/draft-07/schema#",{"id":"138"},"name","in","required","schema","description","title",["139"],{"id":"140"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","141"],{"id":"142","key":"143","value":"144"},"object",{"id":"145","name":"146","created_at":"147","route":"148","service":"149","consumer":"150","instance_name":"151","config":"152","protocols":"153","enabled":"154","tags":"155","ordering":"156"},{"id":"157"},{"id":"158"},{"id":"159","key":"160","value":"161","summary":"162"},{"id":"163","key":"164","value":"165","summary":"166"},{"id":"167","key":"168","value":"169","summary":"170"},{"status":"171","message":"172"},["173","174"],"UnauthorizedError",{"id":"175"},{"id":"176","key":"177","value":"178"},{"Example 1":"179"},{"name":"180","route":"181","service":"182","consumer":"183","instance_name":"184","config":"185","protocols":"186","enabled":"187","tags":"188","ordering":"189"},{"id":"190"},"3dc4ae6c2f933","response-ratelimiting","2def3b40beff1","https","85aa0859d21ea","Plugin response",{"data":"191","next":"192"},{"type":"102"},{"type":"102","description":"193","examples":"194"},{"type":"195","description":"196"},{"type":"197","description":"198"},{"type":"199","description":"200"},{"type":"201","description":"202"},{"type":"102","description":"203","examples":"204"},{"type":"123","description":"205","properties":"206"},{"type":"207","description":"208","items":"209"},{"type":"210","description":"211","default":true},{"type":"207","description":"212","items":"213"},{"type":"123","description":"214","properties":"215"},"1129d1ef33e52","ac75fa042e5be","4badcf9a67dcc","DuplicateApiKey",{"message":"162","status":401},"Duplicate API key found","a41a11de391aa","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","26f7e5fee6ad2","NoAPIKey",{"message":"216","status":401},"No API key found",{"type":"195"},{"type":"102"},"status","message","470b68e5f0549","24b1d92242777","request example",{"name":"217","route":"102","service":"102","consumer":"102","instance_name":"218","config":"219","protocols":"220","enabled":true,"tags":"221","ordering":"222"},{"name":"217","route":null,"service":null,"consumer":null,"instance_name":"218","config":"223","protocols":"224","enabled":true,"tags":"225","ordering":"226"},{"type":"102","description":"227","examples":"228"},{"type":"229","description":"230"},{"type":"231","description":"200"},{"type":"232","description":"202"},{"type":"102","description":"203","examples":"233"},{"type":"123","description":"205","properties":"234"},{"type":"207","description":"208","items":"235"},{"type":"210","description":"211","default":true},{"type":"207","description":"212","items":"236"},{"type":"123","description":"214","properties":"237"},"7a1b17d9c7f1c",["238","239"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["217"],"integer","Unix epoch when the resource was created.",["102","240"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["102","240"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["102","240"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["218"],"The configuration properties for the plugin",{"hour":"241","minute":"242"},"array","A list of the request protocols that will trigger this plugin.",{"type":"102","enum":"243","default":"119"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"102"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"244"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["119"],["102"],{"before":"245"},{"hour":500,"minute":20},["119","141"],["246","247"],{"before":"248"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["217"],["102","240"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["102","240"],["102","240"],["218"],{"hour":"249","minute":"250"},{"type":"102","enum":"251","default":"119"},{"type":"102"},{"before":"252"},{"id":"253","name":"217","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"254","protocols":"255","enabled":true,"tags":"256","ordering":"257"},{"id":"258","name":"217","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"259","protocols":"260","enabled":true,"tags":"261","ordering":"262"},"null",{"type":"195","examples":"263"},{"type":"195","examples":"264"},["119","265","266","267","268"],{"type":"207","items":"269"},["102"],"user-level","low-priority",["270"],{"type":"195","examples":"271"},{"type":"195","examples":"272"},["119","265","266","267","268"],{"type":"207","items":"273"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["119","141"],["246","247"],{"before":"274"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["268","267"],["275","276","277"],{"after":"278"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"102"},"plugin-name",[500],[500],{"type":"102"},["270"],"admin","high-priority","critical",["270"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-plugin",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all plugins",["18"],"17e991a37d0ba","get","/plugins",["19"],{},"list-plugin","List all plugins\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Plugins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40","41"],[],[],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"c26fb55b0a58f","98be3bb32139b","200",[],["48"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","034e3b21b1bcb","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","key":"70","extensions":"71","description":"72","type":"73","name":"74","in":"75"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"76","path":"77","port":"78","protocol":"79"},{"id":"80","mediaType":"81","examples":"82","encodings":"83","schema":"84"},{"id":"85","mediaType":"81","examples":"86","encodings":"87","schema":"88"},"2170b51a8e567","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96"],"65f796055a96f","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"97","$schema":"90","x-stoplight":"98"},["92","93","94","95","96"],"9d4f3bb9c17f2","tags",["99"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"97","examples":"100","x-stoplight":"101","$schema":"90"},["92","102","93","94","95","96"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"103","description":"104"},{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110","enum":"111"},"14560749e919b","application/json",["112"],[],{"type":"113","properties":"114","$schema":"90","x-stoplight":"115"},"2671f5eeeda13",["116","117","118"],[],{"type":"113","properties":"119","required":"120","title":"121","$schema":"90","x-stoplight":"122"},"integer","http://json-schema.org/draft-07/schema#",{"id":"123"},"description","in","name","schema","title","string",{"id":"124"},{"id":"125","value":"126","key":"127"},["126"],{"explicitProperties":"128","id":"129"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["109","130"],{"id":"131","key":"132","value":"133"},"object",{"id":"134","name":"135","created_at":"136","route":"137","service":"138","consumer":"139","instance_name":"140","config":"141","protocols":"142","enabled":"143","tags":"144","ordering":"145"},{"id":"146"},{"id":"147","key":"148","value":"149","summary":"150"},{"id":"151","key":"152","value":"153","summary":"154"},{"id":"155","key":"156","value":"157","summary":"158"},{"status":"159","message":"160"},["161","162"],"UnauthorizedError",{"id":"163"},"2a2237eefecc7","96125a381b990","4c3aa6e45cf27","tag1,tag2","default",["164","165","166"],"f11ecb2e265de","https","119b8cc61dd5a","Plugin response",{"data":"167","next":"168"},{"type":"97"},{"type":"97","description":"169","examples":"170"},{"type":"89","description":"171"},{"type":"172","description":"173"},{"type":"174","description":"175"},{"type":"176","description":"177"},{"type":"97","description":"178","examples":"179"},{"type":"113","description":"180","properties":"181"},{"type":"182","description":"183","items":"184"},{"type":"185","description":"186","default":true},{"type":"182","description":"187","items":"188"},{"type":"113","description":"189","properties":"190"},"1129d1ef33e52","21b3efeeb8d4d","DuplicateApiKey",{"message":"150","status":401},"Duplicate API key found","0fd254959c001","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","b7ef3d5f7f88f","NoAPIKey",{"message":"191","status":401},"No API key found",{"type":"89"},{"type":"97"},"status","message","470b68e5f0549","type","nullable","examples",["192","193"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["194"],"Unix epoch when the resource was created.",["97","195"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["97","195"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["97","195"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["196"],"The configuration properties for the plugin",{"hour":"197","minute":"198"},"array","A list of the request protocols that will trigger this plugin.",{"type":"97","enum":"199","default":"109"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"97"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"200"},"No API key found in request",{"id":"201","name":"194","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"202","protocols":"203","enabled":true,"tags":"204","ordering":"205"},{"id":"206","name":"194","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"207","protocols":"208","enabled":true,"tags":"209","ordering":"210"},"rate-limiting","null","rate-limiting-foo",{"type":"89","examples":"211"},{"type":"89","examples":"212"},["109","213","214","215","216"],{"type":"182","items":"217"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["109","130"],["218","219"],{"before":"220"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["216","215"],["221","222","223"],{"after":"224"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"97"},"user-level","low-priority",["225"],"admin","high-priority","critical",["225"],"plugin-name"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-plugin",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new plugin",["17"],"4ca2452f2275f","post","/plugins",["18"],{},"create-plugin","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],[],["48"],{"id":"49","url":"50","name":"51","description":"52","variables":"53"},"c26fb55b0a58f","ae8f61aab97c1","200",[],["54"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","abef624d8398f","400",[],["55"],"Invalid plugin","abff624d83bdc","401",[],["56"],"Unauthorized","969a4bd38dfe1",["57"],"Plugin request body",{"id":"58","key":"59","extensions":"60","description":"61","type":"62","name":"63","in":"64"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"65","path":"66","port":"67","protocol":"68"},{"id":"69","mediaType":"70","examples":"71","encodings":"72","schema":"73"},{"id":"74","mediaType":"70","examples":"75","encodings":"76","schema":"77"},{"id":"78","mediaType":"70","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"70","examples":"83","encodings":"84","schema":"85"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"86","description":"87"},{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93","enum":"94"},"c693bbecf4729","application/json",["95"],[],{"type":"96","properties":"97","$schema":"98","x-stoplight":"99"},"bf68137716bd5",[],[],{"type":"96","$schema":"98","x-stoplight":"100"},"6f45356c6e3e5",["101","102","103"],[],{"type":"96","properties":"104","required":"105","title":"106","$schema":"98","x-stoplight":"107"},"f54a15ef206d9",["108"],[],{"type":"96","x-examples":"109","properties":"110","$schema":"98","x-stoplight":"111"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["92","112"],{"id":"113","key":"114","value":"115"},"object",{"id":"116","name":"117","created_at":"118","route":"119","service":"120","consumer":"121","instance_name":"122","config":"123","protocols":"124","enabled":"125","tags":"126","ordering":"127"},"http://json-schema.org/draft-07/schema#",{"id":"128"},{"id":"129"},{"id":"130","key":"131","value":"132","summary":"133"},{"id":"134","key":"135","value":"136","summary":"137"},{"id":"138","key":"139","value":"140","summary":"141"},{"status":"142","message":"143"},["144","145"],"UnauthorizedError",{"id":"146"},{"id":"147","key":"148","value":"149"},{"Example 1":"150"},{"name":"151","route":"152","service":"153","consumer":"154","instance_name":"155","config":"156","protocols":"157","enabled":"158","tags":"159","ordering":"160"},{"id":"161"},"https","d3c43466a3c7b","Plugin response",{"data":"162","next":"163"},{"type":"164"},{"type":"164","description":"165","examples":"166"},{"type":"167","description":"168"},{"type":"169","description":"170"},{"type":"171","description":"172"},{"type":"173","description":"174"},{"type":"164","description":"175","examples":"176"},{"type":"96","description":"177","properties":"178"},{"type":"179","description":"180","items":"181"},{"type":"182","description":"183","default":true},{"type":"179","description":"184","items":"185"},{"type":"96","description":"186","properties":"187"},"1129d1ef33e52","3193a6559b582","570785f7aa12b","DuplicateApiKey",{"message":"133","status":401},"Duplicate API key found","8c5365981da1f","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","7257ec2b53b89","NoAPIKey",{"message":"188","status":401},"No API key found",{"type":"167"},{"type":"164"},"status","message","470b68e5f0549","b1623f98c174a","request example",{"name":"189","route":"164","service":"164","consumer":"164","instance_name":"190","config":"191","protocols":"192","enabled":true,"tags":"193","ordering":"194"},{"name":"189","route":null,"service":null,"consumer":null,"instance_name":"190","config":"195","protocols":"196","enabled":true,"tags":"197","ordering":"198"},{"type":"164","description":"199","examples":"200"},{"type":"201","description":"202"},{"type":"203","description":"172"},{"type":"204","description":"174"},{"type":"164","description":"175","examples":"205"},{"type":"96","description":"177","properties":"206"},{"type":"179","description":"180","items":"207"},{"type":"182","description":"183","default":true},{"type":"179","description":"184","items":"208"},{"type":"96","description":"186","properties":"209"},"7a1b17d9c7f1c",["210","211"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","string","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["189"],"integer","Unix epoch when the resource was created.",["164","212"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["164","212"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["164","212"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["190"],"The configuration properties for the plugin",{"hour":"213","minute":"214"},"array","A list of the request protocols that will trigger this plugin.",{"type":"164","enum":"215","default":"92"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"164"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"216"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["92"],["164"],{"before":"217"},{"hour":500,"minute":20},["92","112"],["218","219"],{"before":"220"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["189"],["164","212"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["164","212"],["164","212"],["190"],{"hour":"221","minute":"222"},{"type":"164","enum":"223","default":"92"},{"type":"164"},{"before":"224"},{"id":"225","name":"189","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"226","protocols":"227","enabled":true,"tags":"228","ordering":"229"},{"id":"230","name":"189","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"231","protocols":"232","enabled":true,"tags":"233","ordering":"234"},"null",{"type":"167","examples":"235"},{"type":"167","examples":"236"},["92","237","238","239","240"],{"type":"179","items":"241"},["164"],"user-level","low-priority",["242"],{"type":"167","examples":"243"},{"type":"167","examples":"244"},["92","237","238","239","240"],{"type":"179","items":"245"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["92","112"],["218","219"],{"before":"246"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["240","239"],["247","248","249"],{"after":"250"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"164"},"plugin-name",[500],[500],{"type":"164"},["242"],"admin","high-priority","critical",["242"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-plugin",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a plugin",["17"],"93f7c7ecb34c9","delete","/plugins/{plugin_id}",["18"],{},"delete-plugin","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Plugins",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38"],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"c26fb55b0a58f","58c7d8ee05e0f","204",[],[],"Successfully deleted plugin or the resource didn't exist","00d7d711433b0","401",[],["45"],"Unauthorized",{"id":"46","name":"47","style":"48","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},{"id":"64","mediaType":"65","examples":"66","encodings":"67","schema":"68"},"6b1ed444165a8","plugin_id","simple",[],"The unique identifier of the plugin to create or update.",{"type":"69","examples":"70","$schema":"71","x-stoplight":"72"},["73","74","75","76","77","78"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86","enum":"87"},"422587783b0dc","application/json",["88","89","90"],[],{"type":"91","properties":"92","required":"93","title":"94","$schema":"71","x-stoplight":"95"},"string",["96"],"http://json-schema.org/draft-07/schema#",{"id":"97"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["85","98"],{"id":"99","key":"100","value":"101","summary":"102"},{"id":"103","key":"104","value":"105","summary":"106"},{"id":"107","key":"108","value":"109","summary":"110"},"object",{"status":"111","message":"112"},["113","114"],"UnauthorizedError",{"id":"115"},"response-ratelimiting","a38105beeffbd","https","9a3ac28f63747","DuplicateApiKey",{"message":"102","status":401},"Duplicate API key found","687e2bff96686","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","5bc9989efed20","NoAPIKey",{"message":"116","status":401},"No API key found",{"type":"117"},{"type":"69"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-plugin",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a plugin",["18"],"003056bc067da","get","/plugins/{plugin_id}",["19"],{},"get-plugin","Get a plugin using ID.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45"],["46"],{"id":"47","url":"48","name":"49","description":"50","variables":"51"},"c26fb55b0a58f","ce75c244eca11","200",[],["52"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","6e65c0681cdbe","401",[],["53"],"Unauthorized","6e95c0681d0c1","404",[],[],"Resource does not exist",{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},{"id":"77","mediaType":"73","examples":"78","encodings":"79","schema":"80"},"ac1f4396a0260","plugin_id","simple",[],"The unique identifier of the plugin to create or update.",{"type":"81","examples":"82","$schema":"83","x-stoplight":"84"},["85","86","87","88","89","90"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"f1c29df798f06","application/json",["100"],[],{"type":"101","properties":"102","$schema":"83","x-stoplight":"103"},"8cf396cb3d9dd",["104","105","106"],[],{"type":"101","properties":"107","required":"108","title":"109","$schema":"83","x-stoplight":"110"},"string",["111"],"http://json-schema.org/draft-07/schema#",{"id":"112"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","113"],{"id":"114","key":"115","value":"116"},"object",{"id":"117","name":"118","created_at":"119","route":"120","service":"121","consumer":"122","instance_name":"123","config":"124","protocols":"125","enabled":"126","tags":"127","ordering":"128"},{"id":"129"},{"id":"130","key":"131","value":"132","summary":"133"},{"id":"134","key":"135","value":"136","summary":"137"},{"id":"138","key":"139","value":"140","summary":"141"},{"status":"142","message":"143"},["144","145"],"UnauthorizedError",{"id":"146"},"response-ratelimiting","f92e664baa99c","https","53a2c55fef06e","Plugin response",{"data":"147","next":"148"},{"type":"81"},{"type":"81","description":"149","examples":"150"},{"type":"151","description":"152"},{"type":"153","description":"154"},{"type":"155","description":"156"},{"type":"157","description":"158"},{"type":"81","description":"159","examples":"160"},{"type":"101","description":"161","properties":"162"},{"type":"163","description":"164","items":"165"},{"type":"166","description":"167","default":true},{"type":"163","description":"168","items":"169"},{"type":"101","description":"170","properties":"171"},"1129d1ef33e52","29c17c6b2a11a","DuplicateApiKey",{"message":"133","status":401},"Duplicate API key found","7bb8692e938e8","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","ccb1cbdd1f24a","NoAPIKey",{"message":"172","status":401},"No API key found",{"type":"151"},{"type":"81"},"status","message","470b68e5f0549",["173","174"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["175"],"integer","Unix epoch when the resource was created.",["81","176"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["81","176"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["81","176"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["177"],"The configuration properties for the plugin",{"hour":"178","minute":"179"},"array","A list of the request protocols that will trigger this plugin.",{"type":"81","enum":"180","default":"97"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"81"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"181"},"No API key found in request",{"id":"182","name":"175","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"183","protocols":"184","enabled":true,"tags":"185","ordering":"186"},{"id":"187","name":"175","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"188","protocols":"189","enabled":true,"tags":"190","ordering":"191"},"rate-limiting","null","rate-limiting-foo",{"type":"151","examples":"192"},{"type":"151","examples":"193"},["97","194","195","196","197"],{"type":"163","items":"198"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["97","113"],["199","200"],{"before":"201"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["197","196"],["202","203","204"],{"after":"205"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"81"},"user-level","low-priority",["206"],"admin","high-priority","critical",["206"],"plugin-name"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-plugin",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update a plugin",["17"],"6119c94f98374","patch","/plugins/{plugin_id}",["18"],{},"update-plugin","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Plugins",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54"],["55"],{"id":"56","url":"57","name":"58","description":"59","variables":"60"},"c26fb55b0a58f","dfa9124d0b144","200",[],["61"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","a50912f59434f","400",[],["62"],"Invalid plugin","a4f912f5940fc","401",[],["63"],"Unauthorized","a4c912f594a03","404",[],[],"Resource does not exist","deb23faf00dec",["64"],"Plugin request body",{"id":"65","name":"66","style":"67","examples":"68","description":"69","required":true,"schema":"70","explicitProperties":"71"},{"id":"72","key":"73","extensions":"74","description":"75","type":"76","name":"77","in":"78"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"79","path":"80","port":"81","protocol":"82"},{"id":"83","mediaType":"84","examples":"85","encodings":"86","schema":"87"},{"id":"88","mediaType":"84","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"84","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"84","examples":"97","encodings":"98","schema":"99"},"bc78adbefff5c","plugin_id","simple",[],"The unique identifier of the plugin to create or update.",{"type":"100","examples":"101","$schema":"102","x-stoplight":"103"},["104","105","106","107","108","109"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"110","description":"111"},{"default":"112","description":"113"},{"default":"114","description":"115"},{"default":"116","description":"117","enum":"118"},"75368a444fbbe","application/json",["119"],[],{"type":"120","properties":"121","$schema":"102","x-stoplight":"122"},"89db3c14529d7",[],[],{"type":"120","$schema":"102","x-stoplight":"123"},"eb579d52a3e93",["124","125","126"],[],{"type":"120","properties":"127","required":"128","title":"129","$schema":"102","x-stoplight":"130"},"09dd9b2fd7e74",["131"],[],{"type":"120","x-examples":"132","properties":"133","$schema":"102","x-stoplight":"134"},"string",["135"],"http://json-schema.org/draft-07/schema#",{"id":"136"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["116","137"],{"id":"138","key":"139","value":"140"},"object",{"id":"141","name":"142","created_at":"143","route":"144","service":"145","consumer":"146","instance_name":"147","config":"148","protocols":"149","enabled":"150","tags":"151","ordering":"152"},{"id":"153"},{"id":"154"},{"id":"155","key":"156","value":"157","summary":"158"},{"id":"159","key":"160","value":"161","summary":"162"},{"id":"163","key":"164","value":"165","summary":"166"},{"status":"167","message":"168"},["169","170"],"UnauthorizedError",{"id":"171"},{"id":"172","key":"173","value":"174"},{"Example 1":"175"},{"name":"176","route":"177","service":"178","consumer":"179","instance_name":"180","config":"181","protocols":"182","enabled":"183","tags":"184","ordering":"185"},{"id":"186"},"response-ratelimiting","0c81a97c48099","https","1ecffe324be36","Plugin response",{"data":"187","next":"188"},{"type":"100"},{"type":"100","description":"189","examples":"190"},{"type":"191","description":"192"},{"type":"193","description":"194"},{"type":"195","description":"196"},{"type":"197","description":"198"},{"type":"100","description":"199","examples":"200"},{"type":"120","description":"201","properties":"202"},{"type":"203","description":"204","items":"205"},{"type":"206","description":"207","default":true},{"type":"203","description":"208","items":"209"},{"type":"120","description":"210","properties":"211"},"1129d1ef33e52","59923d6cff61b","293b0a5f0b607","DuplicateApiKey",{"message":"158","status":401},"Duplicate API key found","67856949e1a27","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","ee05d65afc68b","NoAPIKey",{"message":"212","status":401},"No API key found",{"type":"191"},{"type":"100"},"status","message","470b68e5f0549","faea2a0aeaae0","request example",{"name":"213","route":"100","service":"100","consumer":"100","instance_name":"214","config":"215","protocols":"216","enabled":true,"tags":"217","ordering":"218"},{"name":"213","route":null,"service":null,"consumer":null,"instance_name":"214","config":"219","protocols":"220","enabled":true,"tags":"221","ordering":"222"},{"type":"100","description":"223","examples":"224"},{"type":"225","description":"226"},{"type":"227","description":"196"},{"type":"228","description":"198"},{"type":"100","description":"199","examples":"229"},{"type":"120","description":"201","properties":"230"},{"type":"203","description":"204","items":"231"},{"type":"206","description":"207","default":true},{"type":"203","description":"208","items":"232"},{"type":"120","description":"210","properties":"233"},"7a1b17d9c7f1c",["234","235"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["213"],"integer","Unix epoch when the resource was created.",["100","236"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["100","236"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["100","236"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["214"],"The configuration properties for the plugin",{"hour":"237","minute":"238"},"array","A list of the request protocols that will trigger this plugin.",{"type":"100","enum":"239","default":"116"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"100"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"240"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["116"],["100"],{"before":"241"},{"hour":500,"minute":20},["116","137"],["242","243"],{"before":"244"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["213"],["100","236"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["100","236"],["100","236"],["214"],{"hour":"245","minute":"246"},{"type":"100","enum":"247","default":"116"},{"type":"100"},{"before":"248"},{"id":"249","name":"213","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"250","protocols":"251","enabled":true,"tags":"252","ordering":"253"},{"id":"254","name":"213","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"255","protocols":"256","enabled":true,"tags":"257","ordering":"258"},"null",{"type":"191","examples":"259"},{"type":"191","examples":"260"},["116","261","262","263","264"],{"type":"203","items":"265"},["100"],"user-level","low-priority",["266"],{"type":"191","examples":"267"},{"type":"191","examples":"268"},["116","261","262","263","264"],{"type":"203","items":"269"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["116","137"],["242","243"],{"before":"270"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["264","263"],["271","272","273"],{"after":"274"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"100"},"plugin-name",[500],[500],{"type":"100"},["266"],"admin","high-priority","critical",["266"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-plugin",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a plugin",["18"],"a937585a0e558","put","/plugins/{plugin_id}",["19"],{},"upsert-plugin","Create or Update plugin using ID.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Plugins",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"c26fb55b0a58f","f582ac9e0e0e4","200",[],["56"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","9d62aac14cce8","400",[],["57"],"Invalid plugin","9d52aac14cf3b","401",[],["58"],"Unauthorized","b570e15636ff7",["59"],"Plugin request body",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"79","examples":"84","encodings":"85","schema":"86"},{"id":"87","mediaType":"79","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"79","examples":"92","encodings":"93","schema":"94"},"17096dcd6f74b","plugin_id","simple",[],"The unique identifier of the plugin to create or update.",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110"},{"default":"111","description":"112","enum":"113"},"97e1c8e9b8704","application/json",["114"],[],{"type":"115","properties":"116","$schema":"97","x-stoplight":"117"},"ede3fe212efb1",[],[],{"type":"115","$schema":"97","x-stoplight":"118"},"857d49ad7b9c2",["119","120","121"],[],{"type":"115","properties":"122","required":"123","title":"124","$schema":"97","x-stoplight":"125"},"f4107defd776c",["126"],[],{"type":"115","x-examples":"127","properties":"128","$schema":"97","x-stoplight":"129"},"string",["130"],"http://json-schema.org/draft-07/schema#",{"id":"131"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["111","132"],{"id":"133","key":"134","value":"135"},"object",{"id":"136","name":"137","created_at":"138","route":"139","service":"140","consumer":"141","instance_name":"142","config":"143","protocols":"144","enabled":"145","tags":"146","ordering":"147"},{"id":"148"},{"id":"149"},{"id":"150","key":"151","value":"152","summary":"153"},{"id":"154","key":"155","value":"156","summary":"157"},{"id":"158","key":"159","value":"160","summary":"161"},{"status":"162","message":"163"},["164","165"],"UnauthorizedError",{"id":"166"},{"id":"167","key":"168","value":"169"},{"Example 1":"170"},{"name":"171","route":"172","service":"173","consumer":"174","instance_name":"175","config":"176","protocols":"177","enabled":"178","tags":"179","ordering":"180"},{"id":"181"},"response-ratelimiting","5e4e10c420157","https","b6bdc041dd412","Plugin response",{"data":"182","next":"183"},{"type":"95"},{"type":"95","description":"184","examples":"185"},{"type":"186","description":"187"},{"type":"188","description":"189"},{"type":"190","description":"191"},{"type":"192","description":"193"},{"type":"95","description":"194","examples":"195"},{"type":"115","description":"196","properties":"197"},{"type":"198","description":"199","items":"200"},{"type":"201","description":"202","default":true},{"type":"198","description":"203","items":"204"},{"type":"115","description":"205","properties":"206"},"1129d1ef33e52","155660daca34e","89e9bff1f632a","DuplicateApiKey",{"message":"153","status":401},"Duplicate API key found","390f26649fa3d","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","b40c7bb4afa10","NoAPIKey",{"message":"207","status":401},"No API key found",{"type":"186"},{"type":"95"},"status","message","470b68e5f0549","fda02b48aed0b","request example",{"name":"208","route":"95","service":"95","consumer":"95","instance_name":"209","config":"210","protocols":"211","enabled":true,"tags":"212","ordering":"213"},{"name":"208","route":null,"service":null,"consumer":null,"instance_name":"209","config":"214","protocols":"215","enabled":true,"tags":"216","ordering":"217"},{"type":"95","description":"218","examples":"219"},{"type":"220","description":"221"},{"type":"222","description":"191"},{"type":"223","description":"193"},{"type":"95","description":"194","examples":"224"},{"type":"115","description":"196","properties":"225"},{"type":"198","description":"199","items":"226"},{"type":"201","description":"202","default":true},{"type":"198","description":"203","items":"227"},{"type":"115","description":"205","properties":"228"},"7a1b17d9c7f1c",["229","230"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["208"],"integer","Unix epoch when the resource was created.",["95","231"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["95","231"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["95","231"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["209"],"The configuration properties for the plugin",{"hour":"232","minute":"233"},"array","A list of the request protocols that will trigger this plugin.",{"type":"95","enum":"234","default":"111"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"95"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"235"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["111"],["95"],{"before":"236"},{"hour":500,"minute":20},["111","132"],["237","238"],{"before":"239"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["208"],["95","231"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["95","231"],["95","231"],["209"],{"hour":"240","minute":"241"},{"type":"95","enum":"242","default":"111"},{"type":"95"},{"before":"243"},{"id":"244","name":"208","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"245","protocols":"246","enabled":true,"tags":"247","ordering":"248"},{"id":"249","name":"208","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"250","protocols":"251","enabled":true,"tags":"252","ordering":"253"},"null",{"type":"186","examples":"254"},{"type":"186","examples":"255"},["111","256","257","258","259"],{"type":"198","items":"260"},["95"],"user-level","low-priority",["261"],{"type":"186","examples":"262"},{"type":"186","examples":"263"},["111","256","257","258","259"],{"type":"198","items":"264"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["111","132"],["237","238"],{"before":"265"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["259","258"],["266","267","268"],{"after":"269"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"95"},"plugin-name",[500],[500],{"type":"95"},["261"],"admin","high-priority","critical",["261"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-plugins-with-route",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all plugins associated with a route",["17"],"5dde3b08819a7","get","/routes/{route_id_or_name}/plugins",["18"],{},"list-plugins-with-route","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Plugins",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],["41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"c26fb55b0a58f","eb1af8343802a","200",[],["48"],"A successful response listing plugins","134af9f9e1123","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"71","examples":"72","description":"73","required":true,"schema":"74","explicitProperties":"75"},{"id":"76","key":"77","extensions":"78","description":"79","type":"80","name":"81","in":"82"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"83","path":"84","port":"85","protocol":"86"},{"id":"87","mediaType":"88","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"88","examples":"93","encodings":"94","schema":"95"},"45e4de1582094","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103"],"86057be928cff","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"104","$schema":"97","x-stoplight":"105"},["99","100","101","102","103"],"8c041ae13869e","tags",["106"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"104","examples":"107","x-stoplight":"108","$schema":"97"},["99","109","100","101","102","103"],"2a4bfba31e857","route_id_or_name","simple",[],"The unique identifier or the name of the route to retrieve.",{"type":"104","examples":"110","$schema":"97","x-stoplight":"111"},["101","100","112","102","99","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"751fa49644869","application/json",[],[],{"properties":"122","$schema":"97","x-stoplight":"123"},"0ac9c7009a481",["124","125","126"],[],{"type":"127","properties":"128","required":"129","title":"130","$schema":"97","x-stoplight":"131"},"integer","http://json-schema.org/draft-07/schema#",{"id":"132"},"description","in","name","schema","title","string",{"id":"133"},{"id":"134","value":"135","key":"136"},["135"],{"explicitProperties":"137","id":"138"},"example",["139"],{"id":"140"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","141"],{"data":"142","offset":"143"},{"id":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},"object",{"status":"157","message":"158"},["159","160"],"UnauthorizedError",{"id":"161"},"7726a8db8a2ae","e200e46a95bbf","2e42fb6f1e8f4","tag1,tag2","default",["162","163","164"],"ff5fbb99f9e8c","my-route","d5bc5ffe9876a","https",{"items":"165","type":"166"},{"description":"167","type":"104","title":"168"},"8edc7b0e3a7e9","2a070b02557f9","DuplicateApiKey",{"message":"148","status":401},"Duplicate API key found","6cfb078baf7cb","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","1dc0bc06979bc","NoAPIKey",{"message":"169","status":401},"No API key found",{"type":"96"},{"type":"104"},"status","message","470b68e5f0549","type","nullable","examples",{"description":"170","properties":"171","type":"127","title":"172","examples":"173"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","No API key found in request","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":"174","consumer":"175","consumer_group":"176","created_at":"177","enabled":"178","id":"179","name":"180","ordering":"181","protocols":"182","route":"183","service":"184","tags":"185","updated_at":"186"},"Plugin",["187"],{"description":"188","type":"127"},{"additionalProperties":false,"description":"189","properties":"190","type":"127"},{"additionalProperties":false,"description":"191","properties":"192","type":"127"},{"description":"193","type":"96"},{"default":true,"description":"194","type":"195"},{"type":"104"},{"description":"196","type":"104"},{"type":"127"},{"default":"197","description":"198","items":"199","type":"166"},{"additionalProperties":false,"description":"200","properties":"201","type":"127"},{"additionalProperties":false,"description":"202","properties":"203","type":"127"},{"description":"204","items":"205","type":"166"},{"description":"206","type":"96"},{"config":"207","enabled":true,"id":"208","name":"209","protocols":"210"},"The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).","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":"211"},"If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",{"id":"212"},"Unix epoch when the resource was created.","Whether the plugin is applied.","boolean","The name of the plugin that's going to be added. The plugin must be installed in every Kong instance separately.",["213","214","119","141"],"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`.",{"type":"104"},"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":"215"},"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":"216"},"An optional set of strings associated with the plugin for grouping and filtering.",{"type":"104"},"Unix epoch when the resource was last updated.",{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":"217","run_on_preflight":true},"3fd1eea1-885a-4011-b986-289943ff8177","key-auth",["213","214","119","141"],{"type":"104"},{"type":"104"},"grpc","grpcs",{"type":"104"},{"type":"104"},["218"],"apikey"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-plugin-with-route",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new plugin associated with a route",["17"],"379cad7b3d140","post","/routes/{route_id_or_name}/plugins",["18"],{},"create-plugin-with-route","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48"],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"c26fb55b0a58f","eeffa23b3ee1f","200",[],["55"],"Successfully created plugin","171fa400e792d","400",[],["56"],"Invalid plugin","170fa400e789a","401",[],["57"],"Unauthorized","5a8184eb573da",["58"],"Plugin request body",{"id":"59","name":"60","style":"61","examples":"62","description":"63","required":true,"schema":"64","explicitProperties":"65"},{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},{"id":"86","mediaType":"78","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"78","examples":"91","encodings":"92","schema":"93"},"9b023a1a7a97f","route_id_or_name","simple",[],"The unique identifier or the name of the route to retrieve.",{"type":"94","examples":"95","$schema":"96","x-stoplight":"97"},["98","99","100","101","102","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111","enum":"112"},"4668eeb4c9e5e","application/json",["113"],[],{"description":"114","properties":"115","type":"116","title":"117","examples":"118"},"dc85693412636",[],[],{"type":"116","$schema":"96","x-stoplight":"119"},"a23fd9f3e346d",["120","121","122"],[],{"type":"116","properties":"123","required":"124","title":"125","$schema":"96","x-stoplight":"126"},"f525c400cc882",["127"],[],{"type":"116","x-examples":"128","properties":"129","$schema":"96","x-stoplight":"130"},"string",["131"],"http://json-schema.org/draft-07/schema#",{"id":"132"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["110","133"],{"id":"134","value":"135","key":"136"},"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":"137","consumer":"138","consumer_group":"139","created_at":"140","enabled":"141","id":"142","name":"143","ordering":"144","protocols":"145","route":"146","service":"147","tags":"148","updated_at":"149"},"object","Plugin",["135"],{"id":"150"},{"id":"151","key":"152","value":"153","summary":"154"},{"id":"155","key":"156","value":"157","summary":"158"},{"id":"159","key":"160","value":"161","summary":"162"},{"status":"163","message":"164"},["165","166"],"UnauthorizedError",{"id":"167"},{"id":"168","key":"169","value":"170"},{"Example 1":"171"},{"name":"172","route":"173","service":"174","consumer":"175","instance_name":"176","config":"177","protocols":"178","enabled":"179","tags":"180","ordering":"181"},{"id":"182"},"my-route","9c4cc0cafcb14","https","ec2890b95a235",{"config":"183","enabled":true,"id":"184","name":"185","protocols":"186"},"default",{"description":"187","type":"116"},{"additionalProperties":false,"description":"188","properties":"189","type":"116"},{"additionalProperties":false,"description":"190","properties":"191","type":"116"},{"description":"192","type":"193"},{"default":true,"description":"194","type":"195"},{"type":"94"},{"description":"196","type":"94"},{"type":"116"},{"default":"197","description":"198","items":"199","type":"200"},{"additionalProperties":false,"description":"201","properties":"202","type":"116"},{"additionalProperties":false,"description":"203","properties":"204","type":"116"},{"description":"205","items":"206","type":"200"},{"description":"207","type":"193"},"bf3fc4796bd1d","a2c2a7fa59fab","DuplicateApiKey",{"message":"154","status":401},"Duplicate API key found","c9e1b9e0aa7e8","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","64f1b77c533a2","NoAPIKey",{"message":"208","status":401},"No API key found",{"type":"193"},{"type":"94"},"status","message","470b68e5f0549","5e182c35c7025","request example",{"name":"209","route":"94","service":"94","consumer":"94","instance_name":"210","config":"211","protocols":"212","enabled":true,"tags":"213","ordering":"214"},{"name":"209","route":null,"service":null,"consumer":null,"instance_name":"210","config":"215","protocols":"216","enabled":true,"tags":"217","ordering":"218"},{"type":"94","description":"219","examples":"220"},{"type":"221","description":"222"},{"type":"223","description":"224"},{"type":"225","description":"226"},{"type":"94","description":"227","examples":"228"},{"type":"116","description":"229","properties":"230"},{"type":"200","description":"231","items":"232"},{"type":"195","description":"233","default":true},{"type":"200","description":"234","items":"235"},{"type":"116","description":"236","properties":"237"},"7a1b17d9c7f1c",{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":"238","run_on_preflight":true},"3fd1eea1-885a-4011-b986-289943ff8177","key-auth",["239","240","110","133"],"The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).","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":"241"},"If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",{"id":"242"},"Unix epoch when the resource was created.","integer","Whether the plugin is applied.","boolean","The name of the plugin that's going to be added. The plugin must be installed in every Kong instance separately.",["239","240","110","133"],"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`.",{"type":"94"},"array","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":"243"},"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":"244"},"An optional set of strings associated with the plugin for grouping and filtering.",{"type":"94"},"Unix epoch when the resource was last updated.","No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["110"],["94"],{"before":"245"},{"hour":500,"minute":20},["110","133"],["246","247"],{"before":"248"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["209"],["94","249"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["94","249"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["94","249"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["210"],"The configuration properties for the plugin",{"hour":"250","minute":"251"},"A list of the request protocols that will trigger this plugin.",{"type":"94","enum":"252","default":"110"},"Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"94"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"253"},["254"],"grpc","grpcs",{"type":"94"},{"type":"94"},{"type":"94"},{"type":"94"},["94"],"user-level","low-priority",["255"],"null",{"type":"193","examples":"256"},{"type":"193","examples":"257"},["110","239","240","258","259"],{"type":"200","items":"260"},"apikey","plugin-name",[500],[500],"tls","tcp",{"type":"94"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-plugin-with-route",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a plugin associated with a route",["18"],"4f7a8ef50cb53","delete","/routes/{route_id_or_name}/plugins/{plugin_id}",["19"],{},"delete-plugin-with-route","Delete a plugin associated with a route using ID.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Plugins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"c26fb55b0a58f","de5ba47db6f96","204",[],[],"Successfully deleted plugin or the resource didn't exist","db8ba5207f83f","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"50","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},"169aa4b5f4d34","route_id_or_name","simple",[],"The unique identifier or the name of the route to retrieve.",{"type":"77","examples":"78","$schema":"79","x-stoplight":"80"},["81","82","83","84","85","86"],"08b0a33aa66f9","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"77","examples":"87","$schema":"79","x-stoplight":"88"},["81","82","83","84","85","86"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"89","description":"90"},{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96","enum":"97"},"398a06e906a7c","application/json",["98","99","100"],[],{"type":"101","properties":"102","required":"103","title":"104","$schema":"79","x-stoplight":"105"},"string",["106"],"http://json-schema.org/draft-07/schema#",{"id":"107"},"name","in","required","schema","description","title",["108"],{"id":"109"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["95","110"],{"id":"111","key":"112","value":"113","summary":"114"},{"id":"115","key":"116","value":"117","summary":"118"},{"id":"119","key":"120","value":"121","summary":"122"},"object",{"status":"123","message":"124"},["125","126"],"UnauthorizedError",{"id":"127"},"my-route","2f3c46cd3e9a0","response-ratelimiting","9924a9f695fa8","https","a04895885f0f5","DuplicateApiKey",{"message":"114","status":401},"Duplicate API key found","cd5a5b709072b","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","b35300f76fdc9","NoAPIKey",{"message":"128","status":401},"No API key found",{"type":"129"},{"type":"77"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/fetch-plugin-with-route",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a plugin associated with a route",["18"],"c9a74c3f9180d","get","/routes/{route_id_or_name}/plugins/{plugin_id}",["19"],{},"fetch-plugin-with-route","Get a plugin associated with a route using ID.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46"],["47"],{"id":"48","url":"49","name":"50","description":"51","variables":"52"},"c26fb55b0a58f","5ed46096fb017","200",[],["53"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","06a45eba38d1c","401",[],["54"],"Unauthorized","06f45eba394a3","404",[],[],"Resource does not exist",{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"57","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"1f36950e36b58","route_id_or_name","simple",[],"The unique identifier or the name of the route to retrieve.",{"type":"88","examples":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96","97"],"1c745a9fd559d","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"88","examples":"98","$schema":"90","x-stoplight":"99"},["92","93","94","95","96","97"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107","enum":"108"},"cdad9c5bd4134","application/json",["109"],[],{"type":"110","properties":"111","$schema":"90","x-stoplight":"112"},"159b4ddb93e11",["113","114","115"],[],{"type":"110","properties":"116","required":"117","title":"118","$schema":"90","x-stoplight":"119"},"string",["120"],"http://json-schema.org/draft-07/schema#",{"id":"121"},"name","in","required","schema","description","title",["122"],{"id":"123"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["106","124"],{"id":"125","key":"126","value":"127"},"object",{"id":"128","name":"129","created_at":"130","route":"131","service":"132","consumer":"133","instance_name":"134","config":"135","protocols":"136","enabled":"137","tags":"138","ordering":"139"},{"id":"140"},{"id":"141","key":"142","value":"143","summary":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"status":"153","message":"154"},["155","156"],"UnauthorizedError",{"id":"157"},"my-route","5eb83180ec387","response-ratelimiting","8b71138e84e01","https","fc0ab48a760b9","Plugin response",{"data":"158","next":"159"},{"type":"88"},{"type":"88","description":"160","examples":"161"},{"type":"162","description":"163"},{"type":"164","description":"165"},{"type":"166","description":"167"},{"type":"168","description":"169"},{"type":"88","description":"170","examples":"171"},{"type":"110","description":"172","properties":"173"},{"type":"174","description":"175","items":"176"},{"type":"177","description":"178","default":true},{"type":"174","description":"179","items":"180"},{"type":"110","description":"181","properties":"182"},"1129d1ef33e52","2f727a92d5345","DuplicateApiKey",{"message":"144","status":401},"Duplicate API key found","6bb24495d92a3","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","17da5a6fd5900","NoAPIKey",{"message":"183","status":401},"No API key found",{"type":"162"},{"type":"88"},"status","message","470b68e5f0549",["184","185"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["186"],"integer","Unix epoch when the resource was created.",["88","187"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["88","187"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["88","187"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["188"],"The configuration properties for the plugin",{"hour":"189","minute":"190"},"array","A list of the request protocols that will trigger this plugin.",{"type":"88","enum":"191","default":"106"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"88"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"192"},"No API key found in request",{"id":"193","name":"186","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"194","protocols":"195","enabled":true,"tags":"196","ordering":"197"},{"id":"198","name":"186","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"199","protocols":"200","enabled":true,"tags":"201","ordering":"202"},"rate-limiting","null","rate-limiting-foo",{"type":"162","examples":"203"},{"type":"162","examples":"204"},["106","205","206","207","208"],{"type":"174","items":"209"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["106","124"],["210","211"],{"before":"212"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["208","207"],["213","214","215"],{"after":"216"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"88"},"user-level","low-priority",["217"],"admin","high-priority","critical",["217"],"plugin-name"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-plugin-with-route",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a plugin associated with a route",["18"],"f896729f76f6e","patch","/routes/{route_id_or_name}/plugins/{plugin_id}",["19"],{},"update-plugin-with-route","Update a plugin associated with a route using ID.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"Plugins",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55","56"],["57"],{"id":"58","url":"59","name":"60","description":"61","variables":"62"},"c26fb55b0a58f","4f9349bac4d45","200",[],["63"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","1cf34a635bc5a","400",[],["64"],"Invalid plugin","1d034a635be09","401",[],["65"],"Unauthorized","1cb34a635a696","404",[],[],"Resource does not exist","f68a84c74f4e6",["66"],"Plugin request body",{"id":"67","name":"68","style":"69","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","name":"75","style":"69","examples":"76","description":"77","required":true,"schema":"78","explicitProperties":"79"},{"id":"80","key":"81","extensions":"82","description":"83","type":"84","name":"85","in":"86"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"87","path":"88","port":"89","protocol":"90"},{"id":"91","mediaType":"92","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"92","examples":"97","encodings":"98","schema":"99"},{"id":"100","mediaType":"92","examples":"101","encodings":"102","schema":"103"},{"id":"104","mediaType":"92","examples":"105","encodings":"106","schema":"107"},"81740c09e08db","route_id_or_name","simple",[],"The unique identifier or the name of the route to retrieve.",{"type":"108","examples":"109","$schema":"110","x-stoplight":"111"},["112","113","114","115","116","117"],"5ecc22bc91cce","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"108","examples":"118","$schema":"110","x-stoplight":"119"},["112","113","114","115","116","117"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"120","description":"121"},{"default":"122","description":"123"},{"default":"124","description":"125"},{"default":"126","description":"127","enum":"128"},"d59295dddb821","application/json",["129"],[],{"type":"130","properties":"131","$schema":"110","x-stoplight":"132"},"b23a1f429aa1c",[],[],{"type":"130","$schema":"110","x-stoplight":"133"},"d61d77651ea48",["134","135","136"],[],{"type":"130","properties":"137","required":"138","title":"139","$schema":"110","x-stoplight":"140"},"f4c36dd4a5aa7",["141"],[],{"type":"130","x-examples":"142","properties":"143","$schema":"110","x-stoplight":"144"},"string",["145"],"http://json-schema.org/draft-07/schema#",{"id":"146"},"name","in","required","schema","description","title",["147"],{"id":"148"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["126","149"],{"id":"150","key":"151","value":"152"},"object",{"id":"153","name":"154","created_at":"155","route":"156","service":"157","consumer":"158","instance_name":"159","config":"160","protocols":"161","enabled":"162","tags":"163","ordering":"164"},{"id":"165"},{"id":"166"},{"id":"167","key":"168","value":"169","summary":"170"},{"id":"171","key":"172","value":"173","summary":"174"},{"id":"175","key":"176","value":"177","summary":"178"},{"status":"179","message":"180"},["181","182"],"UnauthorizedError",{"id":"183"},{"id":"184","key":"185","value":"186"},{"Example 1":"187"},{"name":"188","route":"189","service":"190","consumer":"191","instance_name":"192","config":"193","protocols":"194","enabled":"195","tags":"196","ordering":"197"},{"id":"198"},"my-route","99f0a3aeaeba5","response-ratelimiting","1c5c358883844","https","f4eb2886a92f8","Plugin response",{"data":"199","next":"200"},{"type":"108"},{"type":"108","description":"201","examples":"202"},{"type":"203","description":"204"},{"type":"205","description":"206"},{"type":"207","description":"208"},{"type":"209","description":"210"},{"type":"108","description":"211","examples":"212"},{"type":"130","description":"213","properties":"214"},{"type":"215","description":"216","items":"217"},{"type":"218","description":"219","default":true},{"type":"215","description":"220","items":"221"},{"type":"130","description":"222","properties":"223"},"1129d1ef33e52","ea7f28a4565a2","e4d02c4d69731","DuplicateApiKey",{"message":"170","status":401},"Duplicate API key found","9f4db8373905d","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","a546a1d117d4f","NoAPIKey",{"message":"224","status":401},"No API key found",{"type":"203"},{"type":"108"},"status","message","470b68e5f0549","1c630d2a02ae0","request example",{"name":"225","route":"108","service":"108","consumer":"108","instance_name":"226","config":"227","protocols":"228","enabled":true,"tags":"229","ordering":"230"},{"name":"225","route":null,"service":null,"consumer":null,"instance_name":"226","config":"231","protocols":"232","enabled":true,"tags":"233","ordering":"234"},{"type":"108","description":"235","examples":"236"},{"type":"237","description":"238"},{"type":"239","description":"208"},{"type":"240","description":"210"},{"type":"108","description":"211","examples":"241"},{"type":"130","description":"213","properties":"242"},{"type":"215","description":"216","items":"243"},{"type":"218","description":"219","default":true},{"type":"215","description":"220","items":"244"},{"type":"130","description":"222","properties":"245"},"7a1b17d9c7f1c",["246","247"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["225"],"integer","Unix epoch when the resource was created.",["108","248"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["108","248"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["108","248"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["226"],"The configuration properties for the plugin",{"hour":"249","minute":"250"},"array","A list of the request protocols that will trigger this plugin.",{"type":"108","enum":"251","default":"126"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"108"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"252"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["126"],["108"],{"before":"253"},{"hour":500,"minute":20},["126","149"],["254","255"],{"before":"256"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["225"],["108","248"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["108","248"],["108","248"],["226"],{"hour":"257","minute":"258"},{"type":"108","enum":"259","default":"126"},{"type":"108"},{"before":"260"},{"id":"261","name":"225","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"262","protocols":"263","enabled":true,"tags":"264","ordering":"265"},{"id":"266","name":"225","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"267","protocols":"268","enabled":true,"tags":"269","ordering":"270"},"null",{"type":"203","examples":"271"},{"type":"203","examples":"272"},["126","273","274","275","276"],{"type":"215","items":"277"},["108"],"user-level","low-priority",["278"],{"type":"203","examples":"279"},{"type":"203","examples":"280"},["126","273","274","275","276"],{"type":"215","items":"281"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["126","149"],["254","255"],{"before":"282"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["276","275"],["283","284","285"],{"after":"286"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"108"},"plugin-name",[500],[500],{"type":"108"},["278"],"admin","high-priority","critical",["278"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-plugin-with-route",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a plugin associated with a route",["18"],"2aaff7332a529","put","/routes/{route_id_or_name}/plugins/{plugin_id}",["19"],{},"upsert-plugin-with-route","Create or Update a plugin associated with a route using ID.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Plugins",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"c26fb55b0a58f","643963625f5de","200",[],["57"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","bc59653f21fd6","400",[],["58"],"Invalid plugin","bc49653f21c01","401",[],["59"],"Unauthorized","33acb70388199",["60"],"Plugin request body",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"101"},"45e900606dfc3","route_id_or_name","simple",[],"The unique identifier or the name of the route to retrieve.",{"type":"102","examples":"103","$schema":"104","x-stoplight":"105"},["106","107","108","109","110","111"],"e19cacd1d4578","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"102","examples":"112","$schema":"104","x-stoplight":"113"},["106","107","108","109","110","111"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121","enum":"122"},"c3a8611508f21","application/json",["123"],[],{"type":"124","properties":"125","$schema":"104","x-stoplight":"126"},"c063947d6552e",[],[],{"type":"124","$schema":"104","x-stoplight":"127"},"4200598feefce",["128","129","130"],[],{"type":"124","properties":"131","required":"132","title":"133","$schema":"104","x-stoplight":"134"},"9d1751739fada",["135"],[],{"type":"124","x-examples":"136","properties":"137","$schema":"104","x-stoplight":"138"},"string",["139"],"http://json-schema.org/draft-07/schema#",{"id":"140"},"name","in","required","schema","description","title",["141"],{"id":"142"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["120","143"],{"id":"144","key":"145","value":"146"},"object",{"id":"147","name":"148","created_at":"149","route":"150","service":"151","consumer":"152","instance_name":"153","config":"154","protocols":"155","enabled":"156","tags":"157","ordering":"158"},{"id":"159"},{"id":"160"},{"id":"161","key":"162","value":"163","summary":"164"},{"id":"165","key":"166","value":"167","summary":"168"},{"id":"169","key":"170","value":"171","summary":"172"},{"status":"173","message":"174"},["175","176"],"UnauthorizedError",{"id":"177"},{"id":"178","key":"179","value":"180"},{"Example 1":"181"},{"name":"182","route":"183","service":"184","consumer":"185","instance_name":"186","config":"187","protocols":"188","enabled":"189","tags":"190","ordering":"191"},{"id":"192"},"my-route","6430dc4b361ae","response-ratelimiting","2d4b6068bcf08","https","49b0162e5ee84","Plugin response",{"data":"193","next":"194"},{"type":"102"},{"type":"102","description":"195","examples":"196"},{"type":"197","description":"198"},{"type":"199","description":"200"},{"type":"201","description":"202"},{"type":"203","description":"204"},{"type":"102","description":"205","examples":"206"},{"type":"124","description":"207","properties":"208"},{"type":"209","description":"210","items":"211"},{"type":"212","description":"213","default":true},{"type":"209","description":"214","items":"215"},{"type":"124","description":"216","properties":"217"},"1129d1ef33e52","b262924737528","81c3bef215820","DuplicateApiKey",{"message":"164","status":401},"Duplicate API key found","61685c4871b57","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","62f11a6a45986","NoAPIKey",{"message":"218","status":401},"No API key found",{"type":"197"},{"type":"102"},"status","message","470b68e5f0549","da0076e56a512","request example",{"name":"219","route":"102","service":"102","consumer":"102","instance_name":"220","config":"221","protocols":"222","enabled":true,"tags":"223","ordering":"224"},{"name":"219","route":null,"service":null,"consumer":null,"instance_name":"220","config":"225","protocols":"226","enabled":true,"tags":"227","ordering":"228"},{"type":"102","description":"229","examples":"230"},{"type":"231","description":"232"},{"type":"233","description":"202"},{"type":"234","description":"204"},{"type":"102","description":"205","examples":"235"},{"type":"124","description":"207","properties":"236"},{"type":"209","description":"210","items":"237"},{"type":"212","description":"213","default":true},{"type":"209","description":"214","items":"238"},{"type":"124","description":"216","properties":"239"},"7a1b17d9c7f1c",["240","241"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["219"],"integer","Unix epoch when the resource was created.",["102","242"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["102","242"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["102","242"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["220"],"The configuration properties for the plugin",{"hour":"243","minute":"244"},"array","A list of the request protocols that will trigger this plugin.",{"type":"102","enum":"245","default":"120"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"102"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"246"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["120"],["102"],{"before":"247"},{"hour":500,"minute":20},["120","143"],["248","249"],{"before":"250"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["219"],["102","242"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["102","242"],["102","242"],["220"],{"hour":"251","minute":"252"},{"type":"102","enum":"253","default":"120"},{"type":"102"},{"before":"254"},{"id":"255","name":"219","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"256","protocols":"257","enabled":true,"tags":"258","ordering":"259"},{"id":"260","name":"219","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"261","protocols":"262","enabled":true,"tags":"263","ordering":"264"},"null",{"type":"197","examples":"265"},{"type":"197","examples":"266"},["120","267","268","269","270"],{"type":"209","items":"271"},["102"],"user-level","low-priority",["272"],{"type":"197","examples":"273"},{"type":"197","examples":"274"},["120","267","268","269","270"],{"type":"209","items":"275"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["120","143"],["248","249"],{"before":"276"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["270","269"],["277","278","279"],{"after":"280"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"102"},"plugin-name",[500],[500],{"type":"102"},["272"],"admin","high-priority","critical",["272"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-plugins-with-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all plugins associated with a Service",["17"],"32e923e20ceea","get","/services/{service_id_or_name}/plugins",["18"],{},"list-plugins-with-service","inheritedFromService",["19"],{"headers":"20","query":"21","cookie":"22","path":"23"},["24"],["25"],"Plugins",{"id":"26","name":"17"},{"id":"27","code":"28","headers":"29","contents":"30","description":"31"},[],["32","33","34"],[],["35"],["36"],{"id":"37","url":"38","name":"39","description":"40","variables":"41"},"c26fb55b0a58f","d148b51dd367b","200",[],["42"],"A successful response listing plugins",{"id":"43","name":"44","style":"45","examples":"46","description":"47","schema":"48","explicitProperties":"49"},{"id":"50","name":"51","style":"45","examples":"52","description":"53","schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"45","examples":"58","description":"59","schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"64","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","key":"70","extensions":"71","description":"72","type":"73","name":"74","in":"75"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"76","path":"77","port":"78","protocol":"79"},{"id":"80","mediaType":"81","examples":"82","encodings":"83","schema":"84"},"c537df6b9dbaf","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92"],"a72c432f13b34","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"93","$schema":"86","x-stoplight":"94"},["88","89","90","91","92"],"0b571c37533b6","tags",["95"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"93","examples":"96","x-stoplight":"97","$schema":"86"},["88","98","89","90","91","92"],"f77428dee6472","service_id_or_name","simple",["99"],"ID **or** name of the service to lookup",{"type":"93","examples":"100","$schema":"86","x-stoplight":"101"},["90","88","98","89","102","91","92"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"103","description":"104"},{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110","enum":"111"},"e24695d901193","application/json",[],[],{"properties":"112","$schema":"86","x-stoplight":"113"},"integer","http://json-schema.org/draft-07/schema#",{"id":"114"},"description","in","name","schema","title","string",{"id":"115"},{"id":"116","value":"117","key":"118"},["117"],{"explicitProperties":"119","id":"120"},"example",{"id":"121","value":"122","key":"118"},["122"],{"id":"123"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["109","124"],{"data":"125","offset":"126"},{"id":"127"},"3adcdd65a0865","77ca70fcb91ff","54f5c2d051259","tag1,tag2","default",["128","129","130"],"d4a3fedb84e20","795c524a1e5e2","test-service","11cc14c1d854b","https",{"items":"131","type":"132"},{"description":"133","type":"93","title":"134"},"7e43622ab05e1","type","nullable","examples",{"description":"135","properties":"136","type":"137","title":"138","examples":"139"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","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":"140","consumer":"141","consumer_group":"142","created_at":"143","enabled":"144","id":"145","name":"146","ordering":"147","protocols":"148","route":"149","service":"150","tags":"151","updated_at":"152"},"object","Plugin",["153"],{"description":"154","type":"137"},{"additionalProperties":false,"description":"155","properties":"156","type":"137"},{"additionalProperties":false,"description":"157","properties":"158","type":"137"},{"description":"159","type":"85"},{"default":true,"description":"160","type":"161"},{"type":"93"},{"description":"162","type":"93"},{"type":"137"},{"default":"163","description":"164","items":"165","type":"132"},{"additionalProperties":false,"description":"166","properties":"167","type":"137"},{"additionalProperties":false,"description":"168","properties":"169","type":"137"},{"description":"170","items":"171","type":"132"},{"description":"172","type":"85"},{"config":"173","enabled":true,"id":"174","name":"175","protocols":"176"},"The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).","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":"177"},"If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",{"id":"178"},"Unix epoch when the resource was created.","Whether the plugin is applied.","boolean","The name of the plugin that's going to be added. The plugin must be installed in every Kong instance separately.",["179","180","109","124"],"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`.",{"type":"93"},"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":"181"},"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":"182"},"An optional set of strings associated with the plugin for grouping and filtering.",{"type":"93"},"Unix epoch when the resource was last updated.",{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":"183","run_on_preflight":true},"3fd1eea1-885a-4011-b986-289943ff8177","key-auth",["179","180","109","124"],{"type":"93"},{"type":"93"},"grpc","grpcs",{"type":"93"},{"type":"93"},["184"],"apikey"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-plugin-with-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new plugin associated with a Service",["17"],"7801f6744478c","post","/services/{service_id_or_name}/plugins",["18"],{},"create-plugin-with-service","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48"],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"c26fb55b0a58f","299b2fca1f91d","200",[],["55"],"Successfully created plugin","d17b2ded5c698","400",[],["56"],"Invalid plugin","d18b2ded5d94b","401",[],["57"],"Unauthorized","8def8286ff3bd",["58"],"Plugin request body",{"id":"59","name":"60","style":"61","examples":"62","description":"63","required":true,"schema":"64","explicitProperties":"65"},{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},{"id":"86","mediaType":"78","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"78","examples":"91","encodings":"92","schema":"93"},"af5f813cb82aa","service_id_or_name","simple",["94"],"ID **or** name of the service to lookup",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104","105"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111"},{"default":"112","description":"113","enum":"114"},"dc9feabd865bd","application/json",["115"],[],{"description":"116","properties":"117","type":"118","title":"119","examples":"120"},"dae5f07da73a7",[],[],{"type":"118","$schema":"97","x-stoplight":"121"},"358af7ce6ca2d",["122","123","124"],[],{"type":"118","properties":"125","required":"126","title":"127","$schema":"97","x-stoplight":"128"},"d5c5a96f58168",["129"],[],{"type":"118","x-examples":"130","properties":"131","$schema":"97","x-stoplight":"132"},{"id":"133","value":"134","key":"135"},"string",["134"],"http://json-schema.org/draft-07/schema#",{"id":"136"},"name","description","example","in","required","schema","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["112","137"],{"id":"138","value":"139","key":"135"},"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":"140","consumer":"141","consumer_group":"142","created_at":"143","enabled":"144","id":"145","name":"146","ordering":"147","protocols":"148","route":"149","service":"150","tags":"151","updated_at":"152"},"object","Plugin",["139"],{"id":"153"},{"id":"154","key":"155","value":"156","summary":"157"},{"id":"158","key":"159","value":"160","summary":"161"},{"id":"162","key":"163","value":"164","summary":"165"},{"status":"166","message":"167"},["168","169"],"UnauthorizedError",{"id":"170"},{"id":"171","key":"172","value":"173"},{"Example 1":"174"},{"name":"175","route":"176","service":"177","consumer":"178","instance_name":"179","config":"180","protocols":"181","enabled":"182","tags":"183","ordering":"184"},{"id":"185"},"aca7f4b7c9460","test-service","default","740fcc10aad12","https","862b9ccccf367",{"config":"186","enabled":true,"id":"187","name":"188","protocols":"189"},{"description":"190","type":"118"},{"additionalProperties":false,"description":"191","properties":"192","type":"118"},{"additionalProperties":false,"description":"193","properties":"194","type":"118"},{"description":"195","type":"196"},{"default":true,"description":"197","type":"198"},{"type":"95"},{"description":"199","type":"95"},{"type":"118"},{"default":"200","description":"201","items":"202","type":"203"},{"additionalProperties":false,"description":"204","properties":"205","type":"118"},{"additionalProperties":false,"description":"206","properties":"207","type":"118"},{"description":"208","items":"209","type":"203"},{"description":"210","type":"196"},"024611fc4ca6b","7bbf6e970c302","DuplicateApiKey",{"message":"157","status":401},"Duplicate API key found","ace2fabf543c6","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","6aa4271defc7e","NoAPIKey",{"message":"211","status":401},"No API key found",{"type":"196"},{"type":"95"},"status","message","470b68e5f0549","5be6ff5f1be62","request example",{"name":"212","route":"95","service":"95","consumer":"95","instance_name":"213","config":"214","protocols":"215","enabled":true,"tags":"216","ordering":"217"},{"name":"212","route":null,"service":null,"consumer":null,"instance_name":"213","config":"218","protocols":"219","enabled":true,"tags":"220","ordering":"221"},{"type":"95","description":"222","examples":"223"},{"type":"224","description":"225"},{"type":"226","description":"227"},{"type":"228","description":"229"},{"type":"95","description":"230","examples":"231"},{"type":"118","description":"232","properties":"233"},{"type":"203","description":"234","items":"235"},{"type":"198","description":"236","default":true},{"type":"203","description":"237","items":"238"},{"type":"118","description":"239","properties":"240"},"7a1b17d9c7f1c",{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":"241","run_on_preflight":true},"3fd1eea1-885a-4011-b986-289943ff8177","key-auth",["242","243","112","137"],"The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).","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":"244"},"If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",{"id":"245"},"Unix epoch when the resource was created.","integer","Whether the plugin is applied.","boolean","The name of the plugin that's going to be added. The plugin must be installed in every Kong instance separately.",["242","243","112","137"],"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`.",{"type":"95"},"array","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":"246"},"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":"247"},"An optional set of strings associated with the plugin for grouping and filtering.",{"type":"95"},"Unix epoch when the resource was last updated.","No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["112"],["95"],{"before":"248"},{"hour":500,"minute":20},["112","137"],["249","250"],{"before":"251"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["212"],["95","252"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["95","252"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["95","252"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["213"],"The configuration properties for the plugin",{"hour":"253","minute":"254"},"A list of the request protocols that will trigger this plugin.",{"type":"95","enum":"255","default":"112"},"Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"95"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"256"},["257"],"grpc","grpcs",{"type":"95"},{"type":"95"},{"type":"95"},{"type":"95"},["95"],"user-level","low-priority",["258"],"null",{"type":"196","examples":"259"},{"type":"196","examples":"260"},["112","242","243","261","262"],{"type":"203","items":"263"},"apikey","plugin-name",[500],[500],"tls","tcp",{"type":"95"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-plugin-with-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a plugin associated with a Service",["18"],"32e800f8b774a","delete","/services/{service_id_or_name}/plugins/{plugin_id}",["19"],{},"delete-plugin-with-service","Delete a plugin associated with a Service using ID.","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Plugins",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33","34"],["35"],{"id":"36","url":"37","name":"38","description":"39","variables":"40"},"c26fb55b0a58f","4e873e6e8a64c","204",[],[],"Successfully deleted plugin or the resource didn't exist",{"id":"41","name":"42","style":"43","examples":"44","description":"45","required":true,"schema":"46","explicitProperties":"47"},{"id":"48","name":"49","style":"43","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},"3503f4511781d","service_id_or_name","simple",["65"],"ID **or** name of the service to lookup",{"type":"66","examples":"67","$schema":"68","x-stoplight":"69"},["70","71","72","73","74","75","76"],"18494a995ac0d","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"66","examples":"77","$schema":"68","x-stoplight":"78"},["70","73","74","75","71","76"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86","enum":"87"},{"id":"88","value":"89","key":"90"},"string",["89"],"http://json-schema.org/draft-07/schema#",{"id":"91"},"name","description","example","in","required","schema","title",["92"],{"id":"93"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["85","94"],"1d283f2dfe799","test-service","default","dd474ceafef89","response-ratelimiting","6eae421f0c18d","https"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/fetch-plugin-with-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a plugin associated with a Service",["18"],"64922eff98390","get","/services/{service_id_or_name}/plugins/{plugin_id}",["19"],{},"fetch-plugin-with-service","Get a plugin associated with a Service using ID.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46"],["47"],{"id":"48","url":"49","name":"50","description":"51","variables":"52"},"c26fb55b0a58f","cb807937d358a","200",[],["53"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","f3b07afd7cc40","401",[],["54"],"Unauthorized","f3607afd7c4c3","404",[],[],"Resource does not exist",{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"57","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"8fe429de8d1a0","service_id_or_name","simple",["88"],"ID **or** name of the service to lookup",{"type":"89","examples":"90","$schema":"91","x-stoplight":"92"},["93","94","95","96","97","98","99"],"d848e1659ca77","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"89","examples":"100","$schema":"91","x-stoplight":"101"},["93","96","97","98","94","99"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109","enum":"110"},"b9e6a7263011d","application/json",["111"],[],{"type":"112","properties":"113","$schema":"91","x-stoplight":"114"},"63ce9bf967b74",["115","116","117"],[],{"type":"112","properties":"118","required":"119","title":"120","$schema":"91","x-stoplight":"121"},{"id":"122","value":"123","key":"124"},"string",["123"],"http://json-schema.org/draft-07/schema#",{"id":"125"},"name","description","example","in","required","schema","title",["126"],{"id":"127"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["108","128"],{"id":"129","key":"130","value":"131"},"object",{"id":"132","name":"133","created_at":"134","route":"135","service":"136","consumer":"137","instance_name":"138","config":"139","protocols":"140","enabled":"141","tags":"142","ordering":"143"},{"id":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},{"status":"157","message":"158"},["159","160"],"UnauthorizedError",{"id":"161"},"50873d9ec6b6d","test-service","default","1b05072ad8448","response-ratelimiting","b3317b28d46aa","https","a54e9ccc98add","Plugin response",{"data":"162","next":"163"},{"type":"89"},{"type":"89","description":"164","examples":"165"},{"type":"166","description":"167"},{"type":"168","description":"169"},{"type":"170","description":"171"},{"type":"172","description":"173"},{"type":"89","description":"174","examples":"175"},{"type":"112","description":"176","properties":"177"},{"type":"178","description":"179","items":"180"},{"type":"181","description":"182","default":true},{"type":"178","description":"183","items":"184"},{"type":"112","description":"185","properties":"186"},"1129d1ef33e52","0618ec13a1826","DuplicateApiKey",{"message":"148","status":401},"Duplicate API key found","3da7b45586a81","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","05f8fe2bdf124","NoAPIKey",{"message":"187","status":401},"No API key found",{"type":"166"},{"type":"89"},"status","message","470b68e5f0549",["188","189"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["190"],"integer","Unix epoch when the resource was created.",["89","191"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["89","191"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["89","191"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["192"],"The configuration properties for the plugin",{"hour":"193","minute":"194"},"array","A list of the request protocols that will trigger this plugin.",{"type":"89","enum":"195","default":"108"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"89"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"196"},"No API key found in request",{"id":"197","name":"190","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"198","protocols":"199","enabled":true,"tags":"200","ordering":"201"},{"id":"202","name":"190","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"203","protocols":"204","enabled":true,"tags":"205","ordering":"206"},"rate-limiting","null","rate-limiting-foo",{"type":"166","examples":"207"},{"type":"166","examples":"208"},["108","209","210","211","212"],{"type":"178","items":"213"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["108","128"],["214","215"],{"before":"216"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["212","211"],["217","218","219"],{"after":"220"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"89"},"user-level","low-priority",["221"],"admin","high-priority","critical",["221"],"plugin-name"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-plugin-with-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a plugin associated with a Service",["18"],"dd06235a5b4d4","patch","/services/{service_id_or_name}/plugins/{plugin_id}",["19"],{},"update-plugin-with-service","Update a plugin associated with a Service using ID.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"Plugins",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55","56"],["57"],{"id":"58","url":"59","name":"60","description":"61","variables":"62"},"c26fb55b0a58f","3fa071c1698ac","200",[],["63"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","9fc0739e39da0","400",[],["64"],"Invalid plugin","9fb0739e39c77","401",[],["65"],"Unauthorized","9f80739e3836c","404",[],[],"Resource does not exist","4da36625c356b",["66"],"Plugin request body",{"id":"67","name":"68","style":"69","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","name":"75","style":"69","examples":"76","description":"77","required":true,"schema":"78","explicitProperties":"79"},{"id":"80","key":"81","extensions":"82","description":"83","type":"84","name":"85","in":"86"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"87","path":"88","port":"89","protocol":"90"},{"id":"91","mediaType":"92","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"92","examples":"97","encodings":"98","schema":"99"},{"id":"100","mediaType":"92","examples":"101","encodings":"102","schema":"103"},{"id":"104","mediaType":"92","examples":"105","encodings":"106","schema":"107"},"c4bbd50bace0f","service_id_or_name","simple",["108"],"ID **or** name of the service to lookup",{"type":"109","examples":"110","$schema":"111","x-stoplight":"112"},["113","114","115","116","117","118","119"],"ebaf4d2f7992b","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"109","examples":"120","$schema":"111","x-stoplight":"121"},["113","116","117","118","114","119"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"122","description":"123"},{"default":"124","description":"125"},{"default":"126","description":"127"},{"default":"128","description":"129","enum":"130"},"ef863b8f59ac8","application/json",["131"],[],{"type":"132","properties":"133","$schema":"111","x-stoplight":"134"},"e916a23b1420a",[],[],{"type":"132","$schema":"111","x-stoplight":"135"},"a234b7f1a592c",["136","137","138"],[],{"type":"132","properties":"139","required":"140","title":"141","$schema":"111","x-stoplight":"142"},"695d088fdfcea",["143"],[],{"type":"132","x-examples":"144","properties":"145","$schema":"111","x-stoplight":"146"},{"id":"147","value":"148","key":"149"},"string",["148"],"http://json-schema.org/draft-07/schema#",{"id":"150"},"name","description","example","in","required","schema","title",["151"],{"id":"152"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["128","153"],{"id":"154","key":"155","value":"156"},"object",{"id":"157","name":"158","created_at":"159","route":"160","service":"161","consumer":"162","instance_name":"163","config":"164","protocols":"165","enabled":"166","tags":"167","ordering":"168"},{"id":"169"},{"id":"170"},{"id":"171","key":"172","value":"173","summary":"174"},{"id":"175","key":"176","value":"177","summary":"178"},{"id":"179","key":"180","value":"181","summary":"182"},{"status":"183","message":"184"},["185","186"],"UnauthorizedError",{"id":"187"},{"id":"188","key":"189","value":"190"},{"Example 1":"191"},{"name":"192","route":"193","service":"194","consumer":"195","instance_name":"196","config":"197","protocols":"198","enabled":"199","tags":"200","ordering":"201"},{"id":"202"},"fb86a33e1d979","test-service","default","30a3e407c70d9","response-ratelimiting","a86dc821b9f0a","https","767aeab11599b","Plugin response",{"data":"203","next":"204"},{"type":"109"},{"type":"109","description":"205","examples":"206"},{"type":"207","description":"208"},{"type":"209","description":"210"},{"type":"211","description":"212"},{"type":"213","description":"214"},{"type":"109","description":"215","examples":"216"},{"type":"132","description":"217","properties":"218"},{"type":"219","description":"220","items":"221"},{"type":"222","description":"223","default":true},{"type":"219","description":"224","items":"225"},{"type":"132","description":"226","properties":"227"},"1129d1ef33e52","f88937f4240be","4f39e76ada35d","DuplicateApiKey",{"message":"174","status":401},"Duplicate API key found","e57b99d348794","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","ef360e69f112d","NoAPIKey",{"message":"228","status":401},"No API key found",{"type":"207"},{"type":"109"},"status","message","470b68e5f0549","091ea94a4975a","request example",{"name":"229","route":"109","service":"109","consumer":"109","instance_name":"230","config":"231","protocols":"232","enabled":true,"tags":"233","ordering":"234"},{"name":"229","route":null,"service":null,"consumer":null,"instance_name":"230","config":"235","protocols":"236","enabled":true,"tags":"237","ordering":"238"},{"type":"109","description":"239","examples":"240"},{"type":"241","description":"242"},{"type":"243","description":"212"},{"type":"244","description":"214"},{"type":"109","description":"215","examples":"245"},{"type":"132","description":"217","properties":"246"},{"type":"219","description":"220","items":"247"},{"type":"222","description":"223","default":true},{"type":"219","description":"224","items":"248"},{"type":"132","description":"226","properties":"249"},"7a1b17d9c7f1c",["250","251"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["229"],"integer","Unix epoch when the resource was created.",["109","252"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["109","252"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["109","252"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["230"],"The configuration properties for the plugin",{"hour":"253","minute":"254"},"array","A list of the request protocols that will trigger this plugin.",{"type":"109","enum":"255","default":"128"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"109"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"256"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["128"],["109"],{"before":"257"},{"hour":500,"minute":20},["128","153"],["258","259"],{"before":"260"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["229"],["109","252"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["109","252"],["109","252"],["230"],{"hour":"261","minute":"262"},{"type":"109","enum":"263","default":"128"},{"type":"109"},{"before":"264"},{"id":"265","name":"229","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"266","protocols":"267","enabled":true,"tags":"268","ordering":"269"},{"id":"270","name":"229","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"271","protocols":"272","enabled":true,"tags":"273","ordering":"274"},"null",{"type":"207","examples":"275"},{"type":"207","examples":"276"},["128","277","278","279","280"],{"type":"219","items":"281"},["109"],"user-level","low-priority",["282"],{"type":"207","examples":"283"},{"type":"207","examples":"284"},["128","277","278","279","280"],{"type":"219","items":"285"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["128","153"],["258","259"],{"before":"286"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["280","279"],["287","288","289"],{"after":"290"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"109"},"plugin-name",[500],[500],{"type":"109"},["282"],"admin","high-priority","critical",["282"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-plugin-with-service",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a plugin associated with a Service",["18"],"cd9fe4bd5b7fb","put","/services/{service_id_or_name}/plugins/{plugin_id}",["19"],{},"upsert-plugin-with-service","Create or Update a plugin associated with a Service using ID.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Plugins",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"c26fb55b0a58f","b4d40b1e0a047","200",[],["57"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","4a340baf7acf5","400",[],["58"],"Invalid plugin","4a440baf7a2a6","401",[],["59"],"Unauthorized","399f06bbfd7da",["60"],"Plugin request body",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"101"},"6bed0c45c465f","service_id_or_name","simple",["102"],"ID **or** name of the service to lookup",{"type":"103","examples":"104","$schema":"105","x-stoplight":"106"},["107","108","109","110","111","112","113"],"31237e6029090","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"103","examples":"114","$schema":"105","x-stoplight":"115"},["107","110","111","112","108","113"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121"},{"default":"122","description":"123","enum":"124"},"9e0fe8166b26c","application/json",["125"],[],{"type":"126","properties":"127","$schema":"105","x-stoplight":"128"},"ee9ffed2b3b21",[],[],{"type":"126","$schema":"105","x-stoplight":"129"},"761c469cb70ea",["130","131","132"],[],{"type":"126","properties":"133","required":"134","title":"135","$schema":"105","x-stoplight":"136"},"e6f473243aa20",["137"],[],{"type":"126","x-examples":"138","properties":"139","$schema":"105","x-stoplight":"140"},{"id":"141","value":"142","key":"143"},"string",["142"],"http://json-schema.org/draft-07/schema#",{"id":"144"},"name","description","example","in","required","schema","title",["145"],{"id":"146"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["122","147"],{"id":"148","key":"149","value":"150"},"object",{"id":"151","name":"152","created_at":"153","route":"154","service":"155","consumer":"156","instance_name":"157","config":"158","protocols":"159","enabled":"160","tags":"161","ordering":"162"},{"id":"163"},{"id":"164"},{"id":"165","key":"166","value":"167","summary":"168"},{"id":"169","key":"170","value":"171","summary":"172"},{"id":"173","key":"174","value":"175","summary":"176"},{"status":"177","message":"178"},["179","180"],"UnauthorizedError",{"id":"181"},{"id":"182","key":"183","value":"184"},{"Example 1":"185"},{"name":"186","route":"187","service":"188","consumer":"189","instance_name":"190","config":"191","protocols":"192","enabled":"193","tags":"194","ordering":"195"},{"id":"196"},"d23700ceda3f9","test-service","default","d4b187e3bb4a0","response-ratelimiting","ecc85beecf193","https","18261ed818df3","Plugin response",{"data":"197","next":"198"},{"type":"103"},{"type":"103","description":"199","examples":"200"},{"type":"201","description":"202"},{"type":"203","description":"204"},{"type":"205","description":"206"},{"type":"207","description":"208"},{"type":"103","description":"209","examples":"210"},{"type":"126","description":"211","properties":"212"},{"type":"213","description":"214","items":"215"},{"type":"216","description":"217","default":true},{"type":"213","description":"218","items":"219"},{"type":"126","description":"220","properties":"221"},"1129d1ef33e52","e694179904bce","3480724db1dae","DuplicateApiKey",{"message":"168","status":401},"Duplicate API key found","fde98833d0bea","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","5bd1e190692cf","NoAPIKey",{"message":"222","status":401},"No API key found",{"type":"201"},{"type":"103"},"status","message","470b68e5f0549","7c892873ba5ce","request example",{"name":"223","route":"103","service":"103","consumer":"103","instance_name":"224","config":"225","protocols":"226","enabled":true,"tags":"227","ordering":"228"},{"name":"223","route":null,"service":null,"consumer":null,"instance_name":"224","config":"229","protocols":"230","enabled":true,"tags":"231","ordering":"232"},{"type":"103","description":"233","examples":"234"},{"type":"235","description":"236"},{"type":"237","description":"206"},{"type":"238","description":"208"},{"type":"103","description":"209","examples":"239"},{"type":"126","description":"211","properties":"240"},{"type":"213","description":"214","items":"241"},{"type":"216","description":"217","default":true},{"type":"213","description":"218","items":"242"},{"type":"126","description":"220","properties":"243"},"7a1b17d9c7f1c",["244","245"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["223"],"integer","Unix epoch when the resource was created.",["103","246"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["103","246"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["103","246"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["224"],"The configuration properties for the plugin",{"hour":"247","minute":"248"},"array","A list of the request protocols that will trigger this plugin.",{"type":"103","enum":"249","default":"122"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"103"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"250"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["122"],["103"],{"before":"251"},{"hour":500,"minute":20},["122","147"],["252","253"],{"before":"254"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["223"],["103","246"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["103","246"],["103","246"],["224"],{"hour":"255","minute":"256"},{"type":"103","enum":"257","default":"122"},{"type":"103"},{"before":"258"},{"id":"259","name":"223","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"260","protocols":"261","enabled":true,"tags":"262","ordering":"263"},{"id":"264","name":"223","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"265","protocols":"266","enabled":true,"tags":"267","ordering":"268"},"null",{"type":"201","examples":"269"},{"type":"201","examples":"270"},["122","271","272","273","274"],{"type":"213","items":"275"},["103"],"user-level","low-priority",["276"],{"type":"201","examples":"277"},{"type":"201","examples":"278"},["122","271","272","273","274"],{"type":"213","items":"279"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["122","147"],["252","253"],{"before":"280"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["274","273"],["281","282","283"],{"after":"284"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"103"},"plugin-name",[500],[500],{"type":"103"},["276"],"admin","high-priority","critical",["276"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-plugins-consumer-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all plugins associated with a Consumer in a workspace",["17"],"039824d5bcb0f","get","/{workspace}/consumers/{consumer_username_or_id}/plugins",["18"],{},"list-plugins-consumer-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Plugins",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],["41","42"],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"c26fb55b0a58f","5fc51dfdd6032","200",[],["49"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","37951c382d0ac","401",[],["50"],"Unauthorized",{"id":"51","name":"52","style":"53","examples":"54","description":"55","schema":"56","explicitProperties":"57"},{"id":"58","name":"59","style":"53","examples":"60","description":"61","schema":"62","explicitProperties":"63"},{"id":"64","name":"65","style":"53","examples":"66","description":"67","schema":"68","explicitProperties":"69"},{"id":"70","name":"71","style":"72","examples":"73","description":"74","required":true,"schema":"75","explicitProperties":"76"},{"id":"77","name":"78","style":"72","examples":"79","description":"80","required":true,"schema":"81","explicitProperties":"82"},{"id":"83","key":"84","extensions":"85","description":"86","type":"87","name":"88","in":"89"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"90","path":"91","port":"92","protocol":"93"},{"id":"94","mediaType":"95","examples":"96","encodings":"97","schema":"98"},{"id":"99","mediaType":"95","examples":"100","encodings":"101","schema":"102"},"5bcb3cb6dcf7d","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"103","$schema":"104","x-stoplight":"105"},["106","107","108","109","110"],"8d10495ceef6f","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"111","$schema":"104","x-stoplight":"112"},["106","107","108","109","110"],"2ce786632cc7a","tags",["113"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"111","examples":"114","x-stoplight":"115","$schema":"104"},["106","116","107","108","109","110"],"6332dbd2ac3f9","workspace","simple",[],"Name or ID of workspace",{"type":"111","examples":"117","$schema":"104","x-stoplight":"118"},["108","107","119","109","106","110"],"575b8863c8b08","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"111","examples":"120","$schema":"104","x-stoplight":"121"},["108","107","119","109","106","110"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"122","description":"123"},{"default":"124","description":"125"},{"default":"126","description":"127"},{"default":"128","description":"129","enum":"130"},"394c574e821d3","application/json",["131"],[],{"type":"132","properties":"133","$schema":"104","x-stoplight":"134"},"b1f976b8cb31f",["135","136","137"],[],{"type":"132","properties":"138","required":"139","title":"140","$schema":"104","x-stoplight":"141"},"integer","http://json-schema.org/draft-07/schema#",{"id":"142"},"description","in","name","schema","title","string",{"id":"143"},{"id":"144","value":"145","key":"146"},["145"],{"explicitProperties":"147","id":"148"},"example",["149"],{"id":"150"},"required",["151"],{"id":"152"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["128","153"],{"id":"154","key":"155","value":"156"},"object",{"id":"157","name":"158","created_at":"159","route":"160","service":"161","consumer":"162","instance_name":"163","config":"164","protocols":"165","enabled":"166","tags":"167","ordering":"168"},{"id":"169"},{"id":"170","key":"171","value":"172","summary":"173"},{"id":"174","key":"175","value":"176","summary":"177"},{"id":"178","key":"179","value":"180","summary":"181"},{"status":"182","message":"183"},["184","185"],"UnauthorizedError",{"id":"186"},"fabc128d3b792","cd0882746b10b","cfa72f115a7b1","tag1,tag2","default",["187","188","189"],"261ee96480a55","team-a","9ea3347cf2884","my-username","6992da8d8ecac","https","4f1b5c9fc9bfd","Plugin response",{"data":"190","next":"191"},{"type":"111"},{"type":"111","description":"192","examples":"193"},{"type":"103","description":"194"},{"type":"195","description":"196"},{"type":"197","description":"198"},{"type":"199","description":"200"},{"type":"111","description":"201","examples":"202"},{"type":"132","description":"203","properties":"204"},{"type":"205","description":"206","items":"207"},{"type":"208","description":"209","default":true},{"type":"205","description":"210","items":"211"},{"type":"132","description":"212","properties":"213"},"1129d1ef33e52","b719907ebead3","DuplicateApiKey",{"message":"173","status":401},"Duplicate API key found","84ab95bc67e8c","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","ac332fec99e42","NoAPIKey",{"message":"214","status":401},"No API key found",{"type":"103"},{"type":"111"},"status","message","470b68e5f0549","type","nullable","examples",["215","216"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["217"],"Unix epoch when the resource was created.",["111","218"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["111","218"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["111","218"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["219"],"The configuration properties for the plugin",{"hour":"220","minute":"221"},"array","A list of the request protocols that will trigger this plugin.",{"type":"111","enum":"222","default":"128"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"111"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"223"},"No API key found in request",{"id":"224","name":"217","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"225","protocols":"226","enabled":true,"tags":"227","ordering":"228"},{"id":"229","name":"217","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"230","protocols":"231","enabled":true,"tags":"232","ordering":"233"},"rate-limiting","null","rate-limiting-foo",{"type":"103","examples":"234"},{"type":"103","examples":"235"},["128","236","237","238","239"],{"type":"205","items":"240"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["128","153"],["241","242"],{"before":"243"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["239","238"],["244","245","246"],{"after":"247"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"111"},"user-level","low-priority",["248"],"admin","high-priority","critical",["248"],"plugin-name"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-plugin-with-consumer-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new plugin associated with a Consumer in a workspace",["17"],"117e36cc34c8e","post","/{workspace}/consumers/{consumer_username_or_id}/plugins",["18"],{},"create-plugin-with-consumer-workspace","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48","49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"c26fb55b0a58f","af212c553e13b","200",[],["56"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","19c12bc3ce4e4","400",[],["57"],"Invalid plugin","19b12bc3ce6ab","401",[],["58"],"Unauthorized","88fc039b8cad6",["59"],"Plugin request body",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","name":"68","style":"62","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","key":"74","extensions":"75","description":"76","type":"77","name":"78","in":"79"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"80","path":"81","port":"82","protocol":"83"},{"id":"84","mediaType":"85","examples":"86","encodings":"87","schema":"88"},{"id":"89","mediaType":"85","examples":"90","encodings":"91","schema":"92"},{"id":"93","mediaType":"85","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"85","examples":"98","encodings":"99","schema":"100"},"80d72a0d667d9","workspace","simple",[],"Name or ID of workspace",{"type":"101","examples":"102","$schema":"103","x-stoplight":"104"},["105","106","107","108","109","110"],"88d8c01470303","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"101","examples":"111","$schema":"103","x-stoplight":"112"},["105","106","107","108","109","110"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"40566ea8abb37","application/json",["122"],[],{"type":"123","properties":"124","$schema":"103","x-stoplight":"125"},"f702ae9ae7f2f",[],[],{"type":"123","$schema":"103","x-stoplight":"126"},"ea8f7dc1a802a",["127","128","129"],[],{"type":"123","properties":"130","required":"131","title":"132","$schema":"103","x-stoplight":"133"},"1316461578757",["134"],[],{"type":"123","x-examples":"135","properties":"136","$schema":"103","x-stoplight":"137"},"string",["138"],"http://json-schema.org/draft-07/schema#",{"id":"139"},"name","in","required","schema","description","title",["140"],{"id":"141"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","142"],{"id":"143","key":"144","value":"145"},"object",{"id":"146","name":"147","created_at":"148","route":"149","service":"150","consumer":"151","instance_name":"152","config":"153","protocols":"154","enabled":"155","tags":"156","ordering":"157"},{"id":"158"},{"id":"159"},{"id":"160","key":"161","value":"162","summary":"163"},{"id":"164","key":"165","value":"166","summary":"167"},{"id":"168","key":"169","value":"170","summary":"171"},{"status":"172","message":"173"},["174","175"],"UnauthorizedError",{"id":"176"},{"id":"177","key":"178","value":"179"},{"Example 1":"180"},{"name":"181","route":"182","service":"183","consumer":"184","instance_name":"185","config":"186","protocols":"187","enabled":"188","tags":"189","ordering":"190"},{"id":"191"},"team-a","98d18dc50ae59","my-username","8b2d6b68701e6","https","d8eae18298026","Plugin response",{"data":"192","next":"193"},{"type":"101"},{"type":"101","description":"194","examples":"195"},{"type":"196","description":"197"},{"type":"198","description":"199"},{"type":"200","description":"201"},{"type":"202","description":"203"},{"type":"101","description":"204","examples":"205"},{"type":"123","description":"206","properties":"207"},{"type":"208","description":"209","items":"210"},{"type":"211","description":"212","default":true},{"type":"208","description":"213","items":"214"},{"type":"123","description":"215","properties":"216"},"1129d1ef33e52","da43ed1fb85c5","d63397f976782","DuplicateApiKey",{"message":"163","status":401},"Duplicate API key found","ad977d6c65191","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","6a6f39be66ce9","NoAPIKey",{"message":"217","status":401},"No API key found",{"type":"196"},{"type":"101"},"status","message","470b68e5f0549","197ae49a962e7","request example",{"name":"218","route":"101","service":"101","consumer":"101","instance_name":"219","config":"220","protocols":"221","enabled":true,"tags":"222","ordering":"223"},{"name":"218","route":null,"service":null,"consumer":null,"instance_name":"219","config":"224","protocols":"225","enabled":true,"tags":"226","ordering":"227"},{"type":"101","description":"228","examples":"229"},{"type":"230","description":"231"},{"type":"232","description":"201"},{"type":"233","description":"203"},{"type":"101","description":"204","examples":"234"},{"type":"123","description":"206","properties":"235"},{"type":"208","description":"209","items":"236"},{"type":"211","description":"212","default":true},{"type":"208","description":"213","items":"237"},{"type":"123","description":"215","properties":"238"},"7a1b17d9c7f1c",["239","240"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["218"],"integer","Unix epoch when the resource was created.",["101","241"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["101","241"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["101","241"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["219"],"The configuration properties for the plugin",{"hour":"242","minute":"243"},"array","A list of the request protocols that will trigger this plugin.",{"type":"101","enum":"244","default":"119"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"101"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"245"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["119"],["101"],{"before":"246"},{"hour":500,"minute":20},["119","142"],["247","248"],{"before":"249"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["218"],["101","241"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["101","241"],["101","241"],["219"],{"hour":"250","minute":"251"},{"type":"101","enum":"252","default":"119"},{"type":"101"},{"before":"253"},{"id":"254","name":"218","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"255","protocols":"256","enabled":true,"tags":"257","ordering":"258"},{"id":"259","name":"218","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"260","protocols":"261","enabled":true,"tags":"262","ordering":"263"},"null",{"type":"196","examples":"264"},{"type":"196","examples":"265"},["119","266","267","268","269"],{"type":"208","items":"270"},["101"],"user-level","low-priority",["271"],{"type":"196","examples":"272"},{"type":"196","examples":"273"},["119","266","267","268","269"],{"type":"208","items":"274"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["119","142"],["247","248"],{"before":"275"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["269","268"],["276","277","278"],{"after":"279"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"101"},"plugin-name",[500],[500],{"type":"101"},["271"],"admin","high-priority","critical",["271"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-plugin-with-consumer-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a plugin associated with a Consumer in a workspace",["18"],"358367e6fa67f","delete","/{workspace}/consumers/{consumer_username_or_id}/plugins/{plugin_id}",["19"],{},"delete-plugin-with-consumer-workspace","Delete a plugin associated with a Consumer using ID in a workspace.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Plugins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40","41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"c26fb55b0a58f","7566cf41ca698","204",[],[],"Successfully deleted plugin or the resource didn't exist","cd56d11e8c30f","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","required":true,"schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"51","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},"e84545531446a","workspace","simple",[],"Name or ID of workspace",{"type":"84","examples":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92","93"],"6b21375d6b2eb","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"84","examples":"94","$schema":"86","x-stoplight":"95"},["88","89","90","91","92","93"],"0bdd4e4b7f8f3","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"84","examples":"96","$schema":"86","x-stoplight":"97"},["88","89","90","91","92","93"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"98","description":"99"},{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105","enum":"106"},"1abbcf7dce9e7","application/json",["107","108","109"],[],{"type":"110","properties":"111","required":"112","title":"113","$schema":"86","x-stoplight":"114"},"string",["115"],"http://json-schema.org/draft-07/schema#",{"id":"116"},"name","in","required","schema","description","title",["117"],{"id":"118"},["119"],{"id":"120"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["104","121"],{"id":"122","key":"123","value":"124","summary":"125"},{"id":"126","key":"127","value":"128","summary":"129"},{"id":"130","key":"131","value":"132","summary":"133"},"object",{"status":"134","message":"135"},["136","137"],"UnauthorizedError",{"id":"138"},"team-a","f20664f07a35f","my-username","96bb5e6abb399","response-ratelimiting","6ef4c1954a6ef","https","ddb7b594c4fdf","DuplicateApiKey",{"message":"125","status":401},"Duplicate API key found","5db85f8538ca1","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","003a018a69989","NoAPIKey",{"message":"139","status":401},"No API key found",{"type":"140"},{"type":"84"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/fetch-plugin-with-consumer-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a plugin associated with a Consumer in a workspace",["18"],"ba2ddfadc8136","get","/{workspace}/consumers/{consumer_username_or_id}/plugins/{plugin_id}",["19"],{},"fetch-plugin-with-consumer-workspace","Get a plugin associated with a Consumer using ID in a workspace.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46","47"],["48"],{"id":"49","url":"50","name":"51","description":"52","variables":"53"},"c26fb55b0a58f","646cc2ee78f40","200",[],["54"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","8c9cc4b42168e","401",[],["55"],"Unauthorized","8c4cc4b421d0d","404",[],[],"Resource does not exist",{"id":"56","name":"57","style":"58","examples":"59","description":"60","required":true,"schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"58","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"58","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","key":"76","extensions":"77","description":"78","type":"79","name":"80","in":"81"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"82","path":"83","port":"84","protocol":"85"},{"id":"86","mediaType":"87","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"87","examples":"92","encodings":"93","schema":"94"},"8d01d05a79ffa","workspace","simple",[],"Name or ID of workspace",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"20b273332aa10","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"95","examples":"105","$schema":"97","x-stoplight":"106"},["99","100","101","102","103","104"],"2b2769c620edd","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"95","examples":"107","$schema":"97","x-stoplight":"108"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"109","description":"110"},{"default":"111","description":"112"},{"default":"113","description":"114"},{"default":"115","description":"116","enum":"117"},"d3ad32a5d2d5a","application/json",["118"],[],{"type":"119","properties":"120","$schema":"97","x-stoplight":"121"},"df151f3cfa8cf",["122","123","124"],[],{"type":"119","properties":"125","required":"126","title":"127","$schema":"97","x-stoplight":"128"},"string",["129"],"http://json-schema.org/draft-07/schema#",{"id":"130"},"name","in","required","schema","description","title",["131"],{"id":"132"},["133"],{"id":"134"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["115","135"],{"id":"136","key":"137","value":"138"},"object",{"id":"139","name":"140","created_at":"141","route":"142","service":"143","consumer":"144","instance_name":"145","config":"146","protocols":"147","enabled":"148","tags":"149","ordering":"150"},{"id":"151"},{"id":"152","key":"153","value":"154","summary":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"id":"160","key":"161","value":"162","summary":"163"},{"status":"164","message":"165"},["166","167"],"UnauthorizedError",{"id":"168"},"team-a","dd2e78d3f49dd","my-username","193db38eaf92b","response-ratelimiting","d1e6c562e15ff","https","76bd7989fe6ac","Plugin response",{"data":"169","next":"170"},{"type":"95"},{"type":"95","description":"171","examples":"172"},{"type":"173","description":"174"},{"type":"175","description":"176"},{"type":"177","description":"178"},{"type":"179","description":"180"},{"type":"95","description":"181","examples":"182"},{"type":"119","description":"183","properties":"184"},{"type":"185","description":"186","items":"187"},{"type":"188","description":"189","default":true},{"type":"185","description":"190","items":"191"},{"type":"119","description":"192","properties":"193"},"1129d1ef33e52","589f8645b36c0","DuplicateApiKey",{"message":"155","status":401},"Duplicate API key found","d89cbc7457a0c","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","606092f365ba8","NoAPIKey",{"message":"194","status":401},"No API key found",{"type":"173"},{"type":"95"},"status","message","470b68e5f0549",["195","196"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["197"],"integer","Unix epoch when the resource was created.",["95","198"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["95","198"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["95","198"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["199"],"The configuration properties for the plugin",{"hour":"200","minute":"201"},"array","A list of the request protocols that will trigger this plugin.",{"type":"95","enum":"202","default":"115"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"95"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"203"},"No API key found in request",{"id":"204","name":"197","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"205","protocols":"206","enabled":true,"tags":"207","ordering":"208"},{"id":"209","name":"197","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"210","protocols":"211","enabled":true,"tags":"212","ordering":"213"},"rate-limiting","null","rate-limiting-foo",{"type":"173","examples":"214"},{"type":"173","examples":"215"},["115","216","217","218","219"],{"type":"185","items":"220"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["115","135"],["221","222"],{"before":"223"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["219","218"],["224","225","226"],{"after":"227"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"95"},"user-level","low-priority",["228"],"admin","high-priority","critical",["228"],"plugin-name"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-plugin-with-consumer-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a plugin associated with a Consumer in a workspace",["18"],"16262b1f9a444","patch","/{workspace}/consumers/{consumer_username_or_id}/plugins/{plugin_id}",["19"],{},"update-plugin-with-consumer-workspace","Update a plugin associated with a Consumer using ID in a workspace.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"Plugins",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55","56","57"],["58"],{"id":"59","url":"60","name":"61","description":"62","variables":"63"},"c26fb55b0a58f","83ae7746438cf","200",[],["64"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","238e7569736b7","400",[],["65"],"Invalid plugin","237e756973964","401",[],["66"],"Unauthorized","23ce7569731eb","404",[],[],"Resource does not exist","5786d3fcdfb45",["67"],"Plugin request body",{"id":"68","name":"69","style":"70","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","name":"76","style":"70","examples":"77","description":"78","required":true,"schema":"79","explicitProperties":"80"},{"id":"81","name":"82","style":"70","examples":"83","description":"84","required":true,"schema":"85","explicitProperties":"86"},{"id":"87","key":"88","extensions":"89","description":"90","type":"91","name":"92","in":"93"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"94","path":"95","port":"96","protocol":"97"},{"id":"98","mediaType":"99","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"99","examples":"104","encodings":"105","schema":"106"},{"id":"107","mediaType":"99","examples":"108","encodings":"109","schema":"110"},{"id":"111","mediaType":"99","examples":"112","encodings":"113","schema":"114"},"9fd42144b1284","workspace","simple",[],"Name or ID of workspace",{"type":"115","examples":"116","$schema":"117","x-stoplight":"118"},["119","120","121","122","123","124"],"3b1fcf9e98988","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"115","examples":"125","$schema":"117","x-stoplight":"126"},["119","120","121","122","123","124"],"4ebf455eb2538","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"115","examples":"127","$schema":"117","x-stoplight":"128"},["119","120","121","122","123","124"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"129","description":"130"},{"default":"131","description":"132"},{"default":"133","description":"134"},{"default":"135","description":"136","enum":"137"},"7cf533c6dd532","application/json",["138"],[],{"type":"139","properties":"140","$schema":"117","x-stoplight":"141"},"9dd6016386d91",[],[],{"type":"139","$schema":"117","x-stoplight":"142"},"3fbc1b6c171f4",["143","144","145"],[],{"type":"139","properties":"146","required":"147","title":"148","$schema":"117","x-stoplight":"149"},"50e4e23488010",["150"],[],{"type":"139","x-examples":"151","properties":"152","$schema":"117","x-stoplight":"153"},"string",["154"],"http://json-schema.org/draft-07/schema#",{"id":"155"},"name","in","required","schema","description","title",["156"],{"id":"157"},["158"],{"id":"159"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["135","160"],{"id":"161","key":"162","value":"163"},"object",{"id":"164","name":"165","created_at":"166","route":"167","service":"168","consumer":"169","instance_name":"170","config":"171","protocols":"172","enabled":"173","tags":"174","ordering":"175"},{"id":"176"},{"id":"177"},{"id":"178","key":"179","value":"180","summary":"181"},{"id":"182","key":"183","value":"184","summary":"185"},{"id":"186","key":"187","value":"188","summary":"189"},{"status":"190","message":"191"},["192","193"],"UnauthorizedError",{"id":"194"},{"id":"195","key":"196","value":"197"},{"Example 1":"198"},{"name":"199","route":"200","service":"201","consumer":"202","instance_name":"203","config":"204","protocols":"205","enabled":"206","tags":"207","ordering":"208"},{"id":"209"},"team-a","84c7d1dea919f","my-username","557168f1590b5","response-ratelimiting","5c49ac2ad8a6c","https","a012f16186978","Plugin response",{"data":"210","next":"211"},{"type":"115"},{"type":"115","description":"212","examples":"213"},{"type":"214","description":"215"},{"type":"216","description":"217"},{"type":"218","description":"219"},{"type":"220","description":"221"},{"type":"115","description":"222","examples":"223"},{"type":"139","description":"224","properties":"225"},{"type":"226","description":"227","items":"228"},{"type":"229","description":"230","default":true},{"type":"226","description":"231","items":"232"},{"type":"139","description":"233","properties":"234"},"1129d1ef33e52","65a37eee7434d","f6c2e91b1b756","DuplicateApiKey",{"message":"181","status":401},"Duplicate API key found","6c9cbd3fec1a4","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","7077c9703ef48","NoAPIKey",{"message":"235","status":401},"No API key found",{"type":"214"},{"type":"115"},"status","message","470b68e5f0549","0d22dacd1710b","request example",{"name":"236","route":"115","service":"115","consumer":"115","instance_name":"237","config":"238","protocols":"239","enabled":true,"tags":"240","ordering":"241"},{"name":"236","route":null,"service":null,"consumer":null,"instance_name":"237","config":"242","protocols":"243","enabled":true,"tags":"244","ordering":"245"},{"type":"115","description":"246","examples":"247"},{"type":"248","description":"249"},{"type":"250","description":"219"},{"type":"251","description":"221"},{"type":"115","description":"222","examples":"252"},{"type":"139","description":"224","properties":"253"},{"type":"226","description":"227","items":"254"},{"type":"229","description":"230","default":true},{"type":"226","description":"231","items":"255"},{"type":"139","description":"233","properties":"256"},"7a1b17d9c7f1c",["257","258"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["236"],"integer","Unix epoch when the resource was created.",["115","259"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["115","259"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["115","259"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["237"],"The configuration properties for the plugin",{"hour":"260","minute":"261"},"array","A list of the request protocols that will trigger this plugin.",{"type":"115","enum":"262","default":"135"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"115"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"263"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["135"],["115"],{"before":"264"},{"hour":500,"minute":20},["135","160"],["265","266"],{"before":"267"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["236"],["115","259"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["115","259"],["115","259"],["237"],{"hour":"268","minute":"269"},{"type":"115","enum":"270","default":"135"},{"type":"115"},{"before":"271"},{"id":"272","name":"236","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"273","protocols":"274","enabled":true,"tags":"275","ordering":"276"},{"id":"277","name":"236","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"278","protocols":"279","enabled":true,"tags":"280","ordering":"281"},"null",{"type":"214","examples":"282"},{"type":"214","examples":"283"},["135","284","285","286","287"],{"type":"226","items":"288"},["115"],"user-level","low-priority",["289"],{"type":"214","examples":"290"},{"type":"214","examples":"291"},["135","284","285","286","287"],{"type":"226","items":"292"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["135","160"],["265","266"],{"before":"293"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["287","286"],["294","295","296"],{"after":"297"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"115"},"plugin-name",[500],[500],{"type":"115"},["289"],"admin","high-priority","critical",["289"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-plugin-with-consumer-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a plugin associated with a Consumer in a workspace",["18"],"dabcfe53a9fd7","put","/{workspace}/consumers/{consumer_username_or_id}/plugins/{plugin_id}",["19"],{},"upsert-plugin-with-consumer-workspace","Create or Update a plugin associated with a Consumer using ID in a workspace.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Plugins",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50","51"],["52"],{"id":"53","url":"54","name":"55","description":"56","variables":"57"},"c26fb55b0a58f","fc070f0ca1dec","200",[],["58"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","d3e70d46f837d","400",[],["59"],"Invalid plugin","d3d70d46f852e","401",[],["60"],"Unauthorized","b2bec7a53b2aa",["61"],"Plugin request body",{"id":"62","name":"63","style":"64","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"64","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","name":"76","style":"64","examples":"77","description":"78","required":true,"schema":"79","explicitProperties":"80"},{"id":"81","key":"82","extensions":"83","description":"84","type":"85","name":"86","in":"87"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"88","path":"89","port":"90","protocol":"91"},{"id":"92","mediaType":"93","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"93","examples":"98","encodings":"99","schema":"100"},{"id":"101","mediaType":"93","examples":"102","encodings":"103","schema":"104"},{"id":"105","mediaType":"93","examples":"106","encodings":"107","schema":"108"},"406fddbfaa066","workspace","simple",[],"Name or ID of workspace",{"type":"109","examples":"110","$schema":"111","x-stoplight":"112"},["113","114","115","116","117","118"],"0cb049d9cdb4a","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"109","examples":"119","$schema":"111","x-stoplight":"120"},["113","114","115","116","117","118"],"ef5b01d9ab299","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"109","examples":"121","$schema":"111","x-stoplight":"122"},["113","114","115","116","117","118"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"123","description":"124"},{"default":"125","description":"126"},{"default":"127","description":"128"},{"default":"129","description":"130","enum":"131"},"2ea5936ac367c","application/json",["132"],[],{"type":"133","properties":"134","$schema":"111","x-stoplight":"135"},"efca67c83b8e8",[],[],{"type":"133","$schema":"111","x-stoplight":"136"},"2d44de6510c63",["137","138","139"],[],{"type":"133","properties":"140","required":"141","title":"142","$schema":"111","x-stoplight":"143"},"d320f3a450710",["144"],[],{"type":"133","x-examples":"145","properties":"146","$schema":"111","x-stoplight":"147"},"string",["148"],"http://json-schema.org/draft-07/schema#",{"id":"149"},"name","in","required","schema","description","title",["150"],{"id":"151"},["152"],{"id":"153"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["129","154"],{"id":"155","key":"156","value":"157"},"object",{"id":"158","name":"159","created_at":"160","route":"161","service":"162","consumer":"163","instance_name":"164","config":"165","protocols":"166","enabled":"167","tags":"168","ordering":"169"},{"id":"170"},{"id":"171"},{"id":"172","key":"173","value":"174","summary":"175"},{"id":"176","key":"177","value":"178","summary":"179"},{"id":"180","key":"181","value":"182","summary":"183"},{"status":"184","message":"185"},["186","187"],"UnauthorizedError",{"id":"188"},{"id":"189","key":"190","value":"191"},{"Example 1":"192"},{"name":"193","route":"194","service":"195","consumer":"196","instance_name":"197","config":"198","protocols":"199","enabled":"200","tags":"201","ordering":"202"},{"id":"203"},"team-a","9c5e44bb1e75e","my-username","781a387645db5","response-ratelimiting","b3623d46a0cc0","https","5aa81e3f0f270","Plugin response",{"data":"204","next":"205"},{"type":"109"},{"type":"109","description":"206","examples":"207"},{"type":"208","description":"209"},{"type":"210","description":"211"},{"type":"212","description":"213"},{"type":"214","description":"215"},{"type":"109","description":"216","examples":"217"},{"type":"133","description":"218","properties":"219"},{"type":"220","description":"221","items":"222"},{"type":"223","description":"224","default":true},{"type":"220","description":"225","items":"226"},{"type":"133","description":"227","properties":"228"},"1129d1ef33e52","f8117f3b4659c","1c7925f89adc4","DuplicateApiKey",{"message":"175","status":401},"Duplicate API key found","82e84fcc38f0f","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","76166f8ab875c","NoAPIKey",{"message":"229","status":401},"No API key found",{"type":"208"},{"type":"109"},"status","message","470b68e5f0549","ef944b0cdef45","request example",{"name":"230","route":"109","service":"109","consumer":"109","instance_name":"231","config":"232","protocols":"233","enabled":true,"tags":"234","ordering":"235"},{"name":"230","route":null,"service":null,"consumer":null,"instance_name":"231","config":"236","protocols":"237","enabled":true,"tags":"238","ordering":"239"},{"type":"109","description":"240","examples":"241"},{"type":"242","description":"243"},{"type":"244","description":"213"},{"type":"245","description":"215"},{"type":"109","description":"216","examples":"246"},{"type":"133","description":"218","properties":"247"},{"type":"220","description":"221","items":"248"},{"type":"223","description":"224","default":true},{"type":"220","description":"225","items":"249"},{"type":"133","description":"227","properties":"250"},"7a1b17d9c7f1c",["251","252"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["230"],"integer","Unix epoch when the resource was created.",["109","253"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["109","253"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["109","253"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["231"],"The configuration properties for the plugin",{"hour":"254","minute":"255"},"array","A list of the request protocols that will trigger this plugin.",{"type":"109","enum":"256","default":"129"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"109"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"257"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["129"],["109"],{"before":"258"},{"hour":500,"minute":20},["129","154"],["259","260"],{"before":"261"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["230"],["109","253"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["109","253"],["109","253"],["231"],{"hour":"262","minute":"263"},{"type":"109","enum":"264","default":"129"},{"type":"109"},{"before":"265"},{"id":"266","name":"230","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"267","protocols":"268","enabled":true,"tags":"269","ordering":"270"},{"id":"271","name":"230","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"272","protocols":"273","enabled":true,"tags":"274","ordering":"275"},"null",{"type":"208","examples":"276"},{"type":"208","examples":"277"},["129","278","279","280","281"],{"type":"220","items":"282"},["109"],"user-level","low-priority",["283"],{"type":"208","examples":"284"},{"type":"208","examples":"285"},["129","278","279","280","281"],{"type":"220","items":"286"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["129","154"],["259","260"],{"before":"287"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["281","280"],["288","289","290"],{"after":"291"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"109"},"plugin-name",[500],[500],{"type":"109"},["283"],"admin","high-priority","critical",["283"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-plugin-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all plugins in a workspace",["17"],"3412982086dc2","get","/{workspace}/plugins",["18"],{},"list-plugin-in-workspace","inheritedFromService",["19"],{"headers":"20","query":"21","cookie":"22","path":"23"},["24"],["25"],"Plugins",{"id":"26","name":"17"},{"id":"27","code":"28","headers":"29","contents":"30","description":"31"},[],["32","33","34"],[],["35"],["36"],{"id":"37","url":"38","name":"39","description":"40","variables":"41"},"c26fb55b0a58f","007d399fbe416","200",[],["42"],"A successful response listing plugins",{"id":"43","name":"44","style":"45","examples":"46","description":"47","schema":"48","explicitProperties":"49"},{"id":"50","name":"51","style":"45","examples":"52","description":"53","schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"45","examples":"58","description":"59","schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"64","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","key":"70","extensions":"71","description":"72","type":"73","name":"74","in":"75"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"76","path":"77","port":"78","protocol":"79"},{"id":"80","mediaType":"81","examples":"82","encodings":"83","schema":"84"},"f1ba0eb0abf85","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92"],"2f92ad29b701f","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"93","$schema":"86","x-stoplight":"94"},["88","89","90","91","92"],"965abe5946675","tags",["95"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"93","examples":"96","x-stoplight":"97","$schema":"86"},["88","98","89","90","91","92"],"6a038628a62a9","workspace","simple",[],"Name or ID of workspace",{"type":"93","examples":"99","$schema":"86","x-stoplight":"100"},["90","89","101","91","88","92"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109","enum":"110"},"4e2a8533bef2d","application/json",[],[],{"properties":"111","$schema":"86","x-stoplight":"112"},"integer","http://json-schema.org/draft-07/schema#",{"id":"113"},"description","in","name","schema","title","string",{"id":"114"},{"id":"115","value":"116","key":"117"},["116"],{"explicitProperties":"118","id":"119"},"example",["120"],{"id":"121"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["108","122"],{"data":"123","offset":"124"},{"id":"125"},"6cd1ca969063c","5cb3a719127a5","d58062bcb2f17","tag1,tag2","default",["126","127","128"],"9631f57f0622f","team-a","b2b28fced482d","https",{"items":"129","type":"130"},{"description":"131","type":"93","title":"132"},"3a6ed5e106a4e","type","nullable","examples",{"description":"133","properties":"134","type":"135","title":"136","examples":"137"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","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":"138","consumer":"139","consumer_group":"140","created_at":"141","enabled":"142","id":"143","name":"144","ordering":"145","protocols":"146","route":"147","service":"148","tags":"149","updated_at":"150"},"object","Plugin",["151"],{"description":"152","type":"135"},{"additionalProperties":false,"description":"153","properties":"154","type":"135"},{"additionalProperties":false,"description":"155","properties":"156","type":"135"},{"description":"157","type":"85"},{"default":true,"description":"158","type":"159"},{"type":"93"},{"description":"160","type":"93"},{"type":"135"},{"default":"161","description":"162","items":"163","type":"130"},{"additionalProperties":false,"description":"164","properties":"165","type":"135"},{"additionalProperties":false,"description":"166","properties":"167","type":"135"},{"description":"168","items":"169","type":"130"},{"description":"170","type":"85"},{"config":"171","enabled":true,"id":"172","name":"173","protocols":"174"},"The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).","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":"175"},"If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",{"id":"176"},"Unix epoch when the resource was created.","Whether the plugin is applied.","boolean","The name of the plugin that's going to be added. The plugin must be installed in every Kong instance separately.",["177","178","108","122"],"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`.",{"type":"93"},"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":"179"},"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":"180"},"An optional set of strings associated with the plugin for grouping and filtering.",{"type":"93"},"Unix epoch when the resource was last updated.",{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":"181","run_on_preflight":true},"3fd1eea1-885a-4011-b986-289943ff8177","key-auth",["177","178","108","122"],{"type":"93"},{"type":"93"},"grpc","grpcs",{"type":"93"},{"type":"93"},["182"],"apikey"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-plugin-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new plugin in a workspace",["17"],"bd56c509118ca","post","/{workspace}/plugins",["18"],{},"create-plugin-in-workspace","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48"],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"c26fb55b0a58f","135481fd46ccb","200",[],["55"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","3b7483c2efd66","400",[],["56"],"Invalid plugin","3b6483c2efed1","401",[],["57"],"Unauthorized","fd05b3410c75e",["58"],"Plugin request body",{"id":"59","name":"60","style":"61","examples":"62","description":"63","required":true,"schema":"64","explicitProperties":"65"},{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},{"id":"86","mediaType":"78","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"78","examples":"91","encodings":"92","schema":"93"},"ef2cb56f8417c","workspace","simple",[],"Name or ID of workspace",{"type":"94","examples":"95","$schema":"96","x-stoplight":"97"},["98","99","100","101","102","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111","enum":"112"},"e6724cdaabc4f","application/json",["113"],[],{"type":"114","properties":"115","$schema":"96","x-stoplight":"116"},"3646877c53648",[],[],{"type":"114","$schema":"96","x-stoplight":"117"},"0f1d0d684ec48",["118","119","120"],[],{"type":"114","properties":"121","required":"122","title":"123","$schema":"96","x-stoplight":"124"},"a024049db19e9",["125"],[],{"type":"114","x-examples":"126","properties":"127","$schema":"96","x-stoplight":"128"},"string",["129"],"http://json-schema.org/draft-07/schema#",{"id":"130"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["110","131"],{"id":"132","key":"133","value":"134"},"object",{"id":"135","name":"136","created_at":"137","route":"138","service":"139","consumer":"140","instance_name":"141","config":"142","protocols":"143","enabled":"144","tags":"145","ordering":"146"},{"id":"147"},{"id":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},{"id":"157","key":"158","value":"159","summary":"160"},{"status":"161","message":"162"},["163","164"],"UnauthorizedError",{"id":"165"},{"id":"166","key":"167","value":"168"},{"Example 1":"169"},{"name":"170","route":"171","service":"172","consumer":"173","instance_name":"174","config":"175","protocols":"176","enabled":"177","tags":"178","ordering":"179"},{"id":"180"},"team-a","8521f5df4944a","https","7646577d88d3e","Plugin response",{"data":"181","next":"182"},{"type":"94"},{"type":"94","description":"183","examples":"184"},{"type":"185","description":"186"},{"type":"187","description":"188"},{"type":"189","description":"190"},{"type":"191","description":"192"},{"type":"94","description":"193","examples":"194"},{"type":"114","description":"195","properties":"196"},{"type":"197","description":"198","items":"199"},{"type":"200","description":"201","default":true},{"type":"197","description":"202","items":"203"},{"type":"114","description":"204","properties":"205"},"1129d1ef33e52","779085daea61d","65285c513f23b","DuplicateApiKey",{"message":"152","status":401},"Duplicate API key found","bcdea2cb196fd","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","a2f6c3de0eb45","NoAPIKey",{"message":"206","status":401},"No API key found",{"type":"185"},{"type":"94"},"status","message","470b68e5f0549","253f28c548d46","request example",{"name":"207","route":"94","service":"94","consumer":"94","instance_name":"208","config":"209","protocols":"210","enabled":true,"tags":"211","ordering":"212"},{"name":"207","route":null,"service":null,"consumer":null,"instance_name":"208","config":"213","protocols":"214","enabled":true,"tags":"215","ordering":"216"},{"type":"94","description":"217","examples":"218"},{"type":"219","description":"220"},{"type":"221","description":"190"},{"type":"222","description":"192"},{"type":"94","description":"193","examples":"223"},{"type":"114","description":"195","properties":"224"},{"type":"197","description":"198","items":"225"},{"type":"200","description":"201","default":true},{"type":"197","description":"202","items":"226"},{"type":"114","description":"204","properties":"227"},"7a1b17d9c7f1c",["228","229"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["207"],"integer","Unix epoch when the resource was created.",["94","230"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["94","230"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["94","230"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["208"],"The configuration properties for the plugin",{"hour":"231","minute":"232"},"array","A list of the request protocols that will trigger this plugin.",{"type":"94","enum":"233","default":"110"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"94"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"234"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["110"],["94"],{"before":"235"},{"hour":500,"minute":20},["110","131"],["236","237"],{"before":"238"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["207"],["94","230"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["94","230"],["94","230"],["208"],{"hour":"239","minute":"240"},{"type":"94","enum":"241","default":"110"},{"type":"94"},{"before":"242"},{"id":"243","name":"207","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"244","protocols":"245","enabled":true,"tags":"246","ordering":"247"},{"id":"248","name":"207","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"249","protocols":"250","enabled":true,"tags":"251","ordering":"252"},"null",{"type":"185","examples":"253"},{"type":"185","examples":"254"},["110","255","256","257","258"],{"type":"197","items":"259"},["94"],"user-level","low-priority",["260"],{"type":"185","examples":"261"},{"type":"185","examples":"262"},["110","255","256","257","258"],{"type":"197","items":"263"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["110","131"],["236","237"],{"before":"264"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["258","257"],["265","266","267"],{"after":"268"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"94"},"plugin-name",[500],[500],{"type":"94"},["260"],"admin","high-priority","critical",["260"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-plugin-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a plugin in a workspace",["17"],"6c133cb1d7789","delete","/{workspace}/plugins/{plugin_id}",["18"],{},"delete-plugin-in-workspace","inheritedFromService",["19"],{"headers":"20","query":"21","cookie":"22","path":"23"},["24"],["25"],"Plugins",{"id":"26","name":"17"},{"id":"27","code":"28","headers":"29","contents":"30","description":"31"},[],[],[],["32","33"],["34"],{"id":"35","url":"36","name":"37","description":"38","variables":"39"},"c26fb55b0a58f","c5230fafa0c00","204",[],[],"Successfully deleted plugin or the resource didn't exist",{"id":"40","name":"41","style":"42","examples":"43","description":"44","required":true,"schema":"45","explicitProperties":"46"},{"id":"47","name":"48","style":"42","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},"7d0ebc0cc3cce","workspace","simple",[],"Name or ID of workspace",{"type":"64","examples":"65","$schema":"66","x-stoplight":"67"},["68","69","70","71","72","73"],"bcbee70187ba0","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"64","examples":"74","$schema":"66","x-stoplight":"75"},["68","69","70","71","72","73"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"76","description":"77"},{"default":"78","description":"79"},{"default":"80","description":"81"},{"default":"82","description":"83","enum":"84"},"string",["85"],"http://json-schema.org/draft-07/schema#",{"id":"86"},"name","in","required","schema","description","title",["87"],{"id":"88"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["82","89"],"team-a","58b2d0b1767e2","response-ratelimiting","289a0f35e2c33","https"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-plugin-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a plugin in a workspace",["18"],"1b1043196dddb","get","/{workspace}/plugins/{plugin_id}",["19"],{},"get-plugin-in-workspace","Get a plugin using ID in a workspace.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46"],["47"],{"id":"48","url":"49","name":"50","description":"51","variables":"52"},"c26fb55b0a58f","ddb9bf64285a6","200",[],["53"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","3de9c140f8318","401",[],["54"],"Unauthorized","3d99c140f889b","404",[],[],"Resource does not exist",{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"57","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"697b216e3113d","workspace","simple",[],"Name or ID of workspace",{"type":"88","examples":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96","97"],"28e4643fea0de","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"88","examples":"98","$schema":"90","x-stoplight":"99"},["92","93","94","95","96","97"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107","enum":"108"},"66af4a20ef26f","application/json",["109"],[],{"type":"110","properties":"111","$schema":"90","x-stoplight":"112"},"cbfc043878aad",["113","114","115"],[],{"type":"110","properties":"116","required":"117","title":"118","$schema":"90","x-stoplight":"119"},"string",["120"],"http://json-schema.org/draft-07/schema#",{"id":"121"},"name","in","required","schema","description","title",["122"],{"id":"123"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["106","124"],{"id":"125","key":"126","value":"127"},"object",{"id":"128","name":"129","created_at":"130","route":"131","service":"132","consumer":"133","instance_name":"134","config":"135","protocols":"136","enabled":"137","tags":"138","ordering":"139"},{"id":"140"},{"id":"141","key":"142","value":"143","summary":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"status":"153","message":"154"},["155","156"],"UnauthorizedError",{"id":"157"},"team-a","64cdd84188537","response-ratelimiting","3d1504f463ab5","https","972ebb031b155","Plugin response",{"data":"158","next":"159"},{"type":"88"},{"type":"88","description":"160","examples":"161"},{"type":"162","description":"163"},{"type":"164","description":"165"},{"type":"166","description":"167"},{"type":"168","description":"169"},{"type":"88","description":"170","examples":"171"},{"type":"110","description":"172","properties":"173"},{"type":"174","description":"175","items":"176"},{"type":"177","description":"178","default":true},{"type":"174","description":"179","items":"180"},{"type":"110","description":"181","properties":"182"},"1129d1ef33e52","2a022fbf6b5d8","DuplicateApiKey",{"message":"144","status":401},"Duplicate API key found","6c05f0cf0b572","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","72bd44cd6cbe4","NoAPIKey",{"message":"183","status":401},"No API key found",{"type":"162"},{"type":"88"},"status","message","470b68e5f0549",["184","185"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["186"],"integer","Unix epoch when the resource was created.",["88","187"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["88","187"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["88","187"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["188"],"The configuration properties for the plugin",{"hour":"189","minute":"190"},"array","A list of the request protocols that will trigger this plugin.",{"type":"88","enum":"191","default":"106"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"88"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"192"},"No API key found in request",{"id":"193","name":"186","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"194","protocols":"195","enabled":true,"tags":"196","ordering":"197"},{"id":"198","name":"186","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"199","protocols":"200","enabled":true,"tags":"201","ordering":"202"},"rate-limiting","null","rate-limiting-foo",{"type":"162","examples":"203"},{"type":"162","examples":"204"},["106","205","206","207","208"],{"type":"174","items":"209"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["106","124"],["210","211"],{"before":"212"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["208","207"],["213","214","215"],{"after":"216"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"88"},"user-level","low-priority",["217"],"admin","high-priority","critical",["217"],"plugin-name"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-plugin-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update a plugin in a workspace",["17"],"3c6db83f92901","patch","/{workspace}/plugins/{plugin_id}",["18"],{},"update-plugin-in-workspace","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Plugins",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54","55"],["56"],{"id":"57","url":"58","name":"59","description":"60","variables":"61"},"c26fb55b0a58f","2e948119bad90","200",[],["62"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","6934807131b85","400",[],["63"],"Invalid plugin","692480713194a","401",[],["64"],"Unauthorized","69748071322c9","404",[],[],"Resource does not exist","7316f0a7b39b6",["65"],"Plugin request body",{"id":"66","name":"67","style":"68","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","name":"74","style":"68","examples":"75","description":"76","required":true,"schema":"77","explicitProperties":"78"},{"id":"79","key":"80","extensions":"81","description":"82","type":"83","name":"84","in":"85"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"86","path":"87","port":"88","protocol":"89"},{"id":"90","mediaType":"91","examples":"92","encodings":"93","schema":"94"},{"id":"95","mediaType":"91","examples":"96","encodings":"97","schema":"98"},{"id":"99","mediaType":"91","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"91","examples":"104","encodings":"105","schema":"106"},"145627ce42b33","workspace","simple",[],"Name or ID of workspace",{"type":"107","examples":"108","$schema":"109","x-stoplight":"110"},["111","112","113","114","115","116"],"06ef8e1ffd891","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"107","examples":"117","$schema":"109","x-stoplight":"118"},["111","112","113","114","115","116"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"119","description":"120"},{"default":"121","description":"122"},{"default":"123","description":"124"},{"default":"125","description":"126","enum":"127"},"6e16f250b8abf","application/json",["128"],[],{"type":"129","properties":"130","$schema":"109","x-stoplight":"131"},"9811972ed1939",[],[],{"type":"129","$schema":"109","x-stoplight":"132"},"5faa9bbe75f9a",["133","134","135"],[],{"type":"129","properties":"136","required":"137","title":"138","$schema":"109","x-stoplight":"139"},"6a68fb7d7a3eb",["140"],[],{"type":"129","x-examples":"141","properties":"142","$schema":"109","x-stoplight":"143"},"string",["144"],"http://json-schema.org/draft-07/schema#",{"id":"145"},"name","in","required","schema","description","title",["146"],{"id":"147"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["125","148"],{"id":"149","key":"150","value":"151"},"object",{"id":"152","name":"153","created_at":"154","route":"155","service":"156","consumer":"157","instance_name":"158","config":"159","protocols":"160","enabled":"161","tags":"162","ordering":"163"},{"id":"164"},{"id":"165"},{"id":"166","key":"167","value":"168","summary":"169"},{"id":"170","key":"171","value":"172","summary":"173"},{"id":"174","key":"175","value":"176","summary":"177"},{"status":"178","message":"179"},["180","181"],"UnauthorizedError",{"id":"182"},{"id":"183","key":"184","value":"185"},{"Example 1":"186"},{"name":"187","route":"188","service":"189","consumer":"190","instance_name":"191","config":"192","protocols":"193","enabled":"194","tags":"195","ordering":"196"},{"id":"197"},"team-a","39907931eddd9","response-ratelimiting","812b1c15e0163","https","5ae095bf4efff","Plugin response",{"data":"198","next":"199"},{"type":"107"},{"type":"107","description":"200","examples":"201"},{"type":"202","description":"203"},{"type":"204","description":"205"},{"type":"206","description":"207"},{"type":"208","description":"209"},{"type":"107","description":"210","examples":"211"},{"type":"129","description":"212","properties":"213"},{"type":"214","description":"215","items":"216"},{"type":"217","description":"218","default":true},{"type":"214","description":"219","items":"220"},{"type":"129","description":"221","properties":"222"},"1129d1ef33e52","ab48c013b4d25","c26863f4917ad","DuplicateApiKey",{"message":"169","status":401},"Duplicate API key found","a42ed0142cbb0","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","f14840eb8962a","NoAPIKey",{"message":"223","status":401},"No API key found",{"type":"202"},{"type":"107"},"status","message","470b68e5f0549","55dad9e81cb74","request example",{"name":"224","route":"107","service":"107","consumer":"107","instance_name":"225","config":"226","protocols":"227","enabled":true,"tags":"228","ordering":"229"},{"name":"224","route":null,"service":null,"consumer":null,"instance_name":"225","config":"230","protocols":"231","enabled":true,"tags":"232","ordering":"233"},{"type":"107","description":"234","examples":"235"},{"type":"236","description":"237"},{"type":"238","description":"207"},{"type":"239","description":"209"},{"type":"107","description":"210","examples":"240"},{"type":"129","description":"212","properties":"241"},{"type":"214","description":"215","items":"242"},{"type":"217","description":"218","default":true},{"type":"214","description":"219","items":"243"},{"type":"129","description":"221","properties":"244"},"7a1b17d9c7f1c",["245","246"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["224"],"integer","Unix epoch when the resource was created.",["107","247"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["107","247"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["107","247"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["225"],"The configuration properties for the plugin",{"hour":"248","minute":"249"},"array","A list of the request protocols that will trigger this plugin.",{"type":"107","enum":"250","default":"125"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"107"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"251"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["125"],["107"],{"before":"252"},{"hour":500,"minute":20},["125","148"],["253","254"],{"before":"255"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["224"],["107","247"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["107","247"],["107","247"],["225"],{"hour":"256","minute":"257"},{"type":"107","enum":"258","default":"125"},{"type":"107"},{"before":"259"},{"id":"260","name":"224","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"261","protocols":"262","enabled":true,"tags":"263","ordering":"264"},{"id":"265","name":"224","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"266","protocols":"267","enabled":true,"tags":"268","ordering":"269"},"null",{"type":"202","examples":"270"},{"type":"202","examples":"271"},["125","272","273","274","275"],{"type":"214","items":"276"},["107"],"user-level","low-priority",["277"],{"type":"202","examples":"278"},{"type":"202","examples":"279"},["125","272","273","274","275"],{"type":"214","items":"280"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["125","148"],["253","254"],{"before":"281"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["275","274"],["282","283","284"],{"after":"285"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"107"},"plugin-name",[500],[500],{"type":"107"},["277"],"admin","high-priority","critical",["277"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-plugin-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a plugin in a workspace",["18"],"061cd7dae0922","put","/{workspace}/plugins/{plugin_id}",["19"],{},"upsert-plugin-in-workspace","Create or Update plugin using ID in a workspace.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Plugins",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"c26fb55b0a58f","98fbebc9bfe8f","200",[],["57"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","039beb384fef0","400",[],["58"],"Invalid plugin","038beb384ff3f","401",[],["59"],"Unauthorized","150e7914b59da",["60"],"Plugin request body",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"101"},"31ed21caf8924","workspace","simple",[],"Name or ID of workspace",{"type":"102","examples":"103","$schema":"104","x-stoplight":"105"},["106","107","108","109","110","111"],"8ff7132a312a8","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"102","examples":"112","$schema":"104","x-stoplight":"113"},["106","107","108","109","110","111"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121","enum":"122"},"0699e04323be6","application/json",["123"],[],{"type":"124","properties":"125","$schema":"104","x-stoplight":"126"},"0b3ff1722d5aa",[],[],{"type":"124","$schema":"104","x-stoplight":"127"},"ec707eb4f003a",["128","129","130"],[],{"type":"124","properties":"131","required":"132","title":"133","$schema":"104","x-stoplight":"134"},"85d5a88f5e6c8",["135"],[],{"type":"124","x-examples":"136","properties":"137","$schema":"104","x-stoplight":"138"},"string",["139"],"http://json-schema.org/draft-07/schema#",{"id":"140"},"name","in","required","schema","description","title",["141"],{"id":"142"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["120","143"],{"id":"144","key":"145","value":"146"},"object",{"id":"147","name":"148","created_at":"149","route":"150","service":"151","consumer":"152","instance_name":"153","config":"154","protocols":"155","enabled":"156","tags":"157","ordering":"158"},{"id":"159"},{"id":"160"},{"id":"161","key":"162","value":"163","summary":"164"},{"id":"165","key":"166","value":"167","summary":"168"},{"id":"169","key":"170","value":"171","summary":"172"},{"status":"173","message":"174"},["175","176"],"UnauthorizedError",{"id":"177"},{"id":"178","key":"179","value":"180"},{"Example 1":"181"},{"name":"182","route":"183","service":"184","consumer":"185","instance_name":"186","config":"187","protocols":"188","enabled":"189","tags":"190","ordering":"191"},{"id":"192"},"team-a","35038de573c77","response-ratelimiting","8e863a9ea1eed","https","82c43ed0ee944","Plugin response",{"data":"193","next":"194"},{"type":"102"},{"type":"102","description":"195","examples":"196"},{"type":"197","description":"198"},{"type":"199","description":"200"},{"type":"201","description":"202"},{"type":"203","description":"204"},{"type":"102","description":"205","examples":"206"},{"type":"124","description":"207","properties":"208"},{"type":"209","description":"210","items":"211"},{"type":"212","description":"213","default":true},{"type":"209","description":"214","items":"215"},{"type":"124","description":"216","properties":"217"},"1129d1ef33e52","fe6fcfd12387c","0588778a8d239","DuplicateApiKey",{"message":"164","status":401},"Duplicate API key found","ba32821b53fb3","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","21a5c17bbaad0","NoAPIKey",{"message":"218","status":401},"No API key found",{"type":"197"},{"type":"102"},"status","message","470b68e5f0549","0a7dee4449114","request example",{"name":"219","route":"102","service":"102","consumer":"102","instance_name":"220","config":"221","protocols":"222","enabled":true,"tags":"223","ordering":"224"},{"name":"219","route":null,"service":null,"consumer":null,"instance_name":"220","config":"225","protocols":"226","enabled":true,"tags":"227","ordering":"228"},{"type":"102","description":"229","examples":"230"},{"type":"231","description":"232"},{"type":"233","description":"202"},{"type":"234","description":"204"},{"type":"102","description":"205","examples":"235"},{"type":"124","description":"207","properties":"236"},{"type":"209","description":"210","items":"237"},{"type":"212","description":"213","default":true},{"type":"209","description":"214","items":"238"},{"type":"124","description":"216","properties":"239"},"7a1b17d9c7f1c",["240","241"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["219"],"integer","Unix epoch when the resource was created.",["102","242"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["102","242"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["102","242"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["220"],"The configuration properties for the plugin",{"hour":"243","minute":"244"},"array","A list of the request protocols that will trigger this plugin.",{"type":"102","enum":"245","default":"120"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"102"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"246"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["120"],["102"],{"before":"247"},{"hour":500,"minute":20},["120","143"],["248","249"],{"before":"250"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["219"],["102","242"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["102","242"],["102","242"],["220"],{"hour":"251","minute":"252"},{"type":"102","enum":"253","default":"120"},{"type":"102"},{"before":"254"},{"id":"255","name":"219","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"256","protocols":"257","enabled":true,"tags":"258","ordering":"259"},{"id":"260","name":"219","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"261","protocols":"262","enabled":true,"tags":"263","ordering":"264"},"null",{"type":"197","examples":"265"},{"type":"197","examples":"266"},["120","267","268","269","270"],{"type":"209","items":"271"},["102"],"user-level","low-priority",["272"],{"type":"197","examples":"273"},{"type":"197","examples":"274"},["120","267","268","269","270"],{"type":"209","items":"275"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["120","143"],["248","249"],{"before":"276"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["270","269"],["277","278","279"],{"after":"280"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"102"},"plugin-name",[500],[500],{"type":"102"},["272"],"admin","high-priority","critical",["272"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-plugins-with-route-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all plugins associated with a route in a workspace",["17"],"33dbc77bd1cda","get","/{workspace}/routes/{route_id_or_name}/plugins",["18"],{},"list-plugins-with-route-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Plugins",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],["41","42"],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"c26fb55b0a58f","e0dfdc49630f7","200",[],["49"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","88afda6ca0abc","401",[],["50"],"Unauthorized",{"id":"51","name":"52","style":"53","examples":"54","description":"55","schema":"56","explicitProperties":"57"},{"id":"58","name":"59","style":"53","examples":"60","description":"61","schema":"62","explicitProperties":"63"},{"id":"64","name":"65","style":"53","examples":"66","description":"67","schema":"68","explicitProperties":"69"},{"id":"70","name":"71","style":"72","examples":"73","description":"74","required":true,"schema":"75","explicitProperties":"76"},{"id":"77","name":"78","style":"72","examples":"79","description":"80","required":true,"schema":"81","explicitProperties":"82"},{"id":"83","key":"84","extensions":"85","description":"86","type":"87","name":"88","in":"89"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"90","path":"91","port":"92","protocol":"93"},{"id":"94","mediaType":"95","examples":"96","encodings":"97","schema":"98"},{"id":"99","mediaType":"95","examples":"100","encodings":"101","schema":"102"},"a282c0ab530d2","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"103","$schema":"104","x-stoplight":"105"},["106","107","108","109","110"],"c139f823efb19","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"111","$schema":"104","x-stoplight":"112"},["106","107","108","109","110"],"419f0a5d6d260","tags",["113"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"111","examples":"114","x-stoplight":"115","$schema":"104"},["106","116","107","108","109","110"],"187b4770d4ba3","workspace","simple",[],"Name or ID of workspace",{"type":"111","examples":"117","$schema":"104","x-stoplight":"118"},["108","107","119","109","106","110"],"3d54876e268b5","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"111","examples":"120","$schema":"104","x-stoplight":"121"},["108","107","119","109","106","110"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"122","description":"123"},{"default":"124","description":"125"},{"default":"126","description":"127"},{"default":"128","description":"129","enum":"130"},"441a261bb50a8","application/json",["131"],[],{"type":"132","properties":"133","$schema":"104","x-stoplight":"134"},"40f2e22b173dd",["135","136","137"],[],{"type":"132","properties":"138","required":"139","title":"140","$schema":"104","x-stoplight":"141"},"integer","http://json-schema.org/draft-07/schema#",{"id":"142"},"description","in","name","schema","title","string",{"id":"143"},{"id":"144","value":"145","key":"146"},["145"],{"explicitProperties":"147","id":"148"},"example",["149"],{"id":"150"},"required",["151"],{"id":"152"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["128","153"],{"id":"154","key":"155","value":"156"},"object",{"id":"157","name":"158","created_at":"159","route":"160","service":"161","consumer":"162","instance_name":"163","config":"164","protocols":"165","enabled":"166","tags":"167","ordering":"168"},{"id":"169"},{"id":"170","key":"171","value":"172","summary":"173"},{"id":"174","key":"175","value":"176","summary":"177"},{"id":"178","key":"179","value":"180","summary":"181"},{"status":"182","message":"183"},["184","185"],"UnauthorizedError",{"id":"186"},"6986f3ebe1558","488cd1a7868bb","511c19bf81c3e","tag1,tag2","default",["187","188","189"],"7487c145d1334","team-a","f2c9fb2e3e8fd","my-route","1a6f8e92f30c0","https","f63fe42eed53d","Plugin response",{"data":"190","next":"191"},{"type":"111"},{"type":"111","description":"192","examples":"193"},{"type":"103","description":"194"},{"type":"195","description":"196"},{"type":"197","description":"198"},{"type":"199","description":"200"},{"type":"111","description":"201","examples":"202"},{"type":"132","description":"203","properties":"204"},{"type":"205","description":"206","items":"207"},{"type":"208","description":"209","default":true},{"type":"205","description":"210","items":"211"},{"type":"132","description":"212","properties":"213"},"1129d1ef33e52","c7fd27bb0761f","DuplicateApiKey",{"message":"173","status":401},"Duplicate API key found","ae9882f7a192b","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","1fbc4939027fd","NoAPIKey",{"message":"214","status":401},"No API key found",{"type":"103"},{"type":"111"},"status","message","470b68e5f0549","type","nullable","examples",["215","216"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["217"],"Unix epoch when the resource was created.",["111","218"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["111","218"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["111","218"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["219"],"The configuration properties for the plugin",{"hour":"220","minute":"221"},"array","A list of the request protocols that will trigger this plugin.",{"type":"111","enum":"222","default":"128"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"111"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"223"},"No API key found in request",{"id":"224","name":"217","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"225","protocols":"226","enabled":true,"tags":"227","ordering":"228"},{"id":"229","name":"217","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"230","protocols":"231","enabled":true,"tags":"232","ordering":"233"},"rate-limiting","null","rate-limiting-foo",{"type":"103","examples":"234"},{"type":"103","examples":"235"},["128","236","237","238","239"],{"type":"205","items":"240"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["128","153"],["241","242"],{"before":"243"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["239","238"],["244","245","246"],{"after":"247"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"111"},"user-level","low-priority",["248"],"admin","high-priority","critical",["248"],"plugin-name"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-plugin-with-route-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new plugin associated with a route in a workspace",["17"],"7a9fa46dcb1c8","post","/{workspace}/routes/{route_id_or_name}/plugins",["18"],{},"create-plugin-with-route-workspace","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48","49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"c26fb55b0a58f","acadb8e2f9852","200",[],["56"],"Successfully created plugin","04cdbabfbbc4b","400",[],["57"],"Invalid plugin","04ddbabfbc29c","401",[],["58"],"Unauthorized","aa80938419f6a",["59"],"Plugin request body",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","name":"68","style":"62","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","key":"74","extensions":"75","description":"76","type":"77","name":"78","in":"79"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"80","path":"81","port":"82","protocol":"83"},{"id":"84","mediaType":"85","examples":"86","encodings":"87","schema":"88"},{"id":"89","mediaType":"85","examples":"90","encodings":"91","schema":"92"},{"id":"93","mediaType":"85","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"85","examples":"98","encodings":"99","schema":"100"},"36076a1c41cc9","workspace","simple",[],"Name or ID of workspace",{"type":"101","examples":"102","$schema":"103","x-stoplight":"104"},["105","106","107","108","109","110"],"280be906222a1","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"101","examples":"111","$schema":"103","x-stoplight":"112"},["105","106","107","108","109","110"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"2c61ffb2f2fd1","application/json",["122"],[],{"description":"123","properties":"124","type":"125","title":"126","examples":"127"},"a76fdb331dd92",[],[],{"type":"125","$schema":"103","x-stoplight":"128"},"a75b8e0fd9d65",["129","130","131"],[],{"type":"125","properties":"132","required":"133","title":"134","$schema":"103","x-stoplight":"135"},"e67338e3711a1",["136"],[],{"type":"125","x-examples":"137","properties":"138","$schema":"103","x-stoplight":"139"},"string",["140"],"http://json-schema.org/draft-07/schema#",{"id":"141"},"name","in","required","schema","description","title",["142"],{"id":"143"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","144"],{"id":"145","value":"146","key":"147"},"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":"148","consumer":"149","consumer_group":"150","created_at":"151","enabled":"152","id":"153","name":"154","ordering":"155","protocols":"156","route":"157","service":"158","tags":"159","updated_at":"160"},"object","Plugin",["146"],{"id":"161"},{"id":"162","key":"163","value":"164","summary":"165"},{"id":"166","key":"167","value":"168","summary":"169"},{"id":"170","key":"171","value":"172","summary":"173"},{"status":"174","message":"175"},["176","177"],"UnauthorizedError",{"id":"178"},{"id":"179","key":"180","value":"181"},{"Example 1":"182"},{"name":"183","route":"184","service":"185","consumer":"186","instance_name":"187","config":"188","protocols":"189","enabled":"190","tags":"191","ordering":"192"},{"id":"193"},"team-a","9efefb1615350","my-route","03943aad83d52","https","8e845d79c54e2",{"config":"194","enabled":true,"id":"195","name":"196","protocols":"197"},"default",{"description":"198","type":"125"},{"additionalProperties":false,"description":"199","properties":"200","type":"125"},{"additionalProperties":false,"description":"201","properties":"202","type":"125"},{"description":"203","type":"204"},{"default":true,"description":"205","type":"206"},{"type":"101"},{"description":"207","type":"101"},{"type":"125"},{"default":"208","description":"209","items":"210","type":"211"},{"additionalProperties":false,"description":"212","properties":"213","type":"125"},{"additionalProperties":false,"description":"214","properties":"215","type":"125"},{"description":"216","items":"217","type":"211"},{"description":"218","type":"204"},"dc8ffcb63588b","5d9baab434073","DuplicateApiKey",{"message":"165","status":401},"Duplicate API key found","3d639b07bb481","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","442500160b4d1","NoAPIKey",{"message":"219","status":401},"No API key found",{"type":"204"},{"type":"101"},"status","message","470b68e5f0549","98d3276d37dc6","request example",{"name":"220","route":"101","service":"101","consumer":"101","instance_name":"221","config":"222","protocols":"223","enabled":true,"tags":"224","ordering":"225"},{"name":"220","route":null,"service":null,"consumer":null,"instance_name":"221","config":"226","protocols":"227","enabled":true,"tags":"228","ordering":"229"},{"type":"101","description":"230","examples":"231"},{"type":"232","description":"233"},{"type":"234","description":"235"},{"type":"236","description":"237"},{"type":"101","description":"238","examples":"239"},{"type":"125","description":"240","properties":"241"},{"type":"211","description":"242","items":"243"},{"type":"206","description":"244","default":true},{"type":"211","description":"245","items":"246"},{"type":"125","description":"247","properties":"248"},"7a1b17d9c7f1c",{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":"249","run_on_preflight":true},"3fd1eea1-885a-4011-b986-289943ff8177","key-auth",["250","251","119","144"],"The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).","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":"252"},"If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",{"id":"253"},"Unix epoch when the resource was created.","integer","Whether the plugin is applied.","boolean","The name of the plugin that's going to be added. The plugin must be installed in every Kong instance separately.",["250","251","119","144"],"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`.",{"type":"101"},"array","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":"254"},"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":"255"},"An optional set of strings associated with the plugin for grouping and filtering.",{"type":"101"},"Unix epoch when the resource was last updated.","No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["119"],["101"],{"before":"256"},{"hour":500,"minute":20},["119","144"],["257","258"],{"before":"259"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["220"],["101","260"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["101","260"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["101","260"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["221"],"The configuration properties for the plugin",{"hour":"261","minute":"262"},"A list of the request protocols that will trigger this plugin.",{"type":"101","enum":"263","default":"119"},"Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"101"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"264"},["265"],"grpc","grpcs",{"type":"101"},{"type":"101"},{"type":"101"},{"type":"101"},["101"],"user-level","low-priority",["266"],"null",{"type":"204","examples":"267"},{"type":"204","examples":"268"},["119","250","251","269","270"],{"type":"211","items":"271"},"apikey","plugin-name",[500],[500],"tls","tcp",{"type":"101"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-plugin-with-route-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a plugin associated with a route in a workspace",["18"],"7be8605573953","delete","/{workspace}/routes/{route_id_or_name}/plugins/{plugin_id}",["19"],{},"delete-plugin-with-route-workspace","Delete a plugin associated with a route using ID in a workspace.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Plugins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40","41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"c26fb55b0a58f","80d0c88f38a9c","204",[],[],"Successfully deleted plugin or the resource didn't exist","4e00c91ae8b50","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","required":true,"schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"51","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},"862d72e7c134a","workspace","simple",[],"Name or ID of workspace",{"type":"84","examples":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92","93"],"ac438160a606f","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"84","examples":"94","$schema":"86","x-stoplight":"95"},["88","89","90","91","92","93"],"5722815e67e07","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"84","examples":"96","$schema":"86","x-stoplight":"97"},["88","89","90","91","92","93"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"98","description":"99"},{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105","enum":"106"},"a27e183feafbc","application/json",["107","108","109"],[],{"type":"110","properties":"111","required":"112","title":"113","$schema":"86","x-stoplight":"114"},"string",["115"],"http://json-schema.org/draft-07/schema#",{"id":"116"},"name","in","required","schema","description","title",["117"],{"id":"118"},["119"],{"id":"120"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["104","121"],{"id":"122","key":"123","value":"124","summary":"125"},{"id":"126","key":"127","value":"128","summary":"129"},{"id":"130","key":"131","value":"132","summary":"133"},"object",{"status":"134","message":"135"},["136","137"],"UnauthorizedError",{"id":"138"},"team-a","2e32e1996e534","my-route","17c34c58b5221","response-ratelimiting","660dd37076e2f","https","63271e3dd8e0e","DuplicateApiKey",{"message":"125","status":401},"Duplicate API key found","9cf6c48de2da2","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","71c76075af8ae","NoAPIKey",{"message":"139","status":401},"No API key found",{"type":"140"},{"type":"84"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/fetch-plugin-with-route-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a plugin associated with a route in a workspace",["18"],"5db900ab2828c","get","/{workspace}/routes/{route_id_or_name}/plugins/{plugin_id}",["19"],{},"fetch-plugin-with-route-workspace","Get a plugin associated with a route using ID in a workspace.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46","47"],["48"],{"id":"49","url":"50","name":"51","description":"52","variables":"53"},"c26fb55b0a58f","6e78fd8b80de9","200",[],["54"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","c688ff6842932","401",[],["55"],"Unauthorized","c658ff6842e29","404",[],[],"Resource does not exist",{"id":"56","name":"57","style":"58","examples":"59","description":"60","required":true,"schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"58","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"58","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","key":"76","extensions":"77","description":"78","type":"79","name":"80","in":"81"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"82","path":"83","port":"84","protocol":"85"},{"id":"86","mediaType":"87","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"87","examples":"92","encodings":"93","schema":"94"},"ce7c6aacef16e","workspace","simple",[],"Name or ID of workspace",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"6272df4befff1","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"95","examples":"105","$schema":"97","x-stoplight":"106"},["99","100","101","102","103","104"],"634e1180366a7","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"95","examples":"107","$schema":"97","x-stoplight":"108"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"109","description":"110"},{"default":"111","description":"112"},{"default":"113","description":"114"},{"default":"115","description":"116","enum":"117"},"1514d98105587","application/json",["118"],[],{"type":"119","properties":"120","$schema":"97","x-stoplight":"121"},"f2dcecd544cbd",["122","123","124"],[],{"type":"119","properties":"125","required":"126","title":"127","$schema":"97","x-stoplight":"128"},"string",["129"],"http://json-schema.org/draft-07/schema#",{"id":"130"},"name","in","required","schema","description","title",["131"],{"id":"132"},["133"],{"id":"134"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["115","135"],{"id":"136","key":"137","value":"138"},"object",{"id":"139","name":"140","created_at":"141","route":"142","service":"143","consumer":"144","instance_name":"145","config":"146","protocols":"147","enabled":"148","tags":"149","ordering":"150"},{"id":"151"},{"id":"152","key":"153","value":"154","summary":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"id":"160","key":"161","value":"162","summary":"163"},{"status":"164","message":"165"},["166","167"],"UnauthorizedError",{"id":"168"},"team-a","6356d7df16f15","my-route","62eb276078baf","response-ratelimiting","f65c33671c32b","https","3dde3b0f26d7c","Plugin response",{"data":"169","next":"170"},{"type":"95"},{"type":"95","description":"171","examples":"172"},{"type":"173","description":"174"},{"type":"175","description":"176"},{"type":"177","description":"178"},{"type":"179","description":"180"},{"type":"95","description":"181","examples":"182"},{"type":"119","description":"183","properties":"184"},{"type":"185","description":"186","items":"187"},{"type":"188","description":"189","default":true},{"type":"185","description":"190","items":"191"},{"type":"119","description":"192","properties":"193"},"1129d1ef33e52","92febfa2e8b91","DuplicateApiKey",{"message":"155","status":401},"Duplicate API key found","b2033598c5cf0","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","6fde9705d9903","NoAPIKey",{"message":"194","status":401},"No API key found",{"type":"173"},{"type":"95"},"status","message","470b68e5f0549",["195","196"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["197"],"integer","Unix epoch when the resource was created.",["95","198"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["95","198"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["95","198"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["199"],"The configuration properties for the plugin",{"hour":"200","minute":"201"},"array","A list of the request protocols that will trigger this plugin.",{"type":"95","enum":"202","default":"115"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"95"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"203"},"No API key found in request",{"id":"204","name":"197","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"205","protocols":"206","enabled":true,"tags":"207","ordering":"208"},{"id":"209","name":"197","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"210","protocols":"211","enabled":true,"tags":"212","ordering":"213"},"rate-limiting","null","rate-limiting-foo",{"type":"173","examples":"214"},{"type":"173","examples":"215"},["115","216","217","218","219"],{"type":"185","items":"220"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["115","135"],["221","222"],{"before":"223"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["219","218"],["224","225","226"],{"after":"227"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"95"},"user-level","low-priority",["228"],"admin","high-priority","critical",["228"],"plugin-name"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-plugin-with-route-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a plugin associated with a route in a workspace",["18"],"287777cd600e5","patch","/{workspace}/routes/{route_id_or_name}/plugins/{plugin_id}",["19"],{},"update-plugin-with-route-workspace","Update a plugin associated with a route using ID in a workspace.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"Plugins",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55","56","57"],["58"],{"id":"59","url":"60","name":"61","description":"62","variables":"63"},"c26fb55b0a58f","2f6f718c6f151","200",[],["64"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","878f736932255","400",[],["65"],"Invalid plugin","879f736932402","401",[],["66"],"Unauthorized","874f736931c81","404",[],[],"Resource does not exist","9e761d27e3230",["67"],"Plugin request body",{"id":"68","name":"69","style":"70","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","name":"76","style":"70","examples":"77","description":"78","required":true,"schema":"79","explicitProperties":"80"},{"id":"81","name":"82","style":"70","examples":"83","description":"84","required":true,"schema":"85","explicitProperties":"86"},{"id":"87","key":"88","extensions":"89","description":"90","type":"91","name":"92","in":"93"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"94","path":"95","port":"96","protocol":"97"},{"id":"98","mediaType":"99","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"99","examples":"104","encodings":"105","schema":"106"},{"id":"107","mediaType":"99","examples":"108","encodings":"109","schema":"110"},{"id":"111","mediaType":"99","examples":"112","encodings":"113","schema":"114"},"c6f6820b938b2","workspace","simple",[],"Name or ID of workspace",{"type":"115","examples":"116","$schema":"117","x-stoplight":"118"},["119","120","121","122","123","124"],"9215ecb11b260","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"115","examples":"125","$schema":"117","x-stoplight":"126"},["119","120","121","122","123","124"],"5c7f9e9b7bde9","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"115","examples":"127","$schema":"117","x-stoplight":"128"},["119","120","121","122","123","124"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"129","description":"130"},{"default":"131","description":"132"},{"default":"133","description":"134"},{"default":"135","description":"136","enum":"137"},"1ddf925da13db","application/json",["138"],[],{"type":"139","properties":"140","$schema":"117","x-stoplight":"141"},"5dcdbfac05ec7",[],[],{"type":"139","$schema":"117","x-stoplight":"142"},"5d2b0baa39b93",["143","144","145"],[],{"type":"139","properties":"146","required":"147","title":"148","$schema":"117","x-stoplight":"149"},"512d131241935",["150"],[],{"type":"139","x-examples":"151","properties":"152","$schema":"117","x-stoplight":"153"},"string",["154"],"http://json-schema.org/draft-07/schema#",{"id":"155"},"name","in","required","schema","description","title",["156"],{"id":"157"},["158"],{"id":"159"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["135","160"],{"id":"161","key":"162","value":"163"},"object",{"id":"164","name":"165","created_at":"166","route":"167","service":"168","consumer":"169","instance_name":"170","config":"171","protocols":"172","enabled":"173","tags":"174","ordering":"175"},{"id":"176"},{"id":"177"},{"id":"178","key":"179","value":"180","summary":"181"},{"id":"182","key":"183","value":"184","summary":"185"},{"id":"186","key":"187","value":"188","summary":"189"},{"status":"190","message":"191"},["192","193"],"UnauthorizedError",{"id":"194"},{"id":"195","key":"196","value":"197"},{"Example 1":"198"},{"name":"199","route":"200","service":"201","consumer":"202","instance_name":"203","config":"204","protocols":"205","enabled":"206","tags":"207","ordering":"208"},{"id":"209"},"team-a","b8e398f0bc191","my-route","74b501c542311","response-ratelimiting","29a38655f3c8a","https","1145a5aacd36b","Plugin response",{"data":"210","next":"211"},{"type":"115"},{"type":"115","description":"212","examples":"213"},{"type":"214","description":"215"},{"type":"216","description":"217"},{"type":"218","description":"219"},{"type":"220","description":"221"},{"type":"115","description":"222","examples":"223"},{"type":"139","description":"224","properties":"225"},{"type":"226","description":"227","items":"228"},{"type":"229","description":"230","default":true},{"type":"226","description":"231","items":"232"},{"type":"139","description":"233","properties":"234"},"1129d1ef33e52","5df98c4af6bf7","1f24b06fd9eab","DuplicateApiKey",{"message":"181","status":401},"Duplicate API key found","8593da4377ab0","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","fb3156c73b8b5","NoAPIKey",{"message":"235","status":401},"No API key found",{"type":"214"},{"type":"115"},"status","message","470b68e5f0549","14bdbeca2fff0","request example",{"name":"236","route":"115","service":"115","consumer":"115","instance_name":"237","config":"238","protocols":"239","enabled":true,"tags":"240","ordering":"241"},{"name":"236","route":null,"service":null,"consumer":null,"instance_name":"237","config":"242","protocols":"243","enabled":true,"tags":"244","ordering":"245"},{"type":"115","description":"246","examples":"247"},{"type":"248","description":"249"},{"type":"250","description":"219"},{"type":"251","description":"221"},{"type":"115","description":"222","examples":"252"},{"type":"139","description":"224","properties":"253"},{"type":"226","description":"227","items":"254"},{"type":"229","description":"230","default":true},{"type":"226","description":"231","items":"255"},{"type":"139","description":"233","properties":"256"},"7a1b17d9c7f1c",["257","258"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["236"],"integer","Unix epoch when the resource was created.",["115","259"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["115","259"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["115","259"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["237"],"The configuration properties for the plugin",{"hour":"260","minute":"261"},"array","A list of the request protocols that will trigger this plugin.",{"type":"115","enum":"262","default":"135"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"115"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"263"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["135"],["115"],{"before":"264"},{"hour":500,"minute":20},["135","160"],["265","266"],{"before":"267"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["236"],["115","259"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["115","259"],["115","259"],["237"],{"hour":"268","minute":"269"},{"type":"115","enum":"270","default":"135"},{"type":"115"},{"before":"271"},{"id":"272","name":"236","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"273","protocols":"274","enabled":true,"tags":"275","ordering":"276"},{"id":"277","name":"236","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"278","protocols":"279","enabled":true,"tags":"280","ordering":"281"},"null",{"type":"214","examples":"282"},{"type":"214","examples":"283"},["135","284","285","286","287"],{"type":"226","items":"288"},["115"],"user-level","low-priority",["289"],{"type":"214","examples":"290"},{"type":"214","examples":"291"},["135","284","285","286","287"],{"type":"226","items":"292"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["135","160"],["265","266"],{"before":"293"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["287","286"],["294","295","296"],{"after":"297"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"115"},"plugin-name",[500],[500],{"type":"115"},["289"],"admin","high-priority","critical",["289"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-plugin-with-route-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a plugin associated with a route in a workspace",["18"],"fb87f8f944624","put","/{workspace}/routes/{route_id_or_name}/plugins/{plugin_id}",["19"],{},"upsert-plugin-with-route-workspace","Create or Update a plugin associated with a route using ID in a workspace.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Plugins",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50","51"],["52"],{"id":"53","url":"54","name":"55","description":"56","variables":"57"},"c26fb55b0a58f","4200e3aa1fc19","200",[],["58"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","d760e43b8f068","400",[],["59"],"Invalid plugin","d750e43b8f61b","401",[],["60"],"Unauthorized","fe7b2e82be8d2",["61"],"Plugin request body",{"id":"62","name":"63","style":"64","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"64","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","name":"76","style":"64","examples":"77","description":"78","required":true,"schema":"79","explicitProperties":"80"},{"id":"81","key":"82","extensions":"83","description":"84","type":"85","name":"86","in":"87"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"88","path":"89","port":"90","protocol":"91"},{"id":"92","mediaType":"93","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"93","examples":"98","encodings":"99","schema":"100"},{"id":"101","mediaType":"93","examples":"102","encodings":"103","schema":"104"},{"id":"105","mediaType":"93","examples":"106","encodings":"107","schema":"108"},"8977cc31eaf0b","workspace","simple",[],"Name or ID of workspace",{"type":"109","examples":"110","$schema":"111","x-stoplight":"112"},["113","114","115","116","117","118"],"c649cfbdc4455","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"109","examples":"119","$schema":"111","x-stoplight":"120"},["113","114","115","116","117","118"],"81bb2e69bb1c4","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"109","examples":"121","$schema":"111","x-stoplight":"122"},["113","114","115","116","117","118"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"123","description":"124"},{"default":"125","description":"126"},{"default":"127","description":"128"},{"default":"129","description":"130","enum":"131"},"42b08123e3e2e","application/json",["132"],[],{"type":"133","properties":"134","$schema":"111","x-stoplight":"135"},"986750b20d47a",[],[],{"type":"133","$schema":"111","x-stoplight":"136"},"471ebcfcb460d",["137","138","139"],[],{"type":"133","properties":"140","required":"141","title":"142","$schema":"111","x-stoplight":"143"},"0a483f809d592",["144"],[],{"type":"133","x-examples":"145","properties":"146","$schema":"111","x-stoplight":"147"},"string",["148"],"http://json-schema.org/draft-07/schema#",{"id":"149"},"name","in","required","schema","description","title",["150"],{"id":"151"},["152"],{"id":"153"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["129","154"],{"id":"155","key":"156","value":"157"},"object",{"id":"158","name":"159","created_at":"160","route":"161","service":"162","consumer":"163","instance_name":"164","config":"165","protocols":"166","enabled":"167","tags":"168","ordering":"169"},{"id":"170"},{"id":"171"},{"id":"172","key":"173","value":"174","summary":"175"},{"id":"176","key":"177","value":"178","summary":"179"},{"id":"180","key":"181","value":"182","summary":"183"},{"status":"184","message":"185"},["186","187"],"UnauthorizedError",{"id":"188"},{"id":"189","key":"190","value":"191"},{"Example 1":"192"},{"name":"193","route":"194","service":"195","consumer":"196","instance_name":"197","config":"198","protocols":"199","enabled":"200","tags":"201","ordering":"202"},{"id":"203"},"team-a","ee71f5f6d0270","my-route","c43b6ca9224ee","response-ratelimiting","b597937c2233b","https","c283fe51deb20","Plugin response",{"data":"204","next":"205"},{"type":"109"},{"type":"109","description":"206","examples":"207"},{"type":"208","description":"209"},{"type":"210","description":"211"},{"type":"212","description":"213"},{"type":"214","description":"215"},{"type":"109","description":"216","examples":"217"},{"type":"133","description":"218","properties":"219"},{"type":"220","description":"221","items":"222"},{"type":"223","description":"224","default":true},{"type":"220","description":"225","items":"226"},{"type":"133","description":"227","properties":"228"},"1129d1ef33e52","6201f65c9054c","abd485e10312c","DuplicateApiKey",{"message":"175","status":401},"Duplicate API key found","8ef29b950e570","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","0ab845057ba77","NoAPIKey",{"message":"229","status":401},"No API key found",{"type":"208"},{"type":"109"},"status","message","470b68e5f0549","b2a7a355bc22c","request example",{"name":"230","route":"109","service":"109","consumer":"109","instance_name":"231","config":"232","protocols":"233","enabled":true,"tags":"234","ordering":"235"},{"name":"230","route":null,"service":null,"consumer":null,"instance_name":"231","config":"236","protocols":"237","enabled":true,"tags":"238","ordering":"239"},{"type":"109","description":"240","examples":"241"},{"type":"242","description":"243"},{"type":"244","description":"213"},{"type":"245","description":"215"},{"type":"109","description":"216","examples":"246"},{"type":"133","description":"218","properties":"247"},{"type":"220","description":"221","items":"248"},{"type":"223","description":"224","default":true},{"type":"220","description":"225","items":"249"},{"type":"133","description":"227","properties":"250"},"7a1b17d9c7f1c",["251","252"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["230"],"integer","Unix epoch when the resource was created.",["109","253"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["109","253"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["109","253"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["231"],"The configuration properties for the plugin",{"hour":"254","minute":"255"},"array","A list of the request protocols that will trigger this plugin.",{"type":"109","enum":"256","default":"129"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"109"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"257"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["129"],["109"],{"before":"258"},{"hour":500,"minute":20},["129","154"],["259","260"],{"before":"261"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["230"],["109","253"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["109","253"],["109","253"],["231"],{"hour":"262","minute":"263"},{"type":"109","enum":"264","default":"129"},{"type":"109"},{"before":"265"},{"id":"266","name":"230","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"267","protocols":"268","enabled":true,"tags":"269","ordering":"270"},{"id":"271","name":"230","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"272","protocols":"273","enabled":true,"tags":"274","ordering":"275"},"null",{"type":"208","examples":"276"},{"type":"208","examples":"277"},["129","278","279","280","281"],{"type":"220","items":"282"},["109"],"user-level","low-priority",["283"],{"type":"208","examples":"284"},{"type":"208","examples":"285"},["129","278","279","280","281"],{"type":"220","items":"286"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["129","154"],["259","260"],{"before":"287"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["281","280"],["288","289","290"],{"after":"291"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"109"},"plugin-name",[500],[500],{"type":"109"},["283"],"admin","high-priority","critical",["283"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-plugins-with-service-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all plugins associated with a Service in a workspace",["17"],"822e690aceb80","get","/{workspace}/services/{service_id_or_name}/plugins",["18"],{},"list-plugins-with-service-workspace","inheritedFromService",["19"],{"headers":"20","query":"21","cookie":"22","path":"23"},["24"],["25"],"Plugins",{"id":"26","name":"17"},{"id":"27","code":"28","headers":"29","contents":"30","description":"31"},[],["32","33","34"],[],["35","36"],["37"],{"id":"38","url":"39","name":"40","description":"41","variables":"42"},"c26fb55b0a58f","25e45a1d878a3","200",[],["43"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.",{"id":"44","name":"45","style":"46","examples":"47","description":"48","schema":"49","explicitProperties":"50"},{"id":"51","name":"52","style":"46","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"46","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"65","examples":"66","description":"67","required":true,"schema":"68","explicitProperties":"69"},{"id":"70","name":"71","style":"65","examples":"72","description":"73","required":true,"schema":"74","explicitProperties":"75"},{"id":"76","key":"77","extensions":"78","description":"79","type":"80","name":"81","in":"82"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"83","path":"84","port":"85","protocol":"86"},{"id":"87","mediaType":"88","examples":"89","encodings":"90","schema":"91"},"9d1c9fdd97d32","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"92","$schema":"93","x-stoplight":"94"},["95","96","97","98","99"],"724ddb88c005d","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"100","$schema":"93","x-stoplight":"101"},["95","96","97","98","99"],"107a06d275f21","tags",["102"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"100","examples":"103","x-stoplight":"104","$schema":"93"},["95","105","96","97","98","99"],"b9ad29a0b05a1","workspace","simple",[],"Name or ID of workspace",{"type":"100","examples":"106","$schema":"93","x-stoplight":"107"},["97","96","108","98","95","99"],"695575e9337db","service_id_or_name",["109"],"ID **or** name of the service to lookup",{"type":"100","examples":"110","$schema":"93","x-stoplight":"111"},["97","95","105","96","108","98","99"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"112","description":"113"},{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119","enum":"120"},"619f8ad9d2ff1","application/json",["121"],[],{"type":"122","properties":"123","$schema":"93","x-stoplight":"124"},"integer","http://json-schema.org/draft-07/schema#",{"id":"125"},"description","in","name","schema","title","string",{"id":"126"},{"id":"127","value":"128","key":"129"},["128"],{"explicitProperties":"130","id":"131"},"example",["132"],{"id":"133"},"required",{"id":"134","value":"135","key":"129"},["135"],{"id":"136"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["118","137"],{"id":"138","key":"139","value":"140"},"object",{"id":"141","name":"142","created_at":"143","route":"144","service":"145","consumer":"146","instance_name":"147","config":"148","protocols":"149","enabled":"150","tags":"151","ordering":"152"},{"id":"153"},"2f3b39f862687","f752f5dda8d32","b03326dc914d3","tag1,tag2","default",["154","155","156"],"5f19ae0aff4bc","team-a","4d1672ce1e280","bcc895890bb82","test-service","8fbabad8061af","https","64647eac5283c","Plugin response",{"data":"157","next":"158"},{"type":"100"},{"type":"100","description":"159","examples":"160"},{"type":"92","description":"161"},{"type":"162","description":"163"},{"type":"164","description":"165"},{"type":"166","description":"167"},{"type":"100","description":"168","examples":"169"},{"type":"122","description":"170","properties":"171"},{"type":"172","description":"173","items":"174"},{"type":"175","description":"176","default":true},{"type":"172","description":"177","items":"178"},{"type":"122","description":"179","properties":"180"},"1129d1ef33e52","type","nullable","examples",["181","182"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["183"],"Unix epoch when the resource was created.",["100","184"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["100","184"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["100","184"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["185"],"The configuration properties for the plugin",{"hour":"186","minute":"187"},"array","A list of the request protocols that will trigger this plugin.",{"type":"100","enum":"188","default":"118"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"100"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"189"},{"id":"190","name":"183","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"191","protocols":"192","enabled":true,"tags":"193","ordering":"194"},{"id":"195","name":"183","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"196","protocols":"197","enabled":true,"tags":"198","ordering":"199"},"rate-limiting","null","rate-limiting-foo",{"type":"92","examples":"200"},{"type":"92","examples":"201"},["118","202","203","204","205"],{"type":"172","items":"206"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["118","137"],["207","208"],{"before":"209"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["205","204"],["210","211","212"],{"after":"213"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"100"},"user-level","low-priority",["214"],"admin","high-priority","critical",["214"],"plugin-name"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-plugin-with-service-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new plugin associated with a Service in a workspace",["17"],"51761f1e93a14","post","/{workspace}/services/{service_id_or_name}/plugins",["18"],{},"create-plugin-with-service-workspace","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48","49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"c26fb55b0a58f","0a6ea40bd1ef3","200",[],["56"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","628ea5e8936f3","400",[],["57"],"Invalid plugin","627ea5e893824","401",[],["58"],"Unauthorized","7d816de382762",["59"],"Plugin request body",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","name":"68","style":"62","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","key":"74","extensions":"75","description":"76","type":"77","name":"78","in":"79"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"80","path":"81","port":"82","protocol":"83"},{"id":"84","mediaType":"85","examples":"86","encodings":"87","schema":"88"},{"id":"89","mediaType":"85","examples":"90","encodings":"91","schema":"92"},{"id":"93","mediaType":"85","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"85","examples":"98","encodings":"99","schema":"100"},"bbba2a51accbb","workspace","simple",[],"Name or ID of workspace",{"type":"101","examples":"102","$schema":"103","x-stoplight":"104"},["105","106","107","108","109","110"],"de1af8fb5d0af","service_id_or_name",["111"],"ID **or** name of the service to lookup",{"type":"101","examples":"112","$schema":"103","x-stoplight":"113"},["105","109","114","106","107","108","110"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120"},{"default":"121","description":"122","enum":"123"},"74086c57fadc5","application/json",["124"],[],{"type":"125","properties":"126","$schema":"103","x-stoplight":"127"},"a2edc0a89bca5",[],[],{"type":"125","$schema":"103","x-stoplight":"128"},"6dbfa2714aa24",["129","130","131"],[],{"type":"125","properties":"132","required":"133","title":"134","$schema":"103","x-stoplight":"135"},"b9ec2ccd6ca90",["136"],[],{"type":"125","x-examples":"137","properties":"138","$schema":"103","x-stoplight":"139"},"string",["140"],"http://json-schema.org/draft-07/schema#",{"id":"141"},"name","in","required","schema","description","title",{"id":"142","value":"143","key":"144"},["143"],{"id":"145"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["121","146"],{"id":"147","key":"148","value":"149"},"object",{"id":"150","name":"151","created_at":"152","route":"153","service":"154","consumer":"155","instance_name":"156","config":"157","protocols":"158","enabled":"159","tags":"160","ordering":"161"},{"id":"162"},{"id":"163"},{"id":"164","key":"165","value":"166","summary":"167"},{"id":"168","key":"169","value":"170","summary":"171"},{"id":"172","key":"173","value":"174","summary":"175"},{"status":"176","message":"177"},["178","179"],"UnauthorizedError",{"id":"180"},{"id":"181","key":"182","value":"183"},{"Example 1":"184"},{"name":"185","route":"186","service":"187","consumer":"188","instance_name":"189","config":"190","protocols":"191","enabled":"192","tags":"193","ordering":"194"},{"id":"195"},"team-a","778ff3bcaefa8","542f396f5081e","test-service","default","716bdf41d16dd","https","365e20e3038cf","Plugin response",{"data":"196","next":"197"},{"type":"101"},{"type":"101","description":"198","examples":"199"},{"type":"200","description":"201"},{"type":"202","description":"203"},{"type":"204","description":"205"},{"type":"206","description":"207"},{"type":"101","description":"208","examples":"209"},{"type":"125","description":"210","properties":"211"},{"type":"212","description":"213","items":"214"},{"type":"215","description":"216","default":true},{"type":"212","description":"217","items":"218"},{"type":"125","description":"219","properties":"220"},"1129d1ef33e52","4d3a2134f4fc9","d4c2af66a20f7","DuplicateApiKey",{"message":"167","status":401},"Duplicate API key found","83e815d94ae90","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","f5ccd8e5150f5","NoAPIKey",{"message":"221","status":401},"No API key found",{"type":"200"},{"type":"101"},"status","message","470b68e5f0549","05c1a8998e4d7","request example",{"name":"222","route":"101","service":"101","consumer":"101","instance_name":"223","config":"224","protocols":"225","enabled":true,"tags":"226","ordering":"227"},{"name":"222","route":null,"service":null,"consumer":null,"instance_name":"223","config":"228","protocols":"229","enabled":true,"tags":"230","ordering":"231"},{"type":"101","description":"232","examples":"233"},{"type":"234","description":"235"},{"type":"236","description":"205"},{"type":"237","description":"207"},{"type":"101","description":"208","examples":"238"},{"type":"125","description":"210","properties":"239"},{"type":"212","description":"213","items":"240"},{"type":"215","description":"216","default":true},{"type":"212","description":"217","items":"241"},{"type":"125","description":"219","properties":"242"},"7a1b17d9c7f1c",["243","244"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["222"],"integer","Unix epoch when the resource was created.",["101","245"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["101","245"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["101","245"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["223"],"The configuration properties for the plugin",{"hour":"246","minute":"247"},"array","A list of the request protocols that will trigger this plugin.",{"type":"101","enum":"248","default":"121"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"101"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"249"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["121"],["101"],{"before":"250"},{"hour":500,"minute":20},["121","146"],["251","252"],{"before":"253"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["222"],["101","245"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["101","245"],["101","245"],["223"],{"hour":"254","minute":"255"},{"type":"101","enum":"256","default":"121"},{"type":"101"},{"before":"257"},{"id":"258","name":"222","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"259","protocols":"260","enabled":true,"tags":"261","ordering":"262"},{"id":"263","name":"222","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"264","protocols":"265","enabled":true,"tags":"266","ordering":"267"},"null",{"type":"200","examples":"268"},{"type":"200","examples":"269"},["121","270","271","272","273"],{"type":"212","items":"274"},["101"],"user-level","low-priority",["275"],{"type":"200","examples":"276"},{"type":"200","examples":"277"},["121","270","271","272","273"],{"type":"212","items":"278"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["121","146"],["251","252"],{"before":"279"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["273","272"],["280","281","282"],{"after":"283"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"101"},"plugin-name",[500],[500],{"type":"101"},["275"],"admin","high-priority","critical",["275"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-plugin-with-service-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a plugin associated with a Service in a workspace",["18"],"1be3687665956","delete","/{workspace}/services/{service_id_or_name}/plugins/{plugin_id}",["19"],{},"delete-plugin-with-service-workspace","Delete a plugin associated with a Service using ID in a workspace.","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Plugins",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33","34","35"],["36"],{"id":"37","url":"38","name":"39","description":"40","variables":"41"},"c26fb55b0a58f","9c1824191671f","204",[],[],"Successfully deleted plugin or the resource didn't exist",{"id":"42","name":"43","style":"44","examples":"45","description":"46","required":true,"schema":"47","explicitProperties":"48"},{"id":"49","name":"50","style":"44","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"44","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},"d6d0b1cd5dad9","workspace","simple",[],"Name or ID of workspace",{"type":"72","examples":"73","$schema":"74","x-stoplight":"75"},["76","77","78","79","80","81"],"45d8ad7708f82","service_id_or_name",["82"],"ID **or** name of the service to lookup",{"type":"72","examples":"83","$schema":"74","x-stoplight":"84"},["76","80","85","77","78","79","81"],"6bf409e300c00","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"72","examples":"86","$schema":"74","x-stoplight":"87"},["76","77","78","79","80","81"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95","enum":"96"},"string",["97"],"http://json-schema.org/draft-07/schema#",{"id":"98"},"name","in","required","schema","description","title",{"id":"99","value":"100","key":"101"},["100"],{"id":"102"},"example",["103"],{"id":"104"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["94","105"],"team-a","f3c9bfe0a651a","529a915157eab","test-service","default","4c429cd572dee","response-ratelimiting","3939e5b68ccc7","https"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/fetch-plugin-with-service-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a plugin associated with a Service in a workspace",["18"],"c3d456a8803da","get","/{workspace}/services/{service_id_or_name}/plugins/{plugin_id}",["19"],{},"fetch-plugin-with-service-workspace","Get a plugin associated with a Service using ID in a workspace.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46","47"],["48"],{"id":"49","url":"50","name":"51","description":"52","variables":"53"},"c26fb55b0a58f","185e07ce5f9ac","200",[],["54"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","f02e0608b682d","401",[],["55"],"Unauthorized","f07e0608b70a2","404",[],[],"Resource does not exist",{"id":"56","name":"57","style":"58","examples":"59","description":"60","required":true,"schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"58","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"58","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","key":"76","extensions":"77","description":"78","type":"79","name":"80","in":"81"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"82","path":"83","port":"84","protocol":"85"},{"id":"86","mediaType":"87","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"87","examples":"92","encodings":"93","schema":"94"},"f12a81e9f23a1","workspace","simple",[],"Name or ID of workspace",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"3e5aa0e642c82","service_id_or_name",["105"],"ID **or** name of the service to lookup",{"type":"95","examples":"106","$schema":"97","x-stoplight":"107"},["99","103","108","100","101","102","104"],"454fe4c13de4c","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"95","examples":"109","$schema":"97","x-stoplight":"110"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"111","description":"112"},{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118","enum":"119"},"4a22e45e7ee29","application/json",["120"],[],{"type":"121","properties":"122","$schema":"97","x-stoplight":"123"},"6ee22f477ce90",["124","125","126"],[],{"type":"121","properties":"127","required":"128","title":"129","$schema":"97","x-stoplight":"130"},"string",["131"],"http://json-schema.org/draft-07/schema#",{"id":"132"},"name","in","required","schema","description","title",{"id":"133","value":"134","key":"135"},["134"],{"id":"136"},"example",["137"],{"id":"138"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["117","139"],{"id":"140","key":"141","value":"142"},"object",{"id":"143","name":"144","created_at":"145","route":"146","service":"147","consumer":"148","instance_name":"149","config":"150","protocols":"151","enabled":"152","tags":"153","ordering":"154"},{"id":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"id":"160","key":"161","value":"162","summary":"163"},{"id":"164","key":"165","value":"166","summary":"167"},{"status":"168","message":"169"},["170","171"],"UnauthorizedError",{"id":"172"},"team-a","5151b977f9e49","82396f29d804f","test-service","default","2aa7952f4718c","response-ratelimiting","31d3d6aa0a239","https","ebe885ba40b53","Plugin response",{"data":"173","next":"174"},{"type":"95"},{"type":"95","description":"175","examples":"176"},{"type":"177","description":"178"},{"type":"179","description":"180"},{"type":"181","description":"182"},{"type":"183","description":"184"},{"type":"95","description":"185","examples":"186"},{"type":"121","description":"187","properties":"188"},{"type":"189","description":"190","items":"191"},{"type":"192","description":"193","default":true},{"type":"189","description":"194","items":"195"},{"type":"121","description":"196","properties":"197"},"1129d1ef33e52","034ca12e67474","DuplicateApiKey",{"message":"159","status":401},"Duplicate API key found","33e56f9624bc0","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","bbd19c43d0799","NoAPIKey",{"message":"198","status":401},"No API key found",{"type":"177"},{"type":"95"},"status","message","470b68e5f0549",["199","200"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["201"],"integer","Unix epoch when the resource was created.",["95","202"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["95","202"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["95","202"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["203"],"The configuration properties for the plugin",{"hour":"204","minute":"205"},"array","A list of the request protocols that will trigger this plugin.",{"type":"95","enum":"206","default":"117"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"95"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"207"},"No API key found in request",{"id":"208","name":"201","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"209","protocols":"210","enabled":true,"tags":"211","ordering":"212"},{"id":"213","name":"201","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"214","protocols":"215","enabled":true,"tags":"216","ordering":"217"},"rate-limiting","null","rate-limiting-foo",{"type":"177","examples":"218"},{"type":"177","examples":"219"},["117","220","221","222","223"],{"type":"189","items":"224"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["117","139"],["225","226"],{"before":"227"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["223","222"],["228","229","230"],{"after":"231"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"95"},"user-level","low-priority",["232"],"admin","high-priority","critical",["232"],"plugin-name"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-plugin-with-service-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a plugin associated with a Service in a workspace",["18"],"dbbbd1782fd4d","patch","/{workspace}/services/{service_id_or_name}/plugins/{plugin_id}",["19"],{},"update-plugin-with-service-workspace","Update a plugin associated with a Service using ID in a workspace.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"Plugins",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55","56","57"],["58"],{"id":"59","url":"60","name":"61","description":"62","variables":"63"},"c26fb55b0a58f","5e1b9c54ece84","200",[],["64"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","2b7b9cfd8203f","400",[],["65"],"Invalid plugin","2b6b9cfd826ec","401",[],["66"],"Unauthorized","2b3b9cfd82bc3","404",[],[],"Resource does not exist","76e446ea025b3",["67"],"Plugin request body",{"id":"68","name":"69","style":"70","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","name":"76","style":"70","examples":"77","description":"78","required":true,"schema":"79","explicitProperties":"80"},{"id":"81","name":"82","style":"70","examples":"83","description":"84","required":true,"schema":"85","explicitProperties":"86"},{"id":"87","key":"88","extensions":"89","description":"90","type":"91","name":"92","in":"93"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"94","path":"95","port":"96","protocol":"97"},{"id":"98","mediaType":"99","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"99","examples":"104","encodings":"105","schema":"106"},{"id":"107","mediaType":"99","examples":"108","encodings":"109","schema":"110"},{"id":"111","mediaType":"99","examples":"112","encodings":"113","schema":"114"},"cd774b352007b","workspace","simple",[],"Name or ID of workspace",{"type":"115","examples":"116","$schema":"117","x-stoplight":"118"},["119","120","121","122","123","124"],"69492d78e99d5","service_id_or_name",["125"],"ID **or** name of the service to lookup",{"type":"115","examples":"126","$schema":"117","x-stoplight":"127"},["119","123","128","120","121","122","124"],"0d9abfe8baa5b","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"115","examples":"129","$schema":"117","x-stoplight":"130"},["119","120","121","122","123","124"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"131","description":"132"},{"default":"133","description":"134"},{"default":"135","description":"136"},{"default":"137","description":"138","enum":"139"},"628c605fd480f","application/json",["140"],[],{"type":"141","properties":"142","$schema":"117","x-stoplight":"143"},"048e088cf8317",[],[],{"type":"141","$schema":"117","x-stoplight":"144"},"cf1ead3f8cc1e",["145","146","147"],[],{"type":"141","properties":"148","required":"149","title":"150","$schema":"117","x-stoplight":"151"},"32b281581efe6",["152"],[],{"type":"141","x-examples":"153","properties":"154","$schema":"117","x-stoplight":"155"},"string",["156"],"http://json-schema.org/draft-07/schema#",{"id":"157"},"name","in","required","schema","description","title",{"id":"158","value":"159","key":"160"},["159"],{"id":"161"},"example",["162"],{"id":"163"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["137","164"],{"id":"165","key":"166","value":"167"},"object",{"id":"168","name":"169","created_at":"170","route":"171","service":"172","consumer":"173","instance_name":"174","config":"175","protocols":"176","enabled":"177","tags":"178","ordering":"179"},{"id":"180"},{"id":"181"},{"id":"182","key":"183","value":"184","summary":"185"},{"id":"186","key":"187","value":"188","summary":"189"},{"id":"190","key":"191","value":"192","summary":"193"},{"status":"194","message":"195"},["196","197"],"UnauthorizedError",{"id":"198"},{"id":"199","key":"200","value":"201"},{"Example 1":"202"},{"name":"203","route":"204","service":"205","consumer":"206","instance_name":"207","config":"208","protocols":"209","enabled":"210","tags":"211","ordering":"212"},{"id":"213"},"team-a","8252c455dfea2","3a4694fc76c7e","test-service","default","968d992738d16","response-ratelimiting","365f3b70e054f","https","247b0bd2e4bf5","Plugin response",{"data":"214","next":"215"},{"type":"115"},{"type":"115","description":"216","examples":"217"},{"type":"218","description":"219"},{"type":"220","description":"221"},{"type":"222","description":"223"},{"type":"224","description":"225"},{"type":"115","description":"226","examples":"227"},{"type":"141","description":"228","properties":"229"},{"type":"230","description":"231","items":"232"},{"type":"233","description":"234","default":true},{"type":"230","description":"235","items":"236"},{"type":"141","description":"237","properties":"238"},"1129d1ef33e52","dad4e2ed41530","4789928ea83f1","DuplicateApiKey",{"message":"185","status":401},"Duplicate API key found","34b1a454c95dc","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","1a84aeb1a49a4","NoAPIKey",{"message":"239","status":401},"No API key found",{"type":"218"},{"type":"115"},"status","message","470b68e5f0549","ae39108292988","request example",{"name":"240","route":"115","service":"115","consumer":"115","instance_name":"241","config":"242","protocols":"243","enabled":true,"tags":"244","ordering":"245"},{"name":"240","route":null,"service":null,"consumer":null,"instance_name":"241","config":"246","protocols":"247","enabled":true,"tags":"248","ordering":"249"},{"type":"115","description":"250","examples":"251"},{"type":"252","description":"253"},{"type":"254","description":"223"},{"type":"255","description":"225"},{"type":"115","description":"226","examples":"256"},{"type":"141","description":"228","properties":"257"},{"type":"230","description":"231","items":"258"},{"type":"233","description":"234","default":true},{"type":"230","description":"235","items":"259"},{"type":"141","description":"237","properties":"260"},"7a1b17d9c7f1c",["261","262"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["240"],"integer","Unix epoch when the resource was created.",["115","263"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["115","263"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["115","263"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["241"],"The configuration properties for the plugin",{"hour":"264","minute":"265"},"array","A list of the request protocols that will trigger this plugin.",{"type":"115","enum":"266","default":"137"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"115"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"267"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["137"],["115"],{"before":"268"},{"hour":500,"minute":20},["137","164"],["269","270"],{"before":"271"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["240"],["115","263"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["115","263"],["115","263"],["241"],{"hour":"272","minute":"273"},{"type":"115","enum":"274","default":"137"},{"type":"115"},{"before":"275"},{"id":"276","name":"240","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"277","protocols":"278","enabled":true,"tags":"279","ordering":"280"},{"id":"281","name":"240","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"282","protocols":"283","enabled":true,"tags":"284","ordering":"285"},"null",{"type":"218","examples":"286"},{"type":"218","examples":"287"},["137","288","289","290","291"],{"type":"230","items":"292"},["115"],"user-level","low-priority",["293"],{"type":"218","examples":"294"},{"type":"218","examples":"295"},["137","288","289","290","291"],{"type":"230","items":"296"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["137","164"],["269","270"],{"before":"297"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["291","290"],["298","299","300"],{"after":"301"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"115"},"plugin-name",[500],[500],{"type":"115"},["293"],"admin","high-priority","critical",["293"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-plugin-with-service-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a plugin associated with a Service in a workspace",["18"],"a0ed2545159b4","put","/{workspace}/services/{service_id_or_name}/plugins/{plugin_id}",["19"],{},"upsert-plugin-with-service-workspace","Create or Update a plugin associated with a Service using ID in a workspace.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Plugins",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50","51"],["52"],{"id":"53","url":"54","name":"55","description":"56","variables":"57"},"c26fb55b0a58f","c16d75fd5ef73","200",[],["58"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","694d74209c18b","400",[],["59"],"Invalid plugin","695d74209c7d8","401",[],["60"],"Unauthorized","35053a475e4d2",["61"],"Plugin request body",{"id":"62","name":"63","style":"64","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"64","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","name":"76","style":"64","examples":"77","description":"78","required":true,"schema":"79","explicitProperties":"80"},{"id":"81","key":"82","extensions":"83","description":"84","type":"85","name":"86","in":"87"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"88","path":"89","port":"90","protocol":"91"},{"id":"92","mediaType":"93","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"93","examples":"98","encodings":"99","schema":"100"},{"id":"101","mediaType":"93","examples":"102","encodings":"103","schema":"104"},{"id":"105","mediaType":"93","examples":"106","encodings":"107","schema":"108"},"1b1c37796fda6","workspace","simple",[],"Name or ID of workspace",{"type":"109","examples":"110","$schema":"111","x-stoplight":"112"},["113","114","115","116","117","118"],"1e752fddaf0a0","service_id_or_name",["119"],"ID **or** name of the service to lookup",{"type":"109","examples":"120","$schema":"111","x-stoplight":"121"},["113","117","122","114","115","116","118"],"7f2edf5add6ff","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"109","examples":"123","$schema":"111","x-stoplight":"124"},["113","114","115","116","117","118"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"125","description":"126"},{"default":"127","description":"128"},{"default":"129","description":"130"},{"default":"131","description":"132","enum":"133"},"57de8ffbdda63","application/json",["134"],[],{"type":"135","properties":"136","$schema":"111","x-stoplight":"137"},"a021ba0bd62e3",[],[],{"type":"135","$schema":"111","x-stoplight":"138"},"f84e30fa8add8",["139","140","141"],[],{"type":"135","properties":"142","required":"143","title":"144","$schema":"111","x-stoplight":"145"},"72a9eef3bcdc5",["146"],[],{"type":"135","x-examples":"147","properties":"148","$schema":"111","x-stoplight":"149"},"string",["150"],"http://json-schema.org/draft-07/schema#",{"id":"151"},"name","in","required","schema","description","title",{"id":"152","value":"153","key":"154"},["153"],{"id":"155"},"example",["156"],{"id":"157"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["131","158"],{"id":"159","key":"160","value":"161"},"object",{"id":"162","name":"163","created_at":"164","route":"165","service":"166","consumer":"167","instance_name":"168","config":"169","protocols":"170","enabled":"171","tags":"172","ordering":"173"},{"id":"174"},{"id":"175"},{"id":"176","key":"177","value":"178","summary":"179"},{"id":"180","key":"181","value":"182","summary":"183"},{"id":"184","key":"185","value":"186","summary":"187"},{"status":"188","message":"189"},["190","191"],"UnauthorizedError",{"id":"192"},{"id":"193","key":"194","value":"195"},{"Example 1":"196"},{"name":"197","route":"198","service":"199","consumer":"200","instance_name":"201","config":"202","protocols":"203","enabled":"204","tags":"205","ordering":"206"},{"id":"207"},"team-a","12bd876ade926","5bb3d0af2c271","test-service","default","ab7048fe628d3","response-ratelimiting","8414d572e01c6","https","1ab90fff195bb","Plugin response",{"data":"208","next":"209"},{"type":"109"},{"type":"109","description":"210","examples":"211"},{"type":"212","description":"213"},{"type":"214","description":"215"},{"type":"216","description":"217"},{"type":"218","description":"219"},{"type":"109","description":"220","examples":"221"},{"type":"135","description":"222","properties":"223"},{"type":"224","description":"225","items":"226"},{"type":"227","description":"228","default":true},{"type":"224","description":"229","items":"230"},{"type":"135","description":"231","properties":"232"},"1129d1ef33e52","18eaaf1bf8177","8c270e0bbf424","DuplicateApiKey",{"message":"179","status":401},"Duplicate API key found","59b9134968033","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","c46b2bffa00a3","NoAPIKey",{"message":"233","status":401},"No API key found",{"type":"212"},{"type":"109"},"status","message","470b68e5f0549","8d11c7ee24328","request example",{"name":"234","route":"109","service":"109","consumer":"109","instance_name":"235","config":"236","protocols":"237","enabled":true,"tags":"238","ordering":"239"},{"name":"234","route":null,"service":null,"consumer":null,"instance_name":"235","config":"240","protocols":"241","enabled":true,"tags":"242","ordering":"243"},{"type":"109","description":"244","examples":"245"},{"type":"246","description":"247"},{"type":"248","description":"217"},{"type":"249","description":"219"},{"type":"109","description":"220","examples":"250"},{"type":"135","description":"222","properties":"251"},{"type":"224","description":"225","items":"252"},{"type":"227","description":"228","default":true},{"type":"224","description":"229","items":"253"},{"type":"135","description":"231","properties":"254"},"7a1b17d9c7f1c",["255","256"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["234"],"integer","Unix epoch when the resource was created.",["109","257"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["109","257"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["109","257"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["235"],"The configuration properties for the plugin",{"hour":"258","minute":"259"},"array","A list of the request protocols that will trigger this plugin.",{"type":"109","enum":"260","default":"131"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"109"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"261"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["131"],["109"],{"before":"262"},{"hour":500,"minute":20},["131","158"],["263","264"],{"before":"265"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["234"],["109","257"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["109","257"],["109","257"],["235"],{"hour":"266","minute":"267"},{"type":"109","enum":"268","default":"131"},{"type":"109"},{"before":"269"},{"id":"270","name":"234","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"271","protocols":"272","enabled":true,"tags":"273","ordering":"274"},{"id":"275","name":"234","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"276","protocols":"277","enabled":true,"tags":"278","ordering":"279"},"null",{"type":"212","examples":"280"},{"type":"212","examples":"281"},["131","282","283","284","285"],{"type":"224","items":"286"},["109"],"user-level","low-priority",["287"],{"type":"212","examples":"288"},{"type":"212","examples":"289"},["131","282","283","284","285"],{"type":"224","items":"290"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["131","158"],["263","264"],{"before":"291"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["285","284"],["292","293","294"],{"after":"295"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"109"},"plugin-name",[500],[500],{"type":"109"},["287"],"admin","high-priority","critical",["287"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-plugins-consumer-group",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all plugins associated with a consumer group",["18"],"38591c9f41e05","get","/consumer_groups/{consumer_username_or_id}/plugins",["19"],{},"list-plugins-consumer-group","Retrieve a list of all plugins associated with a consumer group.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Plugins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40","41"],[],["42"],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"c26fb55b0a58f","17deae1f3b61a","200",[],["49"],"A successful response listing plugins","828ead8dccc27","401",[],["50"],"Unauthorized",{"id":"51","name":"52","style":"53","examples":"54","description":"55","schema":"56","explicitProperties":"57"},{"id":"58","name":"59","style":"53","examples":"60","description":"61","schema":"62","explicitProperties":"63"},{"id":"64","name":"65","style":"53","examples":"66","description":"67","schema":"68","explicitProperties":"69"},{"id":"70","name":"71","style":"72","examples":"73","description":"74","required":true,"schema":"75","explicitProperties":"76"},{"id":"77","key":"78","extensions":"79","description":"80","type":"81","name":"82","in":"83"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"84","path":"85","port":"86","protocol":"87"},{"id":"88","mediaType":"89","examples":"90","encodings":"91","schema":"92"},{"id":"93","mediaType":"89","examples":"94","encodings":"95","schema":"96"},"0c2fb4f2ce190","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"97","$schema":"98","x-stoplight":"99"},["100","101","102","103","104"],"551f1d955e752","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"105","$schema":"98","x-stoplight":"106"},["100","101","102","103","104"],"7d4f0a20dc341","tags",["107"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"105","examples":"108","x-stoplight":"109","$schema":"98"},["100","110","101","102","103","104"],"3b33f3f633bdf","consumer_username_or_id","simple",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"105","examples":"111","$schema":"98","x-stoplight":"112"},["102","101","113","103","100","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121","enum":"122"},"80973cd234ca5","application/json",[],[],{"properties":"123","$schema":"98","x-stoplight":"124"},"566fe97bb1682",["125","126","127"],[],{"type":"128","properties":"129","required":"130","title":"131","$schema":"98","x-stoplight":"132"},"integer","http://json-schema.org/draft-07/schema#",{"id":"133"},"description","in","name","schema","title","string",{"id":"134"},{"id":"135","value":"136","key":"137"},["136"],{"explicitProperties":"138","id":"139"},"example",["140"],{"id":"141"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["120","142"],{"data":"143","offset":"144"},{"id":"145"},{"id":"146","key":"147","value":"148","summary":"149"},{"id":"150","key":"151","value":"152","summary":"153"},{"id":"154","key":"155","value":"156","summary":"157"},"object",{"status":"158","message":"159"},["160","161"],"UnauthorizedError",{"id":"162"},"3702712e012d0","93f4d675bd09d","e6256b502fff4","tag1,tag2","default",["163","164","165"],"8144141b52318","my-username","298da99382dde","https",{"items":"166","type":"167"},{"description":"168","type":"105","title":"169"},"6ab682f2da952","d120c935b2b27","DuplicateApiKey",{"message":"149","status":401},"Duplicate API key found","ab0dcc28b598d","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","1901183d316a6","NoAPIKey",{"message":"170","status":401},"No API key found",{"type":"97"},{"type":"105"},"status","message","470b68e5f0549","type","nullable","examples",{"description":"171","properties":"172","type":"128","title":"173","examples":"174"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","No API key found in request","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":"175","consumer":"176","consumer_group":"177","created_at":"178","enabled":"179","id":"180","name":"181","ordering":"182","protocols":"183","route":"184","service":"185","tags":"186","updated_at":"187"},"Plugin",["188"],{"description":"189","type":"128"},{"additionalProperties":false,"description":"190","properties":"191","type":"128"},{"additionalProperties":false,"description":"192","properties":"193","type":"128"},{"description":"194","type":"97"},{"default":true,"description":"195","type":"196"},{"type":"105"},{"description":"197","type":"105"},{"type":"128"},{"default":"198","description":"199","items":"200","type":"167"},{"additionalProperties":false,"description":"201","properties":"202","type":"128"},{"additionalProperties":false,"description":"203","properties":"204","type":"128"},{"description":"205","items":"206","type":"167"},{"description":"207","type":"97"},{"config":"208","enabled":true,"id":"209","name":"210","protocols":"211"},"The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).","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":"212"},"If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",{"id":"213"},"Unix epoch when the resource was created.","Whether the plugin is applied.","boolean","The name of the plugin that's going to be added. The plugin must be installed in every Kong instance separately.",["214","215","120","142"],"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`.",{"type":"105"},"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":"216"},"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":"217"},"An optional set of strings associated with the plugin for grouping and filtering.",{"type":"105"},"Unix epoch when the resource was last updated.",{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":"218","run_on_preflight":true},"3fd1eea1-885a-4011-b986-289943ff8177","key-auth",["214","215","120","142"],{"type":"105"},{"type":"105"},"grpc","grpcs",{"type":"105"},{"type":"105"},["219"],"apikey"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-plugin-for-consumer-group",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create a new plugin associated with a consumer group",["18"],"233007a055c55","post","/consumer_groups/{consumer_username_or_id}/plugins",["19"],{},"create-plugin-for-consumer-group","Create a new plugin associated with a Consumer Group","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Plugins",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"c26fb55b0a58f","64b80841ded6d","200",[],["56"],"Successfully created plugin","5a1808e49ae9b","400",[],["57"],"Invalid plugin","5a2808e49af68","401",[],["58"],"Unauthorized","868eea5af1ee0",["59"],"Plugin request body",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"79","examples":"84","encodings":"85","schema":"86"},{"id":"87","mediaType":"79","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"79","examples":"92","encodings":"93","schema":"94"},"4733ef28c0ca0","consumer_username_or_id","simple",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110"},{"default":"111","description":"112","enum":"113"},"a4ace03778fcb","application/json",["114"],[],{"description":"115","properties":"116","type":"117","title":"118","examples":"119"},"5ef603061fb37",[],[],{"type":"117","$schema":"97","x-stoplight":"120"},"74d3e6bd043e7",["121","122","123"],[],{"type":"117","properties":"124","required":"125","title":"126","$schema":"97","x-stoplight":"127"},"108fee319179d",["128"],[],{"type":"117","x-examples":"129","properties":"130","$schema":"97","x-stoplight":"131"},"string",["132"],"http://json-schema.org/draft-07/schema#",{"id":"133"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["111","134"],{"id":"135","value":"136","key":"137"},"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":"138","consumer":"139","consumer_group":"140","created_at":"141","enabled":"142","id":"143","name":"144","ordering":"145","protocols":"146","route":"147","service":"148","tags":"149","updated_at":"150"},"object","Plugin",["136"],{"id":"151"},{"id":"152","key":"153","value":"154","summary":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"id":"160","key":"161","value":"162","summary":"163"},{"status":"164","message":"165"},["166","167"],"UnauthorizedError",{"id":"168"},{"id":"169","key":"170","value":"171"},{"Example 1":"172"},{"name":"173","route":"174","service":"175","consumer":"176","instance_name":"177","config":"178","protocols":"179","enabled":"180","tags":"181","ordering":"182"},{"id":"183"},"my-username","6726cd8bd10e1","https","fa93942f2dd53",{"config":"184","enabled":true,"id":"185","name":"186","protocols":"187"},"default",{"description":"188","type":"117"},{"additionalProperties":false,"description":"189","properties":"190","type":"117"},{"additionalProperties":false,"description":"191","properties":"192","type":"117"},{"description":"193","type":"194"},{"default":true,"description":"195","type":"196"},{"type":"95"},{"description":"197","type":"95"},{"type":"117"},{"default":"198","description":"199","items":"200","type":"201"},{"additionalProperties":false,"description":"202","properties":"203","type":"117"},{"additionalProperties":false,"description":"204","properties":"205","type":"117"},{"description":"206","items":"207","type":"201"},{"description":"208","type":"194"},"90d8679850008","d4649f16e8367","DuplicateApiKey",{"message":"155","status":401},"Duplicate API key found","c684049605ee6","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","89b153d0e54e1","NoAPIKey",{"message":"209","status":401},"No API key found",{"type":"194"},{"type":"95"},"status","message","470b68e5f0549","859a832b002b4","request example",{"name":"210","route":"95","service":"95","consumer":"95","instance_name":"211","config":"212","protocols":"213","enabled":true,"tags":"214","ordering":"215"},{"name":"210","route":null,"service":null,"consumer":null,"instance_name":"211","config":"216","protocols":"217","enabled":true,"tags":"218","ordering":"219"},{"type":"95","description":"220","examples":"221"},{"type":"222","description":"223"},{"type":"224","description":"225"},{"type":"226","description":"227"},{"type":"95","description":"228","examples":"229"},{"type":"117","description":"230","properties":"231"},{"type":"201","description":"232","items":"233"},{"type":"196","description":"234","default":true},{"type":"201","description":"235","items":"236"},{"type":"117","description":"237","properties":"238"},"7a1b17d9c7f1c",{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":"239","run_on_preflight":true},"3fd1eea1-885a-4011-b986-289943ff8177","key-auth",["240","241","111","134"],"The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).","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":"242"},"If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",{"id":"243"},"Unix epoch when the resource was created.","integer","Whether the plugin is applied.","boolean","The name of the plugin that's going to be added. The plugin must be installed in every Kong instance separately.",["240","241","111","134"],"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`.",{"type":"95"},"array","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":"244"},"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":"245"},"An optional set of strings associated with the plugin for grouping and filtering.",{"type":"95"},"Unix epoch when the resource was last updated.","No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["111"],["95"],{"before":"246"},{"hour":500,"minute":20},["111","134"],["247","248"],{"before":"249"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["210"],["95","250"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["95","250"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["95","250"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["211"],"The configuration properties for the plugin",{"hour":"251","minute":"252"},"A list of the request protocols that will trigger this plugin.",{"type":"95","enum":"253","default":"111"},"Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"95"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"254"},["255"],"grpc","grpcs",{"type":"95"},{"type":"95"},{"type":"95"},{"type":"95"},["95"],"user-level","low-priority",["256"],"null",{"type":"194","examples":"257"},{"type":"194","examples":"258"},["111","240","241","259","260"],{"type":"201","items":"261"},"apikey","plugin-name",[500],[500],"tls","tcp",{"type":"95"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-plugin-for-consumer-group",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a plugin associated with a consumer group",["18"],"4c3875af49db4","delete","/consumer_groups/{consumer_group_name_or_id}/plugins/{plugin_id}",["19"],{},"delete-plugin-for-consumer-group","Delete a plugin associated with a a consumer group using ID.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Plugins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40","41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"c26fb55b0a58f","346ab5da483f9","204",[],[],"Successfully deleted plugin or the resource didn't exist","5c3ab79ff1ee3","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","required":true,"schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"51","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},"d3c0d42b46a84","workspace","simple",[],"Name or ID of workspace",{"type":"84","examples":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92","93"],"8e042686f2d19","consumer_group_name_or_id",[],"The name or UUID of the consumer group to remove.",{"type":"84","$schema":"86","x-stoplight":"94"},["88","89","90","91","92","93"],"d3fb255fa3c14","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"84","examples":"95","$schema":"86","x-stoplight":"96"},["88","89","90","91","92","93"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"97","description":"98"},{"default":"99","description":"100"},{"default":"101","description":"102"},{"default":"103","description":"104","enum":"105"},"4efdc9e6901c6","application/json",["106","107","108"],[],{"type":"109","properties":"110","required":"111","title":"112","$schema":"86","x-stoplight":"113"},"string",["114"],"http://json-schema.org/draft-07/schema#",{"id":"115"},"name","in","required","schema","description","title",{"id":"116"},["117"],{"id":"118"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["103","119"],{"id":"120","key":"121","value":"122","summary":"123"},{"id":"124","key":"125","value":"126","summary":"127"},{"id":"128","key":"129","value":"130","summary":"131"},"object",{"status":"132","message":"133"},["134","135"],"UnauthorizedError",{"id":"136"},"team-a","b09b80c4c931e","cd430d94b0c2a","response-ratelimiting","083f598b0ef3d","https","08d1201743e6b","DuplicateApiKey",{"message":"123","status":401},"Duplicate API key found","48f215fe93e44","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","9895073d74484","NoAPIKey",{"message":"137","status":401},"No API key found",{"type":"138"},{"type":"84"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/fetch-plugin-with-consumer-group",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a plugin associated with a Consumer Group",["18"],"7b84ac40444f2","get","/consumer_groups/{consumer_group_name_or_id}/plugins/{plugin_id}",["19"],{},"fetch-plugin-with-consumer-group","Get a plugin associated with a Consumer Group using ID.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46","47"],["48"],{"id":"49","url":"50","name":"51","description":"52","variables":"53"},"c26fb55b0a58f","f9f9b31564ce6","200",[],["54"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","2229b4db0d7e7","401",[],["55"],"Unauthorized","21d9b4db0dc64","404",[],["56"],"Not Found",{"id":"57","name":"58","style":"59","examples":"60","description":"61","required":true,"schema":"62","explicitProperties":"63"},{"id":"64","name":"65","style":"59","examples":"66","description":"67","required":true,"schema":"68","explicitProperties":"69"},{"id":"70","name":"71","style":"59","examples":"72","description":"73","required":true,"schema":"74","explicitProperties":"75"},{"id":"76","key":"77","extensions":"78","description":"79","type":"80","name":"81","in":"82"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"83","path":"84","port":"85","protocol":"86"},{"id":"87","mediaType":"88","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"88","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"88","examples":"97","encodings":"98","schema":"99"},"43ca17eb4afec","workspace","simple",[],"Name or ID of workspace",{"type":"100","examples":"101","$schema":"102","x-stoplight":"103"},["104","105","106","107","108","109"],"49506baf7fbd9","consumer_group_name_or_id",[],"The name or UUID of the consumer group to remove.",{"type":"100","$schema":"102","x-stoplight":"110"},["104","105","106","107","108","109"],"e690ec772aa47","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"100","examples":"111","$schema":"102","x-stoplight":"112"},["104","105","106","107","108","109"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"19bae94c63e51","application/json",["122"],[],{"type":"123","properties":"124","$schema":"102","x-stoplight":"125"},"4a5a62cc513b3",["126","127","128"],[],{"type":"123","properties":"129","required":"130","title":"131","$schema":"102","x-stoplight":"132"},"82ce092df3a85",["133"],[],{"type":"123","x-examples":"134","properties":"135","$schema":"102","x-stoplight":"136"},"string",["137"],"http://json-schema.org/draft-07/schema#",{"id":"138"},"name","in","required","schema","description","title",{"id":"139"},["140"],{"id":"141"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","142"],{"id":"143","key":"144","value":"145"},"object",{"id":"146","name":"147","created_at":"148","route":"149","service":"150","consumer":"151","instance_name":"152","config":"153","protocols":"154","enabled":"155","tags":"156","ordering":"157"},{"id":"158"},{"id":"159","key":"160","value":"161","summary":"162"},{"id":"163","key":"164","value":"165","summary":"166"},{"id":"167","key":"168","value":"169","summary":"170"},{"status":"171","message":"172"},["173","174"],"UnauthorizedError",{"id":"175"},{"id":"176","key":"44","value":"177"},{"Example 1":"178"},{"message":"179"},{"id":"180"},"team-a","9ceb1e1aa6a07","71328d69a81b5","response-ratelimiting","66fb16dca286d","https","0dafb593e943f","Plugin response",{"data":"181","next":"182"},{"type":"100"},{"type":"100","description":"183","examples":"184"},{"type":"185","description":"186"},{"type":"187","description":"188"},{"type":"189","description":"190"},{"type":"191","description":"192"},{"type":"100","description":"193","examples":"194"},{"type":"123","description":"195","properties":"196"},{"type":"197","description":"198","items":"199"},{"type":"200","description":"201","default":true},{"type":"197","description":"202","items":"203"},{"type":"123","description":"204","properties":"205"},"1129d1ef33e52","58641a28dfcd1","DuplicateApiKey",{"message":"162","status":401},"Duplicate API key found","308c422b9743c","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","fbcee1ff678d5","NoAPIKey",{"message":"206","status":401},"No API key found",{"type":"185"},{"type":"100"},"status","message","470b68e5f0549","8d8669387fb28",{"message":"44"},{"message":"207"},{"type":"100","description":"208","examples":"209"},"ad672cf1ef317",["210","211"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["212"],"integer","Unix epoch when the resource was created.",["100","213"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["100","213"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["100","213"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["214"],"The configuration properties for the plugin",{"hour":"215","minute":"216"},"array","A list of the request protocols that will trigger this plugin.",{"type":"100","enum":"217","default":"119"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"100"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"218"},"No API key found in request","Not found","404 Not Found",["44"],{"id":"219","name":"212","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"220","protocols":"221","enabled":true,"tags":"222","ordering":"223"},{"id":"224","name":"212","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"225","protocols":"226","enabled":true,"tags":"227","ordering":"228"},"rate-limiting","null","rate-limiting-foo",{"type":"185","examples":"229"},{"type":"185","examples":"230"},["119","231","232","233","234"],{"type":"197","items":"235"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["119","142"],["236","237"],{"before":"238"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["234","233"],["239","240","241"],{"after":"242"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"100"},"user-level","low-priority",["243"],"admin","high-priority","critical",["243"],"plugin-name"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-plugin-with-consumer-group",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a plugin associated with a consumer group",["18"],"a43658e5174b6","patch","/consumer_groups/{consumer_group_name_or_id}/plugins/{plugin_id}",["19"],{},"update-plugin-with-consumer-group","Update a plugin associated with a consumer group using the consumergroup name or ID.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"Plugins",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55","56","57"],["58"],{"id":"59","url":"60","name":"61","description":"62","variables":"63"},"c26fb55b0a58f","73de4cf642619","200",[],["64"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","713e4d990cbd7","400",[],["65"],"Invalid plugin","714e4d990c564","401",[],["66"],"Unauthorized","70fe4d990b2eb","404",[],[],"Resource does not exist","ee151c86dae9d",["67"],"Plugin request body",{"id":"68","name":"69","style":"70","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","name":"76","style":"70","examples":"77","description":"78","required":true,"schema":"79","explicitProperties":"80"},{"id":"81","name":"82","style":"70","examples":"83","description":"84","required":true,"schema":"85","explicitProperties":"86"},{"id":"87","key":"88","extensions":"89","description":"90","type":"91","name":"92","in":"93"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"94","path":"95","port":"96","protocol":"97"},{"id":"98","mediaType":"99","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"99","examples":"104","encodings":"105","schema":"106"},{"id":"107","mediaType":"99","examples":"108","encodings":"109","schema":"110"},{"id":"111","mediaType":"99","examples":"112","encodings":"113","schema":"114"},"f8ddecd9c4fbe","workspace","simple",[],"Name or ID of workspace",{"type":"115","examples":"116","$schema":"117","x-stoplight":"118"},["119","120","121","122","123","124"],"276a551973130","consumer_group_name_or_id",[],"The name or UUID of the consumer group to remove.",{"type":"115","$schema":"117","x-stoplight":"125"},["119","120","121","122","123","124"],"df7f076901bc5","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"115","examples":"126","$schema":"117","x-stoplight":"127"},["119","120","121","122","123","124"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"128","description":"129"},{"default":"130","description":"131"},{"default":"132","description":"133"},{"default":"134","description":"135","enum":"136"},"ec121cb86b1fe","application/json",["137"],[],{"type":"138","properties":"139","$schema":"117","x-stoplight":"140"},"1d990db8f0c35",[],[],{"type":"138","$schema":"117","x-stoplight":"141"},"2cb60c5a9757e",["142","143","144"],[],{"type":"138","properties":"145","required":"146","title":"147","$schema":"117","x-stoplight":"148"},"fb384182a470e",["149"],[],{"type":"138","x-examples":"150","properties":"151","$schema":"117","x-stoplight":"152"},"string",["153"],"http://json-schema.org/draft-07/schema#",{"id":"154"},"name","in","required","schema","description","title",{"id":"155"},["156"],{"id":"157"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["134","158"],{"id":"159","key":"160","value":"161"},"object",{"id":"162","name":"163","created_at":"164","route":"165","service":"166","consumer":"167","instance_name":"168","config":"169","protocols":"170","enabled":"171","tags":"172","ordering":"173"},{"id":"174"},{"id":"175"},{"id":"176","key":"177","value":"178","summary":"179"},{"id":"180","key":"181","value":"182","summary":"183"},{"id":"184","key":"185","value":"186","summary":"187"},{"status":"188","message":"189"},["190","191"],"UnauthorizedError",{"id":"192"},{"id":"193","key":"194","value":"195"},{"Example 1":"196"},{"name":"197","route":"198","service":"199","consumer":"200","instance_name":"201","config":"202","protocols":"203","enabled":"204","tags":"205","ordering":"206"},{"id":"207"},"team-a","66990de177747","9605cbdec0bae","response-ratelimiting","b3b830073921f","https","ac5ccc4734394","Plugin response",{"data":"208","next":"209"},{"type":"115"},{"type":"115","description":"210","examples":"211"},{"type":"212","description":"213"},{"type":"214","description":"215"},{"type":"216","description":"217"},{"type":"218","description":"219"},{"type":"115","description":"220","examples":"221"},{"type":"138","description":"222","properties":"223"},{"type":"224","description":"225","items":"226"},{"type":"227","description":"228","default":true},{"type":"224","description":"229","items":"230"},{"type":"138","description":"231","properties":"232"},"1129d1ef33e52","17fbbc3f6dd48","f4484a0b77c21","DuplicateApiKey",{"message":"179","status":401},"Duplicate API key found","ea0f09d02c3c2","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","1577ea27a48d4","NoAPIKey",{"message":"233","status":401},"No API key found",{"type":"212"},{"type":"115"},"status","message","470b68e5f0549","c9a9b68e4a3c7","request example",{"name":"234","route":"115","service":"115","consumer":"115","instance_name":"235","config":"236","protocols":"237","enabled":true,"tags":"238","ordering":"239"},{"name":"234","route":null,"service":null,"consumer":null,"instance_name":"235","config":"240","protocols":"241","enabled":true,"tags":"242","ordering":"243"},{"type":"115","description":"244","examples":"245"},{"type":"246","description":"247"},{"type":"248","description":"217"},{"type":"249","description":"219"},{"type":"115","description":"220","examples":"250"},{"type":"138","description":"222","properties":"251"},{"type":"224","description":"225","items":"252"},{"type":"227","description":"228","default":true},{"type":"224","description":"229","items":"253"},{"type":"138","description":"231","properties":"254"},"7a1b17d9c7f1c",["255","256"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["234"],"integer","Unix epoch when the resource was created.",["115","257"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["115","257"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["115","257"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["235"],"The configuration properties for the plugin",{"hour":"258","minute":"259"},"array","A list of the request protocols that will trigger this plugin.",{"type":"115","enum":"260","default":"134"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"115"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"261"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["134"],["115"],{"before":"262"},{"hour":500,"minute":20},["134","158"],["263","264"],{"before":"265"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["234"],["115","257"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["115","257"],["115","257"],["235"],{"hour":"266","minute":"267"},{"type":"115","enum":"268","default":"134"},{"type":"115"},{"before":"269"},{"id":"270","name":"234","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"271","protocols":"272","enabled":true,"tags":"273","ordering":"274"},{"id":"275","name":"234","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"276","protocols":"277","enabled":true,"tags":"278","ordering":"279"},"null",{"type":"212","examples":"280"},{"type":"212","examples":"281"},["134","282","283","284","285"],{"type":"224","items":"286"},["115"],"user-level","low-priority",["287"],{"type":"212","examples":"288"},{"type":"212","examples":"289"},["134","282","283","284","285"],{"type":"224","items":"290"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["134","158"],["263","264"],{"before":"291"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["285","284"],["292","293","294"],{"after":"295"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"115"},"plugin-name",[500],[500],{"type":"115"},["287"],"admin","high-priority","critical",["287"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-plugin-for-customer-group",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a plugin associated with a Consumer Group",["18"],"6d2907ae5a00e","put","/consumer_groups/{consumer_group_name_or_id}/plugins/{plugin_id}",["19"],{},"upsert-plugin-for-customer-group","Create or Update a plugin associated with a Consumer Group using ID.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Plugins",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50","51"],["52"],{"id":"53","url":"54","name":"55","description":"56","variables":"57"},"c26fb55b0a58f","efb48fd654de7","200",[],["58"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","bd1490620480e","400",[],["59"],"Invalid plugin","bd24906204add","401",[],["60"],"Unauthorized","8381a2bcdf116",["61"],"Plugin request body",{"id":"62","name":"63","style":"64","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"64","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","name":"76","style":"64","examples":"77","description":"78","required":true,"schema":"79","explicitProperties":"80"},{"id":"81","key":"82","extensions":"83","description":"84","type":"85","name":"86","in":"87"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"88","path":"89","port":"90","protocol":"91"},{"id":"92","mediaType":"93","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"93","examples":"98","encodings":"99","schema":"100"},{"id":"101","mediaType":"93","examples":"102","encodings":"103","schema":"104"},{"id":"105","mediaType":"93","examples":"106","encodings":"107","schema":"108"},"cb7e8f4d08e0f","workspace","simple",[],"Name or ID of workspace",{"type":"109","examples":"110","$schema":"111","x-stoplight":"112"},["113","114","115","116","117","118"],"9ac965ed16a9e","consumer_group_name_or_id",[],"The name or UUID of the consumer group to remove.",{"type":"109","$schema":"111","x-stoplight":"119"},["113","114","115","116","117","118"],"c7c0093b6c499","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"109","examples":"120","$schema":"111","x-stoplight":"121"},["113","114","115","116","117","118"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"122","description":"123"},{"default":"124","description":"125"},{"default":"126","description":"127"},{"default":"128","description":"129","enum":"130"},"7fa4bcfbd1939","application/json",["131"],[],{"type":"132","properties":"133","$schema":"111","x-stoplight":"134"},"2402440f0e7ad",[],[],{"type":"132","$schema":"111","x-stoplight":"135"},"509fd053c0d2c",["136","137","138"],[],{"type":"132","properties":"139","required":"140","title":"141","$schema":"111","x-stoplight":"142"},"0305f3016df0d",["143"],[],{"type":"132","x-examples":"144","properties":"145","$schema":"111","x-stoplight":"146"},"string",["147"],"http://json-schema.org/draft-07/schema#",{"id":"148"},"name","in","required","schema","description","title",{"id":"149"},["150"],{"id":"151"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["128","152"],{"id":"153","key":"154","value":"155"},"object",{"id":"156","name":"157","created_at":"158","route":"159","service":"160","consumer":"161","instance_name":"162","config":"163","protocols":"164","enabled":"165","tags":"166","ordering":"167"},{"id":"168"},{"id":"169"},{"id":"170","key":"171","value":"172","summary":"173"},{"id":"174","key":"175","value":"176","summary":"177"},{"id":"178","key":"179","value":"180","summary":"181"},{"status":"182","message":"183"},["184","185"],"UnauthorizedError",{"id":"186"},{"id":"187","key":"188","value":"189"},{"Example 1":"190"},{"name":"191","route":"192","service":"193","consumer":"194","instance_name":"195","config":"196","protocols":"197","enabled":"198","tags":"199","ordering":"200"},{"id":"201"},"team-a","b80b425a13131","c35a2ec2568e3","response-ratelimiting","f3063f00e38c3","https","82a1265f543ac","Plugin response",{"data":"202","next":"203"},{"type":"109"},{"type":"109","description":"204","examples":"205"},{"type":"206","description":"207"},{"type":"208","description":"209"},{"type":"210","description":"211"},{"type":"212","description":"213"},{"type":"109","description":"214","examples":"215"},{"type":"132","description":"216","properties":"217"},{"type":"218","description":"219","items":"220"},{"type":"221","description":"222","default":true},{"type":"218","description":"223","items":"224"},{"type":"132","description":"225","properties":"226"},"1129d1ef33e52","a43046cf5738c","1262a17ed4131","DuplicateApiKey",{"message":"173","status":401},"Duplicate API key found","b4529f11b4b37","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","2903599132192","NoAPIKey",{"message":"227","status":401},"No API key found",{"type":"206"},{"type":"109"},"status","message","470b68e5f0549","3ae5c4bff46f5","request example",{"name":"228","route":"109","service":"109","consumer":"109","instance_name":"229","config":"230","protocols":"231","enabled":true,"tags":"232","ordering":"233"},{"name":"228","route":null,"service":null,"consumer":null,"instance_name":"229","config":"234","protocols":"235","enabled":true,"tags":"236","ordering":"237"},{"type":"109","description":"238","examples":"239"},{"type":"240","description":"241"},{"type":"242","description":"211"},{"type":"243","description":"213"},{"type":"109","description":"214","examples":"244"},{"type":"132","description":"216","properties":"245"},{"type":"218","description":"219","items":"246"},{"type":"221","description":"222","default":true},{"type":"218","description":"223","items":"247"},{"type":"132","description":"225","properties":"248"},"7a1b17d9c7f1c",["249","250"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["228"],"integer","Unix epoch when the resource was created.",["109","251"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["109","251"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["109","251"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["229"],"The configuration properties for the plugin",{"hour":"252","minute":"253"},"array","A list of the request protocols that will trigger this plugin.",{"type":"109","enum":"254","default":"128"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"109"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"255"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["128"],["109"],{"before":"256"},{"hour":500,"minute":20},["128","152"],["257","258"],{"before":"259"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["228"],["109","251"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["109","251"],["109","251"],["229"],{"hour":"260","minute":"261"},{"type":"109","enum":"262","default":"128"},{"type":"109"},{"before":"263"},{"id":"264","name":"228","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"265","protocols":"266","enabled":true,"tags":"267","ordering":"268"},{"id":"269","name":"228","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"270","protocols":"271","enabled":true,"tags":"272","ordering":"273"},"null",{"type":"206","examples":"274"},{"type":"206","examples":"275"},["128","276","277","278","279"],{"type":"218","items":"280"},["109"],"user-level","low-priority",["281"],{"type":"206","examples":"282"},{"type":"206","examples":"283"},["128","276","277","278","279"],{"type":"218","items":"284"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["128","152"],["257","258"],{"before":"285"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["279","278"],["286","287","288"],{"after":"289"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"109"},"plugin-name",[500],[500],{"type":"109"},["281"],"admin","high-priority","critical",["281"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-plugins-consumer-group_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all plugins associated with a consumer group",["18"],"59bc83adb48b6","get","/{workspace}/consumer_groups/{consumer_username_or_id}/plugins",["19"],{},"list-plugins-consumer-group_with_workspace","Retrieve a list of all plugins associated with a consumer group.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Plugins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40","41"],[],["42","43"],["44"],{"id":"45","url":"46","name":"47","description":"48","variables":"49"},"c26fb55b0a58f","6171f72e5dc96","200",[],["50"],"A successful response listing plugins","3961f568b360a","401",[],["51"],"Unauthorized",{"id":"52","name":"53","style":"54","examples":"55","description":"56","schema":"57","explicitProperties":"58"},{"id":"59","name":"60","style":"54","examples":"61","description":"62","schema":"63","explicitProperties":"64"},{"id":"65","name":"66","style":"54","examples":"67","description":"68","schema":"69","explicitProperties":"70"},{"id":"71","name":"72","style":"73","examples":"74","description":"75","required":true,"schema":"76","explicitProperties":"77"},{"id":"78","name":"79","style":"73","examples":"80","description":"81","required":true,"schema":"82","explicitProperties":"83"},{"id":"84","key":"85","extensions":"86","description":"87","type":"88","name":"89","in":"90"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"91","path":"92","port":"93","protocol":"94"},{"id":"95","mediaType":"96","examples":"97","encodings":"98","schema":"99"},{"id":"100","mediaType":"96","examples":"101","encodings":"102","schema":"103"},"eb11801087214","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"104","$schema":"105","x-stoplight":"106"},["107","108","109","110","111"],"5596e6675a0cd","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"112","$schema":"105","x-stoplight":"113"},["107","108","109","110","111"],"e7f2fe4adc983","tags",["114"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"112","examples":"115","x-stoplight":"116","$schema":"105"},["107","117","108","109","110","111"],"cace901405160","workspace","simple",[],"Name or ID of workspace",{"type":"112","examples":"118","$schema":"105","x-stoplight":"119"},["109","108","120","110","107","111"],"d553b686a4837","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"112","examples":"121","$schema":"105","x-stoplight":"122"},["109","108","120","110","107","111"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"123","description":"124"},{"default":"125","description":"126"},{"default":"127","description":"128"},{"default":"129","description":"130","enum":"131"},"3f36c06209799","application/json",[],[],{"properties":"132","$schema":"105","x-stoplight":"133"},"e484203db4465",["134","135","136"],[],{"type":"137","properties":"138","required":"139","title":"140","$schema":"105","x-stoplight":"141"},"integer","http://json-schema.org/draft-07/schema#",{"id":"142"},"description","in","name","schema","title","string",{"id":"143"},{"id":"144","value":"145","key":"146"},["145"],{"explicitProperties":"147","id":"148"},"example",["149"],{"id":"150"},"required",["151"],{"id":"152"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["129","153"],{"data":"154","offset":"155"},{"id":"156"},{"id":"157","key":"158","value":"159","summary":"160"},{"id":"161","key":"162","value":"163","summary":"164"},{"id":"165","key":"166","value":"167","summary":"168"},"object",{"status":"169","message":"170"},["171","172"],"UnauthorizedError",{"id":"173"},"64bf188e92a5d","95ed1fbaaf9c4","e75128e40052d","tag1,tag2","default",["174","175","176"],"15abefe4b9a07","team-a","e0e2f723bae34","my-username","f3ab07617cc7c","https",{"items":"177","type":"178"},{"description":"179","type":"112","title":"180"},"18a29e04e5c35","54aa78db223fb","DuplicateApiKey",{"message":"160","status":401},"Duplicate API key found","23727a421bc82","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","8d03837ff1aea","NoAPIKey",{"message":"181","status":401},"No API key found",{"type":"104"},{"type":"112"},"status","message","470b68e5f0549","type","nullable","examples",{"description":"182","properties":"183","type":"137","title":"184","examples":"185"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","No API key found in request","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":"186","consumer":"187","consumer_group":"188","created_at":"189","enabled":"190","id":"191","name":"192","ordering":"193","protocols":"194","route":"195","service":"196","tags":"197","updated_at":"198"},"Plugin",["199"],{"description":"200","type":"137"},{"additionalProperties":false,"description":"201","properties":"202","type":"137"},{"additionalProperties":false,"description":"203","properties":"204","type":"137"},{"description":"205","type":"104"},{"default":true,"description":"206","type":"207"},{"type":"112"},{"description":"208","type":"112"},{"type":"137"},{"default":"209","description":"210","items":"211","type":"178"},{"additionalProperties":false,"description":"212","properties":"213","type":"137"},{"additionalProperties":false,"description":"214","properties":"215","type":"137"},{"description":"216","items":"217","type":"178"},{"description":"218","type":"104"},{"config":"219","enabled":true,"id":"220","name":"221","protocols":"222"},"The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).","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":"223"},"If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",{"id":"224"},"Unix epoch when the resource was created.","Whether the plugin is applied.","boolean","The name of the plugin that's going to be added. The plugin must be installed in every Kong instance separately.",["225","226","129","153"],"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`.",{"type":"112"},"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":"227"},"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":"228"},"An optional set of strings associated with the plugin for grouping and filtering.",{"type":"112"},"Unix epoch when the resource was last updated.",{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":"229","run_on_preflight":true},"3fd1eea1-885a-4011-b986-289943ff8177","key-auth",["225","226","129","153"],{"type":"112"},{"type":"112"},"grpc","grpcs",{"type":"112"},{"type":"112"},["230"],"apikey"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-plugin-for-consumer-group_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create a new plugin associated with a consumer group",["18"],"4750ff52891e9","post","/{workspace}/consumer_groups/{consumer_username_or_id}/plugins",["19"],{},"create-plugin-for-consumer-group_with_workspace","Create a new plugin associated with a Consumer Group","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Plugins",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"c26fb55b0a58f","bcd87b3f3770e","200",[],["57"],"Successfully created plugin","64b8796275e86","400",[],["58"],"Invalid plugin","64c8796275f55","401",[],["59"],"Unauthorized","07e4eb3731927",["60"],"Plugin request body",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"101"},"8235e8f92a7ac","workspace","simple",[],"Name or ID of workspace",{"type":"102","examples":"103","$schema":"104","x-stoplight":"105"},["106","107","108","109","110","111"],"4399c4b5063ab","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"102","examples":"112","$schema":"104","x-stoplight":"113"},["106","107","108","109","110","111"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121","enum":"122"},"62a9f8b9b7514","application/json",["123"],[],{"description":"124","properties":"125","type":"126","title":"127","examples":"128"},"f1194a8a4aece",[],[],{"type":"126","$schema":"104","x-stoplight":"129"},"efcb250ee9ce8",["130","131","132"],[],{"type":"126","properties":"133","required":"134","title":"135","$schema":"104","x-stoplight":"136"},"5143b4a472719",["137"],[],{"type":"126","x-examples":"138","properties":"139","$schema":"104","x-stoplight":"140"},"string",["141"],"http://json-schema.org/draft-07/schema#",{"id":"142"},"name","in","required","schema","description","title",["143"],{"id":"144"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["120","145"],{"id":"146","value":"147","key":"148"},"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":"149","consumer":"150","consumer_group":"151","created_at":"152","enabled":"153","id":"154","name":"155","ordering":"156","protocols":"157","route":"158","service":"159","tags":"160","updated_at":"161"},"object","Plugin",["147"],{"id":"162"},{"id":"163","key":"164","value":"165","summary":"166"},{"id":"167","key":"168","value":"169","summary":"170"},{"id":"171","key":"172","value":"173","summary":"174"},{"status":"175","message":"176"},["177","178"],"UnauthorizedError",{"id":"179"},{"id":"180","key":"181","value":"182"},{"Example 1":"183"},{"name":"184","route":"185","service":"186","consumer":"187","instance_name":"188","config":"189","protocols":"190","enabled":"191","tags":"192","ordering":"193"},{"id":"194"},"team-a","b5161cd9619bc","my-username","bf10d555ce370","https","f92bd3e888428",{"config":"195","enabled":true,"id":"196","name":"197","protocols":"198"},"default",{"description":"199","type":"126"},{"additionalProperties":false,"description":"200","properties":"201","type":"126"},{"additionalProperties":false,"description":"202","properties":"203","type":"126"},{"description":"204","type":"205"},{"default":true,"description":"206","type":"207"},{"type":"102"},{"description":"208","type":"102"},{"type":"126"},{"default":"209","description":"210","items":"211","type":"212"},{"additionalProperties":false,"description":"213","properties":"214","type":"126"},{"additionalProperties":false,"description":"215","properties":"216","type":"126"},{"description":"217","items":"218","type":"212"},{"description":"219","type":"205"},"30faf247c570e","34e172c8e8e06","DuplicateApiKey",{"message":"166","status":401},"Duplicate API key found","fe4a88af07612","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","c37e4c8c33c68","NoAPIKey",{"message":"220","status":401},"No API key found",{"type":"205"},{"type":"102"},"status","message","470b68e5f0549","564ccfffac3f6","request example",{"name":"221","route":"102","service":"102","consumer":"102","instance_name":"222","config":"223","protocols":"224","enabled":true,"tags":"225","ordering":"226"},{"name":"221","route":null,"service":null,"consumer":null,"instance_name":"222","config":"227","protocols":"228","enabled":true,"tags":"229","ordering":"230"},{"type":"102","description":"231","examples":"232"},{"type":"233","description":"234"},{"type":"235","description":"236"},{"type":"237","description":"238"},{"type":"102","description":"239","examples":"240"},{"type":"126","description":"241","properties":"242"},{"type":"212","description":"243","items":"244"},{"type":"207","description":"245","default":true},{"type":"212","description":"246","items":"247"},{"type":"126","description":"248","properties":"249"},"7a1b17d9c7f1c",{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":"250","run_on_preflight":true},"3fd1eea1-885a-4011-b986-289943ff8177","key-auth",["251","252","120","145"],"The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).","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":"253"},"If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",{"id":"254"},"Unix epoch when the resource was created.","integer","Whether the plugin is applied.","boolean","The name of the plugin that's going to be added. The plugin must be installed in every Kong instance separately.",["251","252","120","145"],"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`.",{"type":"102"},"array","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":"255"},"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":"256"},"An optional set of strings associated with the plugin for grouping and filtering.",{"type":"102"},"Unix epoch when the resource was last updated.","No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["120"],["102"],{"before":"257"},{"hour":500,"minute":20},["120","145"],["258","259"],{"before":"260"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["221"],["102","261"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["102","261"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["102","261"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["222"],"The configuration properties for the plugin",{"hour":"262","minute":"263"},"A list of the request protocols that will trigger this plugin.",{"type":"102","enum":"264","default":"120"},"Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"102"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"265"},["266"],"grpc","grpcs",{"type":"102"},{"type":"102"},{"type":"102"},{"type":"102"},["102"],"user-level","low-priority",["267"],"null",{"type":"205","examples":"268"},{"type":"205","examples":"269"},["120","251","252","270","271"],{"type":"212","items":"272"},"apikey","plugin-name",[500],[500],"tls","tcp",{"type":"102"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-plugin-for-consumer-group_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a plugin associated with a consumer group",["18"],"958710b14934a","delete","/{workspace}/consumer_groups/{consumer_group_name_or_id}/plugins/{plugin_id}",["19"],{},"delete-plugin-for-consumer-group_with_workspace","Delete a plugin associated with a a consumer group using ID.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Plugins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40","41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"c26fb55b0a58f","13a64f0ac4dbd","204",[],[],"Successfully deleted plugin or the resource didn't exist","bbb64d2e0242d","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","required":true,"schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"51","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},"292b14d605132","workspace","simple",[],"Name or ID of workspace",{"type":"84","examples":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92","93"],"e5f4d73cfb367","consumer_group_name_or_id",[],"The name or UUID of the consumer group to remove.",{"type":"84","$schema":"86","x-stoplight":"94"},["88","89","90","91","92","93"],"694e89899fe81","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"84","examples":"95","$schema":"86","x-stoplight":"96"},["88","89","90","91","92","93"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"97","description":"98"},{"default":"99","description":"100"},{"default":"101","description":"102"},{"default":"103","description":"104","enum":"105"},"7db90e71b6bb1","application/json",["106","107","108"],[],{"type":"109","properties":"110","required":"111","title":"112","$schema":"86","x-stoplight":"113"},"string",["114"],"http://json-schema.org/draft-07/schema#",{"id":"115"},"name","in","required","schema","description","title",{"id":"116"},["117"],{"id":"118"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["103","119"],{"id":"120","key":"121","value":"122","summary":"123"},{"id":"124","key":"125","value":"126","summary":"127"},{"id":"128","key":"129","value":"130","summary":"131"},"object",{"status":"132","message":"133"},["134","135"],"UnauthorizedError",{"id":"136"},"team-a","e1953ca619452","1374c9b57d376","response-ratelimiting","18f52d0ee5554","https","4fc7f497b9be6","DuplicateApiKey",{"message":"123","status":401},"Duplicate API key found","80eb80c001bda","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","8f303a715a5dd","NoAPIKey",{"message":"137","status":401},"No API key found",{"type":"138"},{"type":"84"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/fetch-plugin-with-consumer-group_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a plugin associated with a Consumer Group",["18"],"f993111df2205","get","/{workspace}/consumer_groups/{consumer_group_name_or_id}/plugins/{plugin_id}",["19"],{},"fetch-plugin-with-consumer-group_with_workspace","Get a plugin associated with a Consumer Group using ID.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Plugins",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46","47"],["48"],{"id":"49","url":"50","name":"51","description":"52","variables":"53"},"c26fb55b0a58f","3d7ec9e936563","200",[],["54"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","a82ec957c616e","401",[],["55"],"Unauthorized","a85ec957c6b85","404",[],["56"],"Not Found",{"id":"57","name":"58","style":"59","examples":"60","description":"61","required":true,"schema":"62","explicitProperties":"63"},{"id":"64","name":"65","style":"59","examples":"66","description":"67","required":true,"schema":"68","explicitProperties":"69"},{"id":"70","name":"71","style":"59","examples":"72","description":"73","required":true,"schema":"74","explicitProperties":"75"},{"id":"76","key":"77","extensions":"78","description":"79","type":"80","name":"81","in":"82"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"83","path":"84","port":"85","protocol":"86"},{"id":"87","mediaType":"88","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"88","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"88","examples":"97","encodings":"98","schema":"99"},"4e243bff33d04","workspace","simple",[],"Name or ID of workspace",{"type":"100","examples":"101","$schema":"102","x-stoplight":"103"},["104","105","106","107","108","109"],"433f8f6efea75","consumer_group_name_or_id",[],"The name or UUID of the consumer group to remove.",{"type":"100","$schema":"102","x-stoplight":"110"},["104","105","106","107","108","109"],"59b35e3cdd751","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"100","examples":"111","$schema":"102","x-stoplight":"112"},["104","105","106","107","108","109"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"d9b526f4122c6","application/json",["122"],[],{"type":"123","properties":"124","$schema":"102","x-stoplight":"125"},"d1b20229b57f9",["126","127","128"],[],{"type":"123","properties":"129","required":"130","title":"131","$schema":"102","x-stoplight":"132"},"014d912cf9d64",["133"],[],{"type":"123","x-examples":"134","properties":"135","$schema":"102","x-stoplight":"136"},"string",["137"],"http://json-schema.org/draft-07/schema#",{"id":"138"},"name","in","required","schema","description","title",{"id":"139"},["140"],{"id":"141"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","142"],{"id":"143","key":"144","value":"145"},"object",{"id":"146","name":"147","created_at":"148","route":"149","service":"150","consumer":"151","instance_name":"152","config":"153","protocols":"154","enabled":"155","tags":"156","ordering":"157"},{"id":"158"},{"id":"159","key":"160","value":"161","summary":"162"},{"id":"163","key":"164","value":"165","summary":"166"},{"id":"167","key":"168","value":"169","summary":"170"},{"status":"171","message":"172"},["173","174"],"UnauthorizedError",{"id":"175"},{"id":"176","key":"44","value":"177"},{"Example 1":"178"},{"message":"179"},{"id":"180"},"team-a","297baf32188a2","1bb5b01b2383a","response-ratelimiting","b96349a638b5d","https","c1a3e64d5b616","Plugin response",{"data":"181","next":"182"},{"type":"100"},{"type":"100","description":"183","examples":"184"},{"type":"185","description":"186"},{"type":"187","description":"188"},{"type":"189","description":"190"},{"type":"191","description":"192"},{"type":"100","description":"193","examples":"194"},{"type":"123","description":"195","properties":"196"},{"type":"197","description":"198","items":"199"},{"type":"200","description":"201","default":true},{"type":"197","description":"202","items":"203"},{"type":"123","description":"204","properties":"205"},"1129d1ef33e52","eb9be846f5945","DuplicateApiKey",{"message":"162","status":401},"Duplicate API key found","94889a341f816","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","256bfe47d4e2c","NoAPIKey",{"message":"206","status":401},"No API key found",{"type":"185"},{"type":"100"},"status","message","470b68e5f0549","4ffd8ecbd3d1a",{"message":"44"},{"message":"207"},{"type":"100","description":"208","examples":"209"},"dc08f780c8868",["210","211"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["212"],"integer","Unix epoch when the resource was created.",["100","213"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["100","213"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["100","213"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["214"],"The configuration properties for the plugin",{"hour":"215","minute":"216"},"array","A list of the request protocols that will trigger this plugin.",{"type":"100","enum":"217","default":"119"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"100"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"218"},"No API key found in request","Not found","404 Not Found",["44"],{"id":"219","name":"212","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"220","protocols":"221","enabled":true,"tags":"222","ordering":"223"},{"id":"224","name":"212","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"225","protocols":"226","enabled":true,"tags":"227","ordering":"228"},"rate-limiting","null","rate-limiting-foo",{"type":"185","examples":"229"},{"type":"185","examples":"230"},["119","231","232","233","234"],{"type":"197","items":"235"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["119","142"],["236","237"],{"before":"238"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["234","233"],["239","240","241"],{"after":"242"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"100"},"user-level","low-priority",["243"],"admin","high-priority","critical",["243"],"plugin-name"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-plugin-with-consumer-group_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a plugin associated with a consumer group",["18"],"e41030a5eae90","patch","/{workspace}/consumer_groups/{consumer_group_name_or_id}/plugins/{plugin_id}",["19"],{},"update-plugin-with-consumer-group_with_workspace","Update a plugin associated with a consumer group using the consumergroup name or ID.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"Plugins",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55","56","57"],["58"],{"id":"59","url":"60","name":"61","description":"62","variables":"63"},"c26fb55b0a58f","6207b5bd18aab","200",[],["64"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","c227b799e87b3","400",[],["65"],"Invalid plugin","c237b799e8904","401",[],["66"],"Unauthorized","c1e7b799e8087","404",[],[],"Resource does not exist","660545d5beb59",["67"],"Plugin request body",{"id":"68","name":"69","style":"70","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","name":"76","style":"70","examples":"77","description":"78","required":true,"schema":"79","explicitProperties":"80"},{"id":"81","name":"82","style":"70","examples":"83","description":"84","required":true,"schema":"85","explicitProperties":"86"},{"id":"87","key":"88","extensions":"89","description":"90","type":"91","name":"92","in":"93"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"94","path":"95","port":"96","protocol":"97"},{"id":"98","mediaType":"99","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"99","examples":"104","encodings":"105","schema":"106"},{"id":"107","mediaType":"99","examples":"108","encodings":"109","schema":"110"},{"id":"111","mediaType":"99","examples":"112","encodings":"113","schema":"114"},"7253ca3e78930","workspace","simple",[],"Name or ID of workspace",{"type":"115","examples":"116","$schema":"117","x-stoplight":"118"},["119","120","121","122","123","124"],"8c5c0aae48677","consumer_group_name_or_id",[],"The name or UUID of the consumer group to remove.",{"type":"115","$schema":"117","x-stoplight":"125"},["119","120","121","122","123","124"],"07dce6ce60a67","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"115","examples":"126","$schema":"117","x-stoplight":"127"},["119","120","121","122","123","124"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"128","description":"129"},{"default":"130","description":"131"},{"default":"132","description":"133"},{"default":"134","description":"135","enum":"136"},"826e815a4dfce","application/json",["137"],[],{"type":"138","properties":"139","$schema":"117","x-stoplight":"140"},"430d427895a84",[],[],{"type":"138","$schema":"117","x-stoplight":"141"},"ab6a922084e32",["142","143","144"],[],{"type":"138","properties":"145","required":"146","title":"147","$schema":"117","x-stoplight":"148"},"797e7eaeddfcc",["149"],[],{"type":"138","x-examples":"150","properties":"151","$schema":"117","x-stoplight":"152"},"string",["153"],"http://json-schema.org/draft-07/schema#",{"id":"154"},"name","in","required","schema","description","title",{"id":"155"},["156"],{"id":"157"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["134","158"],{"id":"159","key":"160","value":"161"},"object",{"id":"162","name":"163","created_at":"164","route":"165","service":"166","consumer":"167","instance_name":"168","config":"169","protocols":"170","enabled":"171","tags":"172","ordering":"173"},{"id":"174"},{"id":"175"},{"id":"176","key":"177","value":"178","summary":"179"},{"id":"180","key":"181","value":"182","summary":"183"},{"id":"184","key":"185","value":"186","summary":"187"},{"status":"188","message":"189"},["190","191"],"UnauthorizedError",{"id":"192"},{"id":"193","key":"194","value":"195"},{"Example 1":"196"},{"name":"197","route":"198","service":"199","consumer":"200","instance_name":"201","config":"202","protocols":"203","enabled":"204","tags":"205","ordering":"206"},{"id":"207"},"team-a","ae60f7d470699","d15ea74400072","response-ratelimiting","6a14c6c386e14","https","1685c1409c861","Plugin response",{"data":"208","next":"209"},{"type":"115"},{"type":"115","description":"210","examples":"211"},{"type":"212","description":"213"},{"type":"214","description":"215"},{"type":"216","description":"217"},{"type":"218","description":"219"},{"type":"115","description":"220","examples":"221"},{"type":"138","description":"222","properties":"223"},{"type":"224","description":"225","items":"226"},{"type":"227","description":"228","default":true},{"type":"224","description":"229","items":"230"},{"type":"138","description":"231","properties":"232"},"1129d1ef33e52","2ab42628290f7","4aae7600f90e8","DuplicateApiKey",{"message":"179","status":401},"Duplicate API key found","c50ff0680ba12","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","b6b729de65190","NoAPIKey",{"message":"233","status":401},"No API key found",{"type":"212"},{"type":"115"},"status","message","470b68e5f0549","40e632c6f0208","request example",{"name":"234","route":"115","service":"115","consumer":"115","instance_name":"235","config":"236","protocols":"237","enabled":true,"tags":"238","ordering":"239"},{"name":"234","route":null,"service":null,"consumer":null,"instance_name":"235","config":"240","protocols":"241","enabled":true,"tags":"242","ordering":"243"},{"type":"115","description":"244","examples":"245"},{"type":"246","description":"247"},{"type":"248","description":"217"},{"type":"249","description":"219"},{"type":"115","description":"220","examples":"250"},{"type":"138","description":"222","properties":"251"},{"type":"224","description":"225","items":"252"},{"type":"227","description":"228","default":true},{"type":"224","description":"229","items":"253"},{"type":"138","description":"231","properties":"254"},"7a1b17d9c7f1c",["255","256"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["234"],"integer","Unix epoch when the resource was created.",["115","257"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["115","257"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["115","257"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["235"],"The configuration properties for the plugin",{"hour":"258","minute":"259"},"array","A list of the request protocols that will trigger this plugin.",{"type":"115","enum":"260","default":"134"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"115"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"261"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["134"],["115"],{"before":"262"},{"hour":500,"minute":20},["134","158"],["263","264"],{"before":"265"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["234"],["115","257"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["115","257"],["115","257"],["235"],{"hour":"266","minute":"267"},{"type":"115","enum":"268","default":"134"},{"type":"115"},{"before":"269"},{"id":"270","name":"234","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"271","protocols":"272","enabled":true,"tags":"273","ordering":"274"},{"id":"275","name":"234","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"276","protocols":"277","enabled":true,"tags":"278","ordering":"279"},"null",{"type":"212","examples":"280"},{"type":"212","examples":"281"},["134","282","283","284","285"],{"type":"224","items":"286"},["115"],"user-level","low-priority",["287"],{"type":"212","examples":"288"},{"type":"212","examples":"289"},["134","282","283","284","285"],{"type":"224","items":"290"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["134","158"],["263","264"],{"before":"291"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["285","284"],["292","293","294"],{"after":"295"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"115"},"plugin-name",[500],[500],{"type":"115"},["287"],"admin","high-priority","critical",["287"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-plugin-for-customer-group_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a plugin associated with a Consumer Group",["18"],"c9b17c6cc71da","put","/{workspace}/consumer_groups/{consumer_group_name_or_id}/plugins/{plugin_id}",["19"],{},"upsert-plugin-for-customer-group_with_workspace","Create or Update a plugin associated with a Consumer Group using ID.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Plugins",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50","51"],["52"],{"id":"53","url":"54","name":"55","description":"56","variables":"57"},"c26fb55b0a58f","0a1efb3fd6c11","200",[],["58"],"A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.","9f7efbd1460c0","400",[],["59"],"Invalid plugin","9f6efbd146e13","401",[],["60"],"Unauthorized","09ad663b4ae5b",["61"],"Plugin request body",{"id":"62","name":"63","style":"64","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"64","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","name":"76","style":"64","examples":"77","description":"78","required":true,"schema":"79","explicitProperties":"80"},{"id":"81","key":"82","extensions":"83","description":"84","type":"85","name":"86","in":"87"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"88","path":"89","port":"90","protocol":"91"},{"id":"92","mediaType":"93","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"93","examples":"98","encodings":"99","schema":"100"},{"id":"101","mediaType":"93","examples":"102","encodings":"103","schema":"104"},{"id":"105","mediaType":"93","examples":"106","encodings":"107","schema":"108"},"e61fbbeac46b4","workspace","simple",[],"Name or ID of workspace",{"type":"109","examples":"110","$schema":"111","x-stoplight":"112"},["113","114","115","116","117","118"],"1694bec6bf1d9","consumer_group_name_or_id",[],"The name or UUID of the consumer group to remove.",{"type":"109","$schema":"111","x-stoplight":"119"},["113","114","115","116","117","118"],"a56b91ea6cb99","plugin_id",[],"The unique identifier of the plugin to create or update.",{"type":"109","examples":"120","$schema":"111","x-stoplight":"121"},["113","114","115","116","117","118"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"122","description":"123"},{"default":"124","description":"125"},{"default":"126","description":"127"},{"default":"128","description":"129","enum":"130"},"650d23a15ab23","application/json",["131"],[],{"type":"132","properties":"133","$schema":"111","x-stoplight":"134"},"86e0a0e453304",[],[],{"type":"132","$schema":"111","x-stoplight":"135"},"4f08c2375339b",["136","137","138"],[],{"type":"132","properties":"139","required":"140","title":"141","$schema":"111","x-stoplight":"142"},"4d4f94cb66f1e",["143"],[],{"type":"132","x-examples":"144","properties":"145","$schema":"111","x-stoplight":"146"},"string",["147"],"http://json-schema.org/draft-07/schema#",{"id":"148"},"name","in","required","schema","description","title",{"id":"149"},["150"],{"id":"151"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["128","152"],{"id":"153","key":"154","value":"155"},"object",{"id":"156","name":"157","created_at":"158","route":"159","service":"160","consumer":"161","instance_name":"162","config":"163","protocols":"164","enabled":"165","tags":"166","ordering":"167"},{"id":"168"},{"id":"169"},{"id":"170","key":"171","value":"172","summary":"173"},{"id":"174","key":"175","value":"176","summary":"177"},{"id":"178","key":"179","value":"180","summary":"181"},{"status":"182","message":"183"},["184","185"],"UnauthorizedError",{"id":"186"},{"id":"187","key":"188","value":"189"},{"Example 1":"190"},{"name":"191","route":"192","service":"193","consumer":"194","instance_name":"195","config":"196","protocols":"197","enabled":"198","tags":"199","ordering":"200"},{"id":"201"},"team-a","da7ae6529eb61","56c9e86772063","response-ratelimiting","7e6ced6c17e48","https","cbc11dfcfb2d8","Plugin response",{"data":"202","next":"203"},{"type":"109"},{"type":"109","description":"204","examples":"205"},{"type":"206","description":"207"},{"type":"208","description":"209"},{"type":"210","description":"211"},{"type":"212","description":"213"},{"type":"109","description":"214","examples":"215"},{"type":"132","description":"216","properties":"217"},{"type":"218","description":"219","items":"220"},{"type":"221","description":"222","default":true},{"type":"218","description":"223","items":"224"},{"type":"132","description":"225","properties":"226"},"1129d1ef33e52","66d00d50715d3","7ce43622aa5e1","DuplicateApiKey",{"message":"173","status":401},"Duplicate API key found","550c5e2562f2c","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","b7a154e322624","NoAPIKey",{"message":"227","status":401},"No API key found",{"type":"206"},{"type":"109"},"status","message","470b68e5f0549","1424af0e9079d","request example",{"name":"228","route":"109","service":"109","consumer":"109","instance_name":"229","config":"230","protocols":"231","enabled":true,"tags":"232","ordering":"233"},{"name":"228","route":null,"service":null,"consumer":null,"instance_name":"229","config":"234","protocols":"235","enabled":true,"tags":"236","ordering":"237"},{"type":"109","description":"238","examples":"239"},{"type":"240","description":"241"},{"type":"242","description":"211"},{"type":"243","description":"213"},{"type":"109","description":"214","examples":"244"},{"type":"132","description":"216","properties":"245"},{"type":"218","description":"219","items":"246"},{"type":"221","description":"222","default":true},{"type":"218","description":"223","items":"247"},{"type":"132","description":"225","properties":"248"},"7a1b17d9c7f1c",["249","250"],"http://localhost:8001/plugins?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","The name of the plugin thats going to be added. Currently, the plugin must be installed in every Kong instance separately.",["228"],"integer","Unix epoch when the resource was created.",["109","251"],"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. Default, `null`.With form-encoded, the notation is `route.id=<route id>` or `route.name=<route name>`. With JSON, use `route:{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["109","251"],"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.",["109","251"],"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.)","An optional custom name to identify an instance of the plugin, for example `basic-auth_example-service`.\n\nThe instance name shows up in Kong Manager, so it's useful when running the same \nplugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance\nvia the Kong Admin API.\n\nAn instance name must be unique within a workspace for Kong Gateway Enterprise.\n",["229"],"The configuration properties for the plugin",{"hour":"252","minute":"253"},"array","A list of the request protocols that will trigger this plugin.",{"type":"109","enum":"254","default":"128"},"boolean","Whether the plugin is applied. Default: `true`.\n","An optional set of strings associated with the plugin for grouping and filtering.\n",{"type":"109"},"Describes a dependency to another plugin to determine plugin ordering during the access phase.\n- `before`: The plugin will be executed before a specified plugin or list of plugins.\n- `after`: The plugin will be executed after a specified plugin or list of plugins.\n",{"before":"255"},"No API key found in request","rate-limiting","rate-limiting-foo",{"hour":500,"minute":500},["128"],["109"],{"before":"256"},{"hour":500,"minute":20},["128","152"],["257","258"],{"before":"259"},"The name of the plugin that's being added. The plugin must be installed in every Kong instance separately.",["228"],["109","251"],"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. Default `null`.With form-encoded, the notation is `route.id=<route id> or route.name=<route name>`. With JSON, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.",["109","251"],["109","251"],["229"],{"hour":"260","minute":"261"},{"type":"109","enum":"262","default":"128"},{"type":"109"},{"before":"263"},{"id":"264","name":"228","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"265","protocols":"266","enabled":true,"tags":"267","ordering":"268"},{"id":"269","name":"228","created_at":1422386534,"route":null,"service":null,"consumer":null,"config":"270","protocols":"271","enabled":true,"tags":"272","ordering":"273"},"null",{"type":"206","examples":"274"},{"type":"206","examples":"275"},["128","276","277","278","279"],{"type":"218","items":"280"},["109"],"user-level","low-priority",["281"],{"type":"206","examples":"282"},{"type":"206","examples":"283"},["128","276","277","278","279"],{"type":"218","items":"284"},"02621eee-8309-4bf6-b36b-a82017a5393e",{"hour":500,"minute":20},["128","152"],["257","258"],{"before":"285"},"66c7b5c4-4aaf-4119-af1e-ee3ad75d0af4",{"hour":500,"minute":20},["279","278"],["286","287","288"],{"after":"289"},[500],[500],"grpc","grpcs","tls","tcp",{"type":"109"},"plugin-name",[500],[500],{"type":"109"},["281"],"admin","high-priority","critical",["281"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-consumer",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all Consumers",["18"],"bb7fa559579e6","get","/consumers",["19"],{},"list-consumer","Retrieve a list of all consumers.You can use query parameters to filter the results by size or tags, for example `/consumers?size=50&tags=enterprise`.","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Consumers",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],["33","34","35"],[],[],["36"],{"id":"37","url":"38","name":"39","description":"40","variables":"41"},"214156776b4c7","34ad05f7c11f2","200",[],["42"],"A consumer response object",{"id":"43","name":"44","style":"45","examples":"46","description":"47","schema":"48","explicitProperties":"49"},{"id":"50","name":"51","style":"45","examples":"52","description":"53","schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"45","examples":"58","description":"59","schema":"60","explicitProperties":"61"},{"id":"62","key":"63","extensions":"64","description":"65","type":"66","name":"67","in":"68"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"69","path":"70","port":"71","protocol":"72"},{"id":"73","mediaType":"74","examples":"75","encodings":"76","schema":"77"},"84a99770be729","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"78","$schema":"79","x-stoplight":"80"},["81","82","83","84","85"],"9975f1e3ae70a","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"86","$schema":"79","x-stoplight":"87"},["81","82","83","84","85"],"a5c93b1eb77e6","tags",["88"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"86","examples":"89","x-stoplight":"90","$schema":"79"},["81","91","82","83","84","85"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"92","description":"93"},{"default":"94","description":"95"},{"default":"96","description":"97"},{"default":"98","description":"99","enum":"100"},"94b8a12955fb3","application/json",[],[],{"type":"101","properties":"102","x-examples":"103","$schema":"79","x-stoplight":"104"},"integer","http://json-schema.org/draft-07/schema#",{"id":"105"},"description","in","name","schema","title","string",{"id":"106"},{"id":"107","value":"108","key":"109"},["108"],{"explicitProperties":"110","id":"111"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["98","112"],"object",{"data":"113","next":"114"},{"Example 1":"115","One consumer":"116","Multiple consumers":"117"},{"id":"118"},"b3e4fa9818b2f","39e7a28ba3965","2a2c4581979cd","tag1,tag2","default",["119","120","121"],"fa425dc591ac2","https",{"type":"122","description":"123","items":"124"},{"type":"86","description":"125","examples":"126"},{"data":"127","next":null},{"data":"128","next":null},{"data":"129","next":null},"ab70985368bb5","type","nullable","examples","array","The data array contains consumer objects",{"type":"101","properties":"130"},"Link to the next page of results, if applicable",[null],["131","132","133"],["134"],["135","136","137"],{"created_at":"138","custom_id":"139","id":"140","tags":"141","type":"142","updated_at":"143","username":"144","username_lower":"145"},{"created_at":1719859293,"custom_id":"146","id":"147","tags":null,"type":0,"updated_at":1719859293,"username":"148","username_lower":"148"},{"created_at":1719858943,"custom_id":"149","id":"150","tags":null,"type":0,"updated_at":1719858943,"username":"151","username_lower":"151"},{"created_at":1719858965,"custom_id":"152","id":"153","tags":null,"type":0,"updated_at":1719858965,"username":"154","username_lower":"154"},{"created_at":1719859293,"custom_id":"146","id":"147","tags":null,"type":0,"updated_at":1719859293,"username":"148","username_lower":"148"},{"created_at":1719859293,"custom_id":"146","id":"147","tags":null,"type":0,"updated_at":1719859293,"username":"148","username_lower":"148"},{"created_at":1719858943,"custom_id":"149","id":"150","tags":null,"type":0,"updated_at":1719858943,"username":"151","username_lower":"151"},{"created_at":1719858965,"custom_id":"152","id":"153","tags":null,"type":0,"updated_at":1719858965,"username":"154","username_lower":"154"},{"type":"78","description":"155","examples":"156"},{"type":"86","description":"157","examples":"158"},{"type":"86","description":"159","examples":"160"},{"type":"122","description":"161","items":"162"},{"type":"78","default":0,"examples":"163"},{"type":"78","description":"164","examples":"165"},{"type":"86","description":"166","examples":"167"},{"type":"86","description":"168","examples":"169"},"consumer_id3","1cf590ba-4b23-46fa-9e8d-4296213e2ac6","consumer3","consumer_id","73b74f15-5185-4b16-a2fc-3c2fd834ba6c","consumer","consumer_id2","f9383372-7bf4-4275-8bbc-4f89d7a38a23","consumer2","Unix epoch when the resource was created.",[1719859293],"Custom ID of the consumer",["146"],"The consumer ID",["147"],"Tags associated with the consumer",{"type":"86","examples":"170"},[0],"Unix epoch when the resource was last updated.",[1719859293],"The username of the consumer",["148"],"Lowercase representation of the consumer username.",["148"],["171"],"test"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-consumer",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new Consumer",["17"],"30d71159766bd","post","/consumers",["18"],{},"create-consumer","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Consumers",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],[],["54"],{"id":"55","url":"56","name":"57","description":"58","variables":"59"},"214156776b4c7","00d5a3d914262","201",[],["60"],"A consumer response object","d8a5a2136a37b","400",[],["61"],"Invalid Consumer","d8b5a2136a1c8","401",[],["62"],"Unauthorized","d835a2136af50","409",[],["63"],"Conflict","2116b8f43d09d",["64"],"Consumer request body",{"id":"65","key":"66","extensions":"67","description":"68","type":"69","name":"70","in":"71"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"72","path":"73","port":"74","protocol":"75"},{"id":"76","mediaType":"77","examples":"78","encodings":"79","schema":"80"},{"id":"81","mediaType":"77","examples":"82","encodings":"83","schema":"84"},{"id":"85","mediaType":"77","examples":"86","encodings":"87","schema":"88"},{"id":"89","mediaType":"77","examples":"90","encodings":"91","schema":"92"},{"id":"93","mediaType":"77","examples":"94","encodings":"95","schema":"96"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"97","description":"98"},{"default":"99","description":"100"},{"default":"101","description":"102"},{"default":"103","description":"104","enum":"105"},"b0c05bdc340fd","application/json",[],[],{"type":"106","properties":"107","x-examples":"108","$schema":"109","x-stoplight":"110"},"880e2f1763757",[],[],{"type":"106","$schema":"109","x-stoplight":"111"},"752f43cd11132",["112","113","114"],[],{"type":"106","properties":"115","required":"116","title":"117","$schema":"109","x-stoplight":"118"},"242ba13f174c7",["119"],[],{"type":"106","x-examples":"120","properties":"121","$schema":"109","x-stoplight":"122"},"a5a2a8c96a027",[],[],{"type":"106","x-examples":"123","properties":"124","required":"125","$schema":"109","x-stoplight":"126"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["103","127"],"object",{"data":"128","next":"129"},{"Example 1":"130","One consumer":"131","Multiple consumers":"132"},"http://json-schema.org/draft-07/schema#",{"id":"133"},{"id":"134"},{"id":"135","key":"136","value":"137","summary":"138"},{"id":"139","key":"140","value":"141","summary":"142"},{"id":"143","key":"144","value":"145","summary":"146"},{"status":"147","message":"148"},["149","150"],"UnauthorizedError",{"id":"151"},{"id":"152","key":"153","value":"154"},{"Example 1":"155"},{"fields":"156","message":"157","name":"158","code":"159"},{"id":"160"},{"Example 1":"161"},{"username":"162","custom_id":"163","tags":"164"},["165","166"],{"id":"167"},"https",{"type":"168","description":"169","items":"170"},{"type":"171","description":"172","examples":"173"},{"data":"174","next":null},{"data":"175","next":null},{"data":"176","next":null},"ab70985368bb5","2a599497e5836","2d0b83a83a509","DuplicateApiKey",{"message":"138","status":401},"Duplicate API key found","0cd373fbc171b","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","f581b2187eff8","NoAPIKey",{"message":"177","status":401},"No API key found",{"type":"178"},{"type":"171"},"status","message","470b68e5f0549","7626370dac369","Constraint violation",{"fields":"179","message":"180","name":"181","code":5},{"fields":"182","message":"180","name":"181","code":5},{"type":"106","description":"183","properties":"184"},{"type":"171","description":"185","examples":"186"},{"type":"171","description":"187","examples":"188"},{"type":"178","description":"189","examples":"190"},"a52dba3ed8462",{"id":"191","created_at":1422386534,"username":"192","custom_id":"193","tags":"194"},{"type":"171","description":"195"},{"type":"171","description":"196"},{"type":"168","description":"197","items":"198"},"username","custom_id","e53872e9d0579","array","The data array contains consumer objects",{"type":"106","properties":"199"},"string","Link to the next page of results, if applicable",[null],["200","201","202"],["203"],["204","205","206"],"No API key found in request","integer",{"username":"207"},"UNIQUE violation detected on `{username=\"stri22ng\"}`","unique constraint violation",{"username":"207"},"An array of fields that may have caused the error.",{"username":"208"},"Detail about the conflict.",["209"],"THe name of the violation.",["181"],"Error code for debugging purposes.",[5],"ec1a1f6f-2aa4-4e58-93ff-b56368f19b27","my-username","my-custom-id",["210","211"],"The unique username of the Consumer. You must send either this field or custom_id with the request.\n","Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or username with the request.\n","An optional set of strings associated with the Consumer for grouping and filtering.\n",{"type":"171"},{"created_at":"212","custom_id":"213","id":"214","tags":"215","type":"216","updated_at":"217","username":"218","username_lower":"219"},{"created_at":1719859293,"custom_id":"220","id":"221","tags":null,"type":0,"updated_at":1719859293,"username":"222","username_lower":"222"},{"created_at":1719858943,"custom_id":"223","id":"224","tags":null,"type":0,"updated_at":1719858943,"username":"225","username_lower":"225"},{"created_at":1719858965,"custom_id":"226","id":"227","tags":null,"type":0,"updated_at":1719858965,"username":"228","username_lower":"228"},{"created_at":1719859293,"custom_id":"220","id":"221","tags":null,"type":0,"updated_at":1719859293,"username":"222","username_lower":"222"},{"created_at":1719859293,"custom_id":"220","id":"221","tags":null,"type":0,"updated_at":1719859293,"username":"222","username_lower":"222"},{"created_at":1719858943,"custom_id":"223","id":"224","tags":null,"type":0,"updated_at":1719858943,"username":"225","username_lower":"225"},{"created_at":1719858965,"custom_id":"226","id":"227","tags":null,"type":0,"updated_at":1719858965,"username":"228","username_lower":"228"},"stri22ng",{"type":"171","description":"229","examples":"230"},"UNIQUE violation detected on `{username=\\\"stri22ng\\\"}`","user-level","low-priority",{"type":"178","description":"231","examples":"232"},{"type":"171","description":"233","examples":"234"},{"type":"171","description":"235","examples":"236"},{"type":"168","description":"237","items":"238"},{"type":"178","default":0,"examples":"239"},{"type":"178","description":"240","examples":"241"},{"type":"171","description":"242","examples":"243"},{"type":"171","description":"244","examples":"245"},"consumer_id3","1cf590ba-4b23-46fa-9e8d-4296213e2ac6","consumer3","consumer_id","73b74f15-5185-4b16-a2fc-3c2fd834ba6c","consumer","consumer_id2","f9383372-7bf4-4275-8bbc-4f89d7a38a23","consumer2","The username that triggerd the conflict.",["207"],"Unix epoch when the resource was created.",[1719859293],"Custom ID of the consumer",["220"],"The consumer ID",["221"],"Tags associated with the consumer",{"type":"171","examples":"246"},[0],"Unix epoch when the resource was last updated.",[1719859293],"The username of the consumer",["222"],"Lowercase representation of the consumer username.",["222"],["247"],"test"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-consumer",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a Consumer",["17"],"d91e0e3f0c1d6","delete","/consumers/{consumer_username_or_id}",["18"],{},"delete-consumer","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Consumers",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38"],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"214156776b4c7","4e156ce732570","204",[],[],"Successfully deleted Consumer or the resource didn't exist","a6056ec3f4177","401",[],["45"],"Unauthorized",{"id":"46","name":"47","style":"48","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},{"id":"64","mediaType":"65","examples":"66","encodings":"67","schema":"68"},"0dd2b87e80929","consumer_username_or_id","simple",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"69","examples":"70","$schema":"71","x-stoplight":"72"},["73","74","75","76","77","78"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86","enum":"87"},"ecdc726b50bf0","application/json",["88","89","90"],[],{"type":"91","properties":"92","required":"93","title":"94","$schema":"71","x-stoplight":"95"},"string",["96"],"http://json-schema.org/draft-07/schema#",{"id":"97"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["85","98"],{"id":"99","key":"100","value":"101","summary":"102"},{"id":"103","key":"104","value":"105","summary":"106"},{"id":"107","key":"108","value":"109","summary":"110"},"object",{"status":"111","message":"112"},["113","114"],"UnauthorizedError",{"id":"115"},"my-username","315fba5d9087b","https","9bd54b59afd1d","DuplicateApiKey",{"message":"102","status":401},"Duplicate API key found","cf7d31235a72c","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","c67dbf0fe0243","NoAPIKey",{"message":"116","status":401},"No API key found",{"type":"117"},{"type":"69"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-consumer",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a consumer",["18"],"c28e3b791937d","get","/consumers/{consumer_username_or_id}",["19"],{},"get-consumer","Retrieve the details of a specific consumer in the system using either the consumer ID or the consumer username. If the consumer with the specified ID or username cannot be found, the endpoint will return a 404.\n","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Consumers",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45"],["46"],{"id":"47","url":"48","name":"49","description":"50","variables":"51"},"214156776b4c7","e35cc8b67f0c3","200",[],["52"],"A consumer response object","834cc6d9afe88","401",[],["53"],"Unauthorized","837cc6d9b05f7","404",[],[],"Resource does not exist",{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},{"id":"77","mediaType":"73","examples":"78","encodings":"79","schema":"80"},"5075c1f1c7fb6","consumer_username_or_id","simple",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"81","examples":"82","$schema":"83","x-stoplight":"84"},["85","86","87","88","89","90"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"3b628e0d0ed77","application/json",[],[],{"type":"100","properties":"101","x-examples":"102","$schema":"83","x-stoplight":"103"},"b481395720843",["104","105","106"],[],{"type":"100","properties":"107","required":"108","title":"109","$schema":"83","x-stoplight":"110"},"string",["111"],"http://json-schema.org/draft-07/schema#",{"id":"112"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","113"],"object",{"data":"114","next":"115"},{"Example 1":"116","One consumer":"117","Multiple consumers":"118"},{"id":"119"},{"id":"120","key":"121","value":"122","summary":"123"},{"id":"124","key":"125","value":"126","summary":"127"},{"id":"128","key":"129","value":"130","summary":"131"},{"status":"132","message":"133"},["134","135"],"UnauthorizedError",{"id":"136"},"my-username","ccb0c35690fab","https",{"type":"137","description":"138","items":"139"},{"type":"81","description":"140","examples":"141"},{"data":"142","next":null},{"data":"143","next":null},{"data":"144","next":null},"ab70985368bb5","660d596f11265","DuplicateApiKey",{"message":"123","status":401},"Duplicate API key found","914e3c9913df2","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","68dc720929ea2","NoAPIKey",{"message":"145","status":401},"No API key found",{"type":"146"},{"type":"81"},"status","message","470b68e5f0549","array","The data array contains consumer objects",{"type":"100","properties":"147"},"Link to the next page of results, if applicable",[null],["148","149","150"],["151"],["152","153","154"],"No API key found in request","integer",{"created_at":"155","custom_id":"156","id":"157","tags":"158","type":"159","updated_at":"160","username":"161","username_lower":"162"},{"created_at":1719859293,"custom_id":"163","id":"164","tags":null,"type":0,"updated_at":1719859293,"username":"165","username_lower":"165"},{"created_at":1719858943,"custom_id":"166","id":"167","tags":null,"type":0,"updated_at":1719858943,"username":"168","username_lower":"168"},{"created_at":1719858965,"custom_id":"169","id":"170","tags":null,"type":0,"updated_at":1719858965,"username":"171","username_lower":"171"},{"created_at":1719859293,"custom_id":"163","id":"164","tags":null,"type":0,"updated_at":1719859293,"username":"165","username_lower":"165"},{"created_at":1719859293,"custom_id":"163","id":"164","tags":null,"type":0,"updated_at":1719859293,"username":"165","username_lower":"165"},{"created_at":1719858943,"custom_id":"166","id":"167","tags":null,"type":0,"updated_at":1719858943,"username":"168","username_lower":"168"},{"created_at":1719858965,"custom_id":"169","id":"170","tags":null,"type":0,"updated_at":1719858965,"username":"171","username_lower":"171"},{"type":"146","description":"172","examples":"173"},{"type":"81","description":"174","examples":"175"},{"type":"81","description":"176","examples":"177"},{"type":"137","description":"178","items":"179"},{"type":"146","default":0,"examples":"180"},{"type":"146","description":"181","examples":"182"},{"type":"81","description":"183","examples":"184"},{"type":"81","description":"185","examples":"186"},"consumer_id3","1cf590ba-4b23-46fa-9e8d-4296213e2ac6","consumer3","consumer_id","73b74f15-5185-4b16-a2fc-3c2fd834ba6c","consumer","consumer_id2","f9383372-7bf4-4275-8bbc-4f89d7a38a23","consumer2","Unix epoch when the resource was created.",[1719859293],"Custom ID of the consumer",["163"],"The consumer ID",["164"],"Tags associated with the consumer",{"type":"81","examples":"187"},[0],"Unix epoch when the resource was last updated.",[1719859293],"The username of the consumer",["165"],"Lowercase representation of the consumer username.",["165"],["188"],"test"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-consumer",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a Consumer",["18"],"e2a7fc9228e38","patch","/consumers/{consumer_username_or_id}",["19"],{},"update-consumer","Update the details of a specific consumer in the system using either the consumer ID or the consumer username.If the consumer with the specified ID or username cannot be found, the endpoint will return a 404.\n","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"Consumers",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55"],["56"],{"id":"57","url":"58","name":"59","description":"60","variables":"61"},"214156776b4c7","977b8064f943e","200",[],["62"],"Successfully updated Consumer","ef9b8241bb1a6","400",[],["63"],"Invalid Consumer","efab8241bb3f1","401",[],["64"],"Unauthorized","ef5b8241bbb72","404",[],[],"Resource does not exist","0808887e5dcf4",["65"],"Consumer request body",{"id":"66","name":"67","style":"68","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","key":"74","extensions":"75","description":"76","type":"77","name":"78","in":"79"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"80","path":"81","port":"82","protocol":"83"},{"id":"84","mediaType":"85","examples":"86","encodings":"87","schema":"88"},{"id":"89","mediaType":"85","examples":"90","encodings":"91","schema":"92"},{"id":"93","mediaType":"85","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"85","examples":"98","encodings":"99","schema":"100"},"ded518ef5a603","consumer_username_or_id","simple",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"101","examples":"102","$schema":"103","x-stoplight":"104"},["105","106","107","108","109","110"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"111","description":"112"},{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118","enum":"119"},"8b34f65e0cbf0","application/json",["120"],[],{"description":"121","properties":"122","type":"123","x-examples":"124","title":"125","examples":"126","$schema":"103","x-stoplight":"127"},"d0ab813288f6a",[],[],{"type":"123","$schema":"103","x-stoplight":"128"},"662edd6228b5b",["129","130","131"],[],{"type":"123","properties":"132","required":"133","title":"134","$schema":"103","x-stoplight":"135"},"04fbdcd686167",[],[],{"type":"123","x-examples":"136","properties":"137","required":"138","$schema":"103","x-stoplight":"139"},"string",["140"],"http://json-schema.org/draft-07/schema#",{"id":"141"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["117","142"],{"id":"143","value":"144","key":"145"},"The Consumer object represents a consumer - or a user - of a Service. You can either rely on Kong as the primary datastore, or you can map the consumer list with your database to keep consistency between Kong and your existing primary datastore.",{"created_at":"146","custom_id":"147","id":"148","tags":"149","updated_at":"150","username":"151"},"object",{"Consumer Object":"152"},"Consumer",["144"],{"id":"153"},{"id":"154"},{"id":"155","key":"156","value":"157","summary":"158"},{"id":"159","key":"160","value":"161","summary":"162"},{"id":"163","key":"164","value":"165","summary":"166"},{"status":"167","message":"168"},["169","170"],"UnauthorizedError",{"id":"171"},{"Example 1":"172"},{"username":"173","custom_id":"174","tags":"175"},["176","177"],{"id":"178"},"my-username","10c186909f53a","https","63f4339a94c97",{"custom_id":"179","id":"180","tags":"181","username":"182"},"default",{"description":"183","type":"184"},{"description":"185","type":"101"},{"type":"101"},{"description":"186","items":"187","type":"188"},{"description":"189","type":"184"},{"description":"190","type":"101"},{"custom_id":"179","id":"191","tags":"192","username":"182"},"595f1bbb7cde7","3846722ff3ce4","f897cb201f295","DuplicateApiKey",{"message":"158","status":401},"Duplicate API key found","1de644ab1e304","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","9b3d0c56d387d","NoAPIKey",{"message":"193","status":401},"No API key found",{"type":"184"},{"type":"101"},"status","message","470b68e5f0549",{"id":"194","created_at":1422386534,"username":"140","custom_id":"195","tags":"196"},{"type":"101","description":"197"},{"type":"101","description":"198"},{"type":"188","description":"199","items":"200"},"username","custom_id","e53872e9d0579","4200","8a388226-20e8-4027-a486-25e4f7db5d21",["201"],"bob-the-builder","Unix epoch when the resource was created.","integer","Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or `username` with the request.","An optional set of strings associated with the Consumer for grouping and filtering.",{"type":"101"},"array","Unix epoch when the resource was last updated.","The unique username of the Consumer. You must send either this field or `custom_id` with the request.","8a388226-80e8-4027-a486-25e4f7db5d21",["201"],"No API key found in request","ec1a1f6f-2aa4-4e58-93ff-b56368f19b27","my-custom-id",["202","203"],"The unique username of the Consumer. You must send either this field or custom_id with the request.\n","Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or username with the request.\n","An optional set of strings associated with the Consumer for grouping and filtering.\n",{"type":"101"},"silver-tier","user-level","low-priority"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-consumer",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a Consumer",["18"],"46e4c2c2bd6b5","put","/consumers/{consumer_username_or_id}",["19"],{},"upsert-consumer","Create or Update Consumer using ID or username. The consumer will be identified via the username or id attribute.If the consumer with the specified ID or username cannot be found, the endpoint will return a 404.\n\nWhen the username or id attribute has the structure of a UUID, the Consumer being inserted/replaced will be identified by its id. Otherwise it will be identified by its username.\n\nWhen creating a new Consumer without specifying id (neither in the URL nor in the body), then it will be auto-generated.\n\nNotice that specifying a username in the URL and a different one in the request body is not allowed.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Consumers",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"214156776b4c7","63a406a0dcbe6","200",[],["56"],"Successfully upserted Consumer","ce44060f6cd88","400",[],["57"],"Invalid Consumer","ce34060f6cb47","401",[],["58"],"Unauthorized","35aba43f95c2a",["59"],"Consumer request body",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"79","examples":"84","encodings":"85","schema":"86"},{"id":"87","mediaType":"79","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"79","examples":"92","encodings":"93","schema":"94"},"ceb5dfe1bc8c0","consumer_username_or_id","simple",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110"},{"default":"111","description":"112","enum":"113"},"2ae3b59aca266","application/json",["114"],[],{"description":"115","properties":"116","type":"117","x-examples":"118","title":"119","examples":"120","$schema":"97","x-stoplight":"121"},"1e165d9749b71",[],[],{"type":"117","$schema":"97","x-stoplight":"122"},"e2a48effc3362",["123","124","125"],[],{"type":"117","properties":"126","required":"127","title":"128","$schema":"97","x-stoplight":"129"},"a200e89aad914",[],[],{"type":"117","x-examples":"130","properties":"131","required":"132","$schema":"97","x-stoplight":"133"},"string",["134"],"http://json-schema.org/draft-07/schema#",{"id":"135"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["111","136"],{"id":"137","value":"138","key":"139"},"The Consumer object represents a consumer - or a user - of a Service. You can either rely on Kong as the primary datastore, or you can map the consumer list with your database to keep consistency between Kong and your existing primary datastore.",{"created_at":"140","custom_id":"141","id":"142","tags":"143","updated_at":"144","username":"145"},"object",{"Consumer Object":"146"},"Consumer",["138"],{"id":"147"},{"id":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},{"id":"157","key":"158","value":"159","summary":"160"},{"status":"161","message":"162"},["163","164"],"UnauthorizedError",{"id":"165"},{"Example 1":"166"},{"username":"167","custom_id":"168","tags":"169"},["170","171"],{"id":"172"},"my-username","b1d91782929f0","https","edc322ffa7526",{"custom_id":"173","id":"174","tags":"175","username":"176"},"default",{"description":"177","type":"178"},{"description":"179","type":"95"},{"type":"95"},{"description":"180","items":"181","type":"182"},{"description":"183","type":"178"},{"description":"184","type":"95"},{"custom_id":"173","id":"185","tags":"186","username":"176"},"595f1bbb7cde7","02eea1937717a","9dfba8f349d7b","DuplicateApiKey",{"message":"152","status":401},"Duplicate API key found","d3478893bb22f","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","d6678f304221b","NoAPIKey",{"message":"187","status":401},"No API key found",{"type":"178"},{"type":"95"},"status","message","470b68e5f0549",{"id":"188","created_at":1422386534,"username":"134","custom_id":"189","tags":"190"},{"type":"95","description":"191"},{"type":"95","description":"192"},{"type":"182","description":"193","items":"194"},"username","custom_id","e53872e9d0579","4200","8a388226-20e8-4027-a486-25e4f7db5d21",["195"],"bob-the-builder","Unix epoch when the resource was created.","integer","Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or `username` with the request.","An optional set of strings associated with the Consumer for grouping and filtering.",{"type":"95"},"array","Unix epoch when the resource was last updated.","The unique username of the Consumer. You must send either this field or `custom_id` with the request.","8a388226-80e8-4027-a486-25e4f7db5d21",["195"],"No API key found in request","ec1a1f6f-2aa4-4e58-93ff-b56368f19b27","my-custom-id",["196","197"],"The unique username of the Consumer. You must send either this field or custom_id with the request.\n","Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or username with the request.\n","An optional set of strings associated with the Consumer for grouping and filtering.\n",{"type":"95"},"silver-tier","user-level","low-priority"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-consumer-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all Consumers in a workspace",["17"],"64548bd37e6f4","get","/{workspace}/consumers",["18"],{},"list-consumer-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Consumers",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],["41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"214156776b4c7","887ac8f10fe88","200",[],["48"],"A consumer response object","f30ac85f9fd19","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"71","examples":"72","description":"73","required":true,"schema":"74","explicitProperties":"75"},{"id":"76","key":"77","extensions":"78","description":"79","type":"80","name":"81","in":"82"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"83","path":"84","port":"85","protocol":"86"},{"id":"87","mediaType":"88","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"88","examples":"93","encodings":"94","schema":"95"},"84de208d36983","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103"],"92558d81124dd","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"104","$schema":"97","x-stoplight":"105"},["99","100","101","102","103"],"f9bca22a7f6d6","tags",["106"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"104","examples":"107","x-stoplight":"108","$schema":"97"},["99","109","100","101","102","103"],"688749badec1a","workspace","simple",[],"Name or ID of workspace",{"type":"104","examples":"110","$schema":"97","x-stoplight":"111"},["101","100","112","102","99","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"ec6e1d80dbdff","application/json",[],[],{"type":"122","properties":"123","x-examples":"124","$schema":"97","x-stoplight":"125"},"e594668fecb9d",["126","127","128"],[],{"type":"122","properties":"129","required":"130","title":"131","$schema":"97","x-stoplight":"132"},"integer","http://json-schema.org/draft-07/schema#",{"id":"133"},"description","in","name","schema","title","string",{"id":"134"},{"id":"135","value":"136","key":"137"},["136"],{"explicitProperties":"138","id":"139"},"example",["140"],{"id":"141"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","142"],"object",{"data":"143","next":"144"},{"Example 1":"145","One consumer":"146","Multiple consumers":"147"},{"id":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},{"id":"157","key":"158","value":"159","summary":"160"},{"status":"161","message":"162"},["163","164"],"UnauthorizedError",{"id":"165"},"82b8b1b211803","2b7817e3132b5","6e0de71935d04","tag1,tag2","default",["166","167","168"],"b6e859746b29a","team-a","07bf2cc5cebe8","https",{"type":"169","description":"170","items":"171"},{"type":"104","description":"172","examples":"173"},{"data":"174","next":null},{"data":"175","next":null},{"data":"176","next":null},"ab70985368bb5","4ddb7cf3f59a2","DuplicateApiKey",{"message":"152","status":401},"Duplicate API key found","7ec5c6dc48367","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","99c3afa441fa9","NoAPIKey",{"message":"177","status":401},"No API key found",{"type":"96"},{"type":"104"},"status","message","470b68e5f0549","type","nullable","examples","array","The data array contains consumer objects",{"type":"122","properties":"178"},"Link to the next page of results, if applicable",[null],["179","180","181"],["182"],["183","184","185"],"No API key found in request",{"created_at":"186","custom_id":"187","id":"188","tags":"189","type":"190","updated_at":"191","username":"192","username_lower":"193"},{"created_at":1719859293,"custom_id":"194","id":"195","tags":null,"type":0,"updated_at":1719859293,"username":"196","username_lower":"196"},{"created_at":1719858943,"custom_id":"197","id":"198","tags":null,"type":0,"updated_at":1719858943,"username":"199","username_lower":"199"},{"created_at":1719858965,"custom_id":"200","id":"201","tags":null,"type":0,"updated_at":1719858965,"username":"202","username_lower":"202"},{"created_at":1719859293,"custom_id":"194","id":"195","tags":null,"type":0,"updated_at":1719859293,"username":"196","username_lower":"196"},{"created_at":1719859293,"custom_id":"194","id":"195","tags":null,"type":0,"updated_at":1719859293,"username":"196","username_lower":"196"},{"created_at":1719858943,"custom_id":"197","id":"198","tags":null,"type":0,"updated_at":1719858943,"username":"199","username_lower":"199"},{"created_at":1719858965,"custom_id":"200","id":"201","tags":null,"type":0,"updated_at":1719858965,"username":"202","username_lower":"202"},{"type":"96","description":"203","examples":"204"},{"type":"104","description":"205","examples":"206"},{"type":"104","description":"207","examples":"208"},{"type":"169","description":"209","items":"210"},{"type":"96","default":0,"examples":"211"},{"type":"96","description":"212","examples":"213"},{"type":"104","description":"214","examples":"215"},{"type":"104","description":"216","examples":"217"},"consumer_id3","1cf590ba-4b23-46fa-9e8d-4296213e2ac6","consumer3","consumer_id","73b74f15-5185-4b16-a2fc-3c2fd834ba6c","consumer","consumer_id2","f9383372-7bf4-4275-8bbc-4f89d7a38a23","consumer2","Unix epoch when the resource was created.",[1719859293],"Custom ID of the consumer",["194"],"The consumer ID",["195"],"Tags associated with the consumer",{"type":"104","examples":"218"},[0],"Unix epoch when the resource was last updated.",[1719859293],"The username of the consumer",["196"],"Lowercase representation of the consumer username.",["196"],["219"],"test"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-consumer-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new Consumer in a workspace",["17"],"7a2e75b15d673","post","/{workspace}/consumers",["18"],{},"create-consumer-in-workspace","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Consumers",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48"],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"214156776b4c7","94645b8b3fa84","200",[],["55"],"A consumer response object","ec845d6802ef8","400",[],["56"],"Invalid Consumer","ec945d68020af","401",[],["57"],"Unauthorized","ffd61cb1d63c2",["58"],"Consumer request body",{"id":"59","name":"60","style":"61","examples":"62","description":"63","required":true,"schema":"64","explicitProperties":"65"},{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},{"id":"86","mediaType":"78","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"78","examples":"91","encodings":"92","schema":"93"},"b047ee872c07e","workspace","simple",["94"],"Name or ID of workspace",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110"},{"default":"111","description":"112","enum":"113"},"40a4499d5b1f3","application/json",[],[],{"type":"114","properties":"115","x-examples":"116","$schema":"97","x-stoplight":"117"},"5febadabc452c",[],[],{"type":"114","$schema":"97","x-stoplight":"118"},"77426651ca6c8",["119","120","121"],[],{"type":"114","properties":"122","required":"123","title":"124","$schema":"97","x-stoplight":"125"},"3d5e5598c763a",[],[],{"type":"114","x-examples":"126","properties":"127","required":"128","$schema":"97","x-stoplight":"129"},{"id":"130","value":"131","key":"132"},"string",["131"],"http://json-schema.org/draft-07/schema#",{"id":"133"},"description","example","in","name","required","schema","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["111","134"],"object",{"data":"135","next":"136"},{"Example 1":"137","One consumer":"138","Multiple consumers":"139"},{"id":"140"},{"id":"141"},{"id":"142","key":"143","value":"144","summary":"145"},{"id":"146","key":"147","value":"148","summary":"149"},{"id":"150","key":"151","value":"152","summary":"153"},{"status":"154","message":"155"},["156","157"],"UnauthorizedError",{"id":"158"},{"Example 1":"159"},{"username":"160","custom_id":"161","tags":"162"},["163","164"],{"id":"165"},"ce9ba6f7e02ba","team-a","default","a915147126f17","https",{"type":"166","description":"167","items":"168"},{"type":"95","description":"169","examples":"170"},{"data":"171","next":null},{"data":"172","next":null},{"data":"173","next":null},"ab70985368bb5","44b2eae1abaa3","54dfff658d5cc","DuplicateApiKey",{"message":"145","status":401},"Duplicate API key found","8887e52f38bdd","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","30c4c4b944ecf","NoAPIKey",{"message":"174","status":401},"No API key found",{"type":"175"},{"type":"95"},"status","message","470b68e5f0549",{"id":"176","created_at":1422386534,"username":"177","custom_id":"178","tags":"179"},{"type":"95","description":"180"},{"type":"95","description":"181"},{"type":"166","description":"182","items":"183"},"username","custom_id","e53872e9d0579","array","The data array contains consumer objects",{"type":"114","properties":"184"},"Link to the next page of results, if applicable",[null],["185","186","187"],["188"],["189","190","191"],"No API key found in request","integer","ec1a1f6f-2aa4-4e58-93ff-b56368f19b27","my-username","my-custom-id",["192","193"],"The unique username of the Consumer. You must send either this field or custom_id with the request.\n","Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or username with the request.\n","An optional set of strings associated with the Consumer for grouping and filtering.\n",{"type":"95"},{"created_at":"194","custom_id":"195","id":"196","tags":"197","type":"198","updated_at":"199","username":"200","username_lower":"201"},{"created_at":1719859293,"custom_id":"202","id":"203","tags":null,"type":0,"updated_at":1719859293,"username":"204","username_lower":"204"},{"created_at":1719858943,"custom_id":"205","id":"206","tags":null,"type":0,"updated_at":1719858943,"username":"207","username_lower":"207"},{"created_at":1719858965,"custom_id":"208","id":"209","tags":null,"type":0,"updated_at":1719858965,"username":"210","username_lower":"210"},{"created_at":1719859293,"custom_id":"202","id":"203","tags":null,"type":0,"updated_at":1719859293,"username":"204","username_lower":"204"},{"created_at":1719859293,"custom_id":"202","id":"203","tags":null,"type":0,"updated_at":1719859293,"username":"204","username_lower":"204"},{"created_at":1719858943,"custom_id":"205","id":"206","tags":null,"type":0,"updated_at":1719858943,"username":"207","username_lower":"207"},{"created_at":1719858965,"custom_id":"208","id":"209","tags":null,"type":0,"updated_at":1719858965,"username":"210","username_lower":"210"},"user-level","low-priority",{"type":"175","description":"211","examples":"212"},{"type":"95","description":"213","examples":"214"},{"type":"95","description":"215","examples":"216"},{"type":"166","description":"217","items":"218"},{"type":"175","default":0,"examples":"219"},{"type":"175","description":"220","examples":"221"},{"type":"95","description":"222","examples":"223"},{"type":"95","description":"224","examples":"225"},"consumer_id3","1cf590ba-4b23-46fa-9e8d-4296213e2ac6","consumer3","consumer_id","73b74f15-5185-4b16-a2fc-3c2fd834ba6c","consumer","consumer_id2","f9383372-7bf4-4275-8bbc-4f89d7a38a23","consumer2","Unix epoch when the resource was created.",[1719859293],"Custom ID of the consumer",["202"],"The consumer ID",["203"],"Tags associated with the consumer",{"type":"95","examples":"226"},[0],"Unix epoch when the resource was last updated.",[1719859293],"The username of the consumer",["204"],"Lowercase representation of the consumer username.",["204"],["227"],"test"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-consumer-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a Consumer in a workspace",["17"],"7cc23a00c690b","delete","/{workspace}/consumers/{consumer_username_or_id}",["18"],{},"delete-consumer-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Consumers",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38","39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"214156776b4c7","15a96b936c8d6","204",[],[],"Successfully deleted Consumer or the resource didn't exist","18996af0a3873","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","name":"55","style":"49","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","key":"61","extensions":"62","description":"63","type":"64","name":"65","in":"66"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"67","path":"68","port":"69","protocol":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},"59e012c668a32","workspace","simple",[],"Name or ID of workspace",{"type":"76","examples":"77","$schema":"78","x-stoplight":"79"},["80","81","82","83","84","85"],"c7be9f425a150","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"76","examples":"86","$schema":"78","x-stoplight":"87"},["80","81","82","83","84","85"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95","enum":"96"},"93a35cc6fc7e8","application/json",["97","98","99"],[],{"type":"100","properties":"101","required":"102","title":"103","$schema":"78","x-stoplight":"104"},"string",["105"],"http://json-schema.org/draft-07/schema#",{"id":"106"},"name","in","required","schema","description","title",["107"],{"id":"108"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["94","109"],{"id":"110","key":"111","value":"112","summary":"113"},{"id":"114","key":"115","value":"116","summary":"117"},{"id":"118","key":"119","value":"120","summary":"121"},"object",{"status":"122","message":"123"},["124","125"],"UnauthorizedError",{"id":"126"},"team-a","375cf90744499","my-username","54c77e4f408ce","https","ca2b69181bf4d","DuplicateApiKey",{"message":"113","status":401},"Duplicate API key found","76f1dbc18fc7d","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","9a9fc332950c5","NoAPIKey",{"message":"127","status":401},"No API key found",{"type":"128"},{"type":"76"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-consumer-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a Consumer in a workspace",["18"],"c6765b4820810","get","/{workspace}/consumers/{consumer_username_or_id}",["19"],{},"get-consumer-in-workspace","Get a Consumer using ID or username in a workspace.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Consumers",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46"],["47"],{"id":"48","url":"49","name":"50","description":"51","variables":"52"},"214156776b4c7","577f326914b18","200",[],["53"],"A consumer response object","24cf3311aad38","401",[],["54"],"Unauthorized","249f3311aa827","404",[],[],"Resource does not exist",{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"57","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"6ddccc99ac2f5","workspace","simple",[],"Name or ID of workspace",{"type":"88","examples":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96","97"],"40ed873a9edf7","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"88","examples":"98","$schema":"90","x-stoplight":"99"},["92","93","94","95","96","97"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107","enum":"108"},"4176130be9fd1","application/json",[],[],{"type":"109","properties":"110","x-examples":"111","$schema":"90","x-stoplight":"112"},"cadb784dccab7",["113","114","115"],[],{"type":"109","properties":"116","required":"117","title":"118","$schema":"90","x-stoplight":"119"},"string",["120"],"http://json-schema.org/draft-07/schema#",{"id":"121"},"name","in","required","schema","description","title",["122"],{"id":"123"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["106","124"],"object",{"data":"125","next":"126"},{"Example 1":"127","One consumer":"128","Multiple consumers":"129"},{"id":"130"},{"id":"131","key":"132","value":"133","summary":"134"},{"id":"135","key":"136","value":"137","summary":"138"},{"id":"139","key":"140","value":"141","summary":"142"},{"status":"143","message":"144"},["145","146"],"UnauthorizedError",{"id":"147"},"team-a","d854001172b9f","my-username","4779b90951aa5","https",{"type":"148","description":"149","items":"150"},{"type":"88","description":"151","examples":"152"},{"data":"153","next":null},{"data":"154","next":null},{"data":"155","next":null},"ab70985368bb5","6e8e2331fcd5b","DuplicateApiKey",{"message":"134","status":401},"Duplicate API key found","0f8fbf65aa55e","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","f5cfcff96272d","NoAPIKey",{"message":"156","status":401},"No API key found",{"type":"157"},{"type":"88"},"status","message","470b68e5f0549","array","The data array contains consumer objects",{"type":"109","properties":"158"},"Link to the next page of results, if applicable",[null],["159","160","161"],["162"],["163","164","165"],"No API key found in request","integer",{"created_at":"166","custom_id":"167","id":"168","tags":"169","type":"170","updated_at":"171","username":"172","username_lower":"173"},{"created_at":1719859293,"custom_id":"174","id":"175","tags":null,"type":0,"updated_at":1719859293,"username":"176","username_lower":"176"},{"created_at":1719858943,"custom_id":"177","id":"178","tags":null,"type":0,"updated_at":1719858943,"username":"179","username_lower":"179"},{"created_at":1719858965,"custom_id":"180","id":"181","tags":null,"type":0,"updated_at":1719858965,"username":"182","username_lower":"182"},{"created_at":1719859293,"custom_id":"174","id":"175","tags":null,"type":0,"updated_at":1719859293,"username":"176","username_lower":"176"},{"created_at":1719859293,"custom_id":"174","id":"175","tags":null,"type":0,"updated_at":1719859293,"username":"176","username_lower":"176"},{"created_at":1719858943,"custom_id":"177","id":"178","tags":null,"type":0,"updated_at":1719858943,"username":"179","username_lower":"179"},{"created_at":1719858965,"custom_id":"180","id":"181","tags":null,"type":0,"updated_at":1719858965,"username":"182","username_lower":"182"},{"type":"157","description":"183","examples":"184"},{"type":"88","description":"185","examples":"186"},{"type":"88","description":"187","examples":"188"},{"type":"148","description":"189","items":"190"},{"type":"157","default":0,"examples":"191"},{"type":"157","description":"192","examples":"193"},{"type":"88","description":"194","examples":"195"},{"type":"88","description":"196","examples":"197"},"consumer_id3","1cf590ba-4b23-46fa-9e8d-4296213e2ac6","consumer3","consumer_id","73b74f15-5185-4b16-a2fc-3c2fd834ba6c","consumer","consumer_id2","f9383372-7bf4-4275-8bbc-4f89d7a38a23","consumer2","Unix epoch when the resource was created.",[1719859293],"Custom ID of the consumer",["174"],"The consumer ID",["175"],"Tags associated with the consumer",{"type":"88","examples":"198"},[0],"Unix epoch when the resource was last updated.",[1719859293],"The username of the consumer",["176"],"Lowercase representation of the consumer username.",["176"],["199"],"test"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-consumer-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update a Consumer in a workspace",["17"],"8b19c4e9cef05","patch","/{workspace}/consumers/{consumer_username_or_id}",["18"],{},"update-consumer-in-workspace","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Consumers",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54","55"],["56"],{"id":"57","url":"58","name":"59","description":"60","variables":"61"},"214156776b4c7","34a34fd1ebedf","200",[],["62"],"A consumer response object","dc834df5288d0","400",[],["63"],"Invalid Consumer","dc734df528aa3","401",[],["64"],"Unauthorized","dcc34df52921c","404",[],[],"Resource does not exist","012ac7ad7e183",["65"],"Consumer request body",{"id":"66","name":"67","style":"68","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","name":"74","style":"68","examples":"75","description":"76","required":true,"schema":"77","explicitProperties":"78"},{"id":"79","key":"80","extensions":"81","description":"82","type":"83","name":"84","in":"85"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"86","path":"87","port":"88","protocol":"89"},{"id":"90","mediaType":"91","examples":"92","encodings":"93","schema":"94"},{"id":"95","mediaType":"91","examples":"96","encodings":"97","schema":"98"},{"id":"99","mediaType":"91","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"91","examples":"104","encodings":"105","schema":"106"},"f7cc53483e836","workspace","simple",[],"Name or ID of workspace",{"type":"107","examples":"108","$schema":"109","x-stoplight":"110"},["111","112","113","114","115","116"],"573ddbbdec98e","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"107","examples":"117","$schema":"109","x-stoplight":"118"},["111","112","113","114","115","116"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"119","description":"120"},{"default":"121","description":"122"},{"default":"123","description":"124"},{"default":"125","description":"126","enum":"127"},"0533d500bac17","application/json",[],[],{"type":"128","properties":"129","x-examples":"130","$schema":"109","x-stoplight":"131"},"b4202ede5ca92",[],[],{"type":"128","$schema":"109","x-stoplight":"132"},"1261e1f5ea816",["133","134","135"],[],{"type":"128","properties":"136","required":"137","title":"138","$schema":"109","x-stoplight":"139"},"ce044e4992c93",[],[],{"type":"128","x-examples":"140","properties":"141","required":"142","$schema":"109","x-stoplight":"143"},"string",["144"],"http://json-schema.org/draft-07/schema#",{"id":"145"},"name","in","required","schema","description","title",["146"],{"id":"147"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["125","148"],"object",{"data":"149","next":"150"},{"Example 1":"151","One consumer":"152","Multiple consumers":"153"},{"id":"154"},{"id":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"id":"160","key":"161","value":"162","summary":"163"},{"id":"164","key":"165","value":"166","summary":"167"},{"status":"168","message":"169"},["170","171"],"UnauthorizedError",{"id":"172"},{"Example 1":"173"},{"username":"174","custom_id":"175","tags":"176"},["177","178"],{"id":"179"},"team-a","1df33ecc50602","my-username","f68d592bd4419","https",{"type":"180","description":"181","items":"182"},{"type":"107","description":"183","examples":"184"},{"data":"185","next":null},{"data":"186","next":null},{"data":"187","next":null},"ab70985368bb5","15d217e2dafe6","ec031fae9cf1e","DuplicateApiKey",{"message":"159","status":401},"Duplicate API key found","cba7bd04f8049","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","5066a24fa9849","NoAPIKey",{"message":"188","status":401},"No API key found",{"type":"189"},{"type":"107"},"status","message","470b68e5f0549",{"id":"190","created_at":1422386534,"username":"146","custom_id":"191","tags":"192"},{"type":"107","description":"193"},{"type":"107","description":"194"},{"type":"180","description":"195","items":"196"},"username","custom_id","e53872e9d0579","array","The data array contains consumer objects",{"type":"128","properties":"197"},"Link to the next page of results, if applicable",[null],["198","199","200"],["201"],["202","203","204"],"No API key found in request","integer","ec1a1f6f-2aa4-4e58-93ff-b56368f19b27","my-custom-id",["205","206"],"The unique username of the Consumer. You must send either this field or custom_id with the request.\n","Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or username with the request.\n","An optional set of strings associated with the Consumer for grouping and filtering.\n",{"type":"107"},{"created_at":"207","custom_id":"208","id":"209","tags":"210","type":"211","updated_at":"212","username":"213","username_lower":"214"},{"created_at":1719859293,"custom_id":"215","id":"216","tags":null,"type":0,"updated_at":1719859293,"username":"217","username_lower":"217"},{"created_at":1719858943,"custom_id":"218","id":"219","tags":null,"type":0,"updated_at":1719858943,"username":"220","username_lower":"220"},{"created_at":1719858965,"custom_id":"221","id":"222","tags":null,"type":0,"updated_at":1719858965,"username":"223","username_lower":"223"},{"created_at":1719859293,"custom_id":"215","id":"216","tags":null,"type":0,"updated_at":1719859293,"username":"217","username_lower":"217"},{"created_at":1719859293,"custom_id":"215","id":"216","tags":null,"type":0,"updated_at":1719859293,"username":"217","username_lower":"217"},{"created_at":1719858943,"custom_id":"218","id":"219","tags":null,"type":0,"updated_at":1719858943,"username":"220","username_lower":"220"},{"created_at":1719858965,"custom_id":"221","id":"222","tags":null,"type":0,"updated_at":1719858965,"username":"223","username_lower":"223"},"user-level","low-priority",{"type":"189","description":"224","examples":"225"},{"type":"107","description":"226","examples":"227"},{"type":"107","description":"228","examples":"229"},{"type":"180","description":"230","items":"231"},{"type":"189","default":0,"examples":"232"},{"type":"189","description":"233","examples":"234"},{"type":"107","description":"235","examples":"236"},{"type":"107","description":"237","examples":"238"},"consumer_id3","1cf590ba-4b23-46fa-9e8d-4296213e2ac6","consumer3","consumer_id","73b74f15-5185-4b16-a2fc-3c2fd834ba6c","consumer","consumer_id2","f9383372-7bf4-4275-8bbc-4f89d7a38a23","consumer2","Unix epoch when the resource was created.",[1719859293],"Custom ID of the consumer",["215"],"The consumer ID",["216"],"Tags associated with the consumer",{"type":"107","examples":"239"},[0],"Unix epoch when the resource was last updated.",[1719859293],"The username of the consumer",["217"],"Lowercase representation of the consumer username.",["217"],["240"],"test"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-consumer-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a Consumer in a workspace",["18"],"1ad94525d52c7","put","/{workspace}/consumers/{consumer_username_or_id}",["19"],{},"upsert-consumer-in-workspace","Create or Update Consumer using ID or username in a workspace.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Consumers",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"214156776b4c7","f3969940797e0","200",[],["57"],"A consumer response object","5e3698af099b1","400",[],["58"],"Invalid Consumer","5e2698af0967e","401",[],["59"],"Unauthorized","645d15963d9ca",["60"],"Consumer request body",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"101"},"c3ba5094482fc","workspace","simple",[],"Name or ID of workspace",{"type":"102","examples":"103","$schema":"104","x-stoplight":"105"},["106","107","108","109","110","111"],"8a39e07953892","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"102","examples":"112","$schema":"104","x-stoplight":"113"},["106","107","108","109","110","111"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121","enum":"122"},"4a9f29887d2a1","application/json",[],[],{"type":"123","properties":"124","x-examples":"125","$schema":"104","x-stoplight":"126"},"b70e40a2ec17c",[],[],{"type":"123","$schema":"104","x-stoplight":"127"},"4e2cd8b85f59a",["128","129","130"],[],{"type":"123","properties":"131","required":"132","title":"133","$schema":"104","x-stoplight":"134"},"9ebf64162e132",[],[],{"type":"123","x-examples":"135","properties":"136","required":"137","$schema":"104","x-stoplight":"138"},"string",["139"],"http://json-schema.org/draft-07/schema#",{"id":"140"},"name","in","required","schema","description","title",["141"],{"id":"142"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["120","143"],"object",{"data":"144","next":"145"},{"Example 1":"146","One consumer":"147","Multiple consumers":"148"},{"id":"149"},{"id":"150"},{"id":"151","key":"152","value":"153","summary":"154"},{"id":"155","key":"156","value":"157","summary":"158"},{"id":"159","key":"160","value":"161","summary":"162"},{"status":"163","message":"164"},["165","166"],"UnauthorizedError",{"id":"167"},{"Example 1":"168"},{"username":"169","custom_id":"170","tags":"171"},["172","173"],{"id":"174"},"team-a","6524d9fa02024","my-username","0de9c07973e32","https",{"type":"175","description":"176","items":"177"},{"type":"102","description":"178","examples":"179"},{"data":"180","next":null},{"data":"181","next":null},{"data":"182","next":null},"ab70985368bb5","05a85704ce48c","81949ee33545f","DuplicateApiKey",{"message":"154","status":401},"Duplicate API key found","4d90ac23aae89","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","85b7344b55b1b","NoAPIKey",{"message":"183","status":401},"No API key found",{"type":"184"},{"type":"102"},"status","message","470b68e5f0549",{"id":"185","created_at":1422386534,"username":"141","custom_id":"186","tags":"187"},{"type":"102","description":"188"},{"type":"102","description":"189"},{"type":"175","description":"190","items":"191"},"username","custom_id","e53872e9d0579","array","The data array contains consumer objects",{"type":"123","properties":"192"},"Link to the next page of results, if applicable",[null],["193","194","195"],["196"],["197","198","199"],"No API key found in request","integer","ec1a1f6f-2aa4-4e58-93ff-b56368f19b27","my-custom-id",["200","201"],"The unique username of the Consumer. You must send either this field or custom_id with the request.\n","Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or username with the request.\n","An optional set of strings associated with the Consumer for grouping and filtering.\n",{"type":"102"},{"created_at":"202","custom_id":"203","id":"204","tags":"205","type":"206","updated_at":"207","username":"208","username_lower":"209"},{"created_at":1719859293,"custom_id":"210","id":"211","tags":null,"type":0,"updated_at":1719859293,"username":"212","username_lower":"212"},{"created_at":1719858943,"custom_id":"213","id":"214","tags":null,"type":0,"updated_at":1719858943,"username":"215","username_lower":"215"},{"created_at":1719858965,"custom_id":"216","id":"217","tags":null,"type":0,"updated_at":1719858965,"username":"218","username_lower":"218"},{"created_at":1719859293,"custom_id":"210","id":"211","tags":null,"type":0,"updated_at":1719859293,"username":"212","username_lower":"212"},{"created_at":1719859293,"custom_id":"210","id":"211","tags":null,"type":0,"updated_at":1719859293,"username":"212","username_lower":"212"},{"created_at":1719858943,"custom_id":"213","id":"214","tags":null,"type":0,"updated_at":1719858943,"username":"215","username_lower":"215"},{"created_at":1719858965,"custom_id":"216","id":"217","tags":null,"type":0,"updated_at":1719858965,"username":"218","username_lower":"218"},"user-level","low-priority",{"type":"184","description":"219","examples":"220"},{"type":"102","description":"221","examples":"222"},{"type":"102","description":"223","examples":"224"},{"type":"175","description":"225","items":"226"},{"type":"184","default":0,"examples":"227"},{"type":"184","description":"228","examples":"229"},{"type":"102","description":"230","examples":"231"},{"type":"102","description":"232","examples":"233"},"consumer_id3","1cf590ba-4b23-46fa-9e8d-4296213e2ac6","consumer3","consumer_id","73b74f15-5185-4b16-a2fc-3c2fd834ba6c","consumer","consumer_id2","f9383372-7bf4-4275-8bbc-4f89d7a38a23","consumer2","Unix epoch when the resource was created.",[1719859293],"Custom ID of the consumer",["210"],"The consumer ID",["211"],"Tags associated with the consumer",{"type":"102","examples":"234"},[0],"Unix epoch when the resource was last updated.",[1719859293],"The username of the consumer",["212"],"Lowercase representation of the consumer username.",["212"],["235"],"test"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-certificate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all Certificates",["18"],"ab4f5e37c15f4","get","/certificates",["19"],{},"list-certificate","Retrieve a list of all available CA Certificate Authority (CA) certificates. You can use query parameters to filter the results by size or tags, for example `/certificates?size=50&tags=enterprise`.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Certificates",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40","41"],[],[],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"00dbd660d0e69","ce1d5e3aeedb5","200",[],["48"],"A successful response listing Certificates","75ed5c5e2c07a","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","key":"70","extensions":"71","description":"72","type":"73","name":"74","in":"75"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"76","path":"77","port":"78","protocol":"79"},{"id":"80","mediaType":"81","examples":"82","encodings":"83","schema":"84"},{"id":"85","mediaType":"81","examples":"86","encodings":"87","schema":"88"},"8c3f01d4ae51b","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96"],"e07a786806fd9","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"97","$schema":"90","x-stoplight":"98"},["92","93","94","95","96"],"2b5b4b86c81e9","tags",["99"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"97","examples":"100","x-stoplight":"101","$schema":"90"},["92","102","93","94","95","96"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"103","description":"104"},{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110","enum":"111"},"187ea3457109d","application/json",["112","113"],[],{"description":"114","properties":"115","type":"116","title":"117","examples":"118","$schema":"90","x-stoplight":"119"},"e0d72b58fa9a6",["120","121","122"],[],{"type":"116","properties":"123","required":"124","title":"125","$schema":"90","x-stoplight":"126"},"integer","http://json-schema.org/draft-07/schema#",{"id":"127"},"description","in","name","schema","title","string",{"id":"128"},{"id":"129","value":"130","key":"131"},["130"],{"explicitProperties":"132","id":"133"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["109","134"],{"id":"135","value":"136","key":"131"},{"id":"137","key":"117","value":"138"},"A certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service. Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames. If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string according to the following order, main certificate on the top, followed by any intermediates.",{"cert":"139","cert_alt":"140","created_at":"141","id":"142","key":"143","key_alt":"144","tags":"145","updated_at":"146","snis":"147"},"object","Certificate",["136"],{"id":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},{"id":"157","key":"158","value":"159","summary":"160"},{"status":"161","message":"162"},["163","164"],"UnauthorizedError",{"id":"165"},"eab3d87c3b8b3","88efec33c98c7","748e319779b0c","tag1,tag2","default",["166","167","168"],"6601623294d46","https","f597a26feede9",{"cert":"169","id":"170","key":"171"},"674028e8df13c",{"cert":"169","id":"170","key":"171"},{"description":"172","type":"97"},{"description":"173","type":"97"},{"description":"174","type":"89"},{"type":"97"},{"description":"175","type":"97"},{"description":"176","type":"97"},{"description":"177","items":"178","type":"179"},{"description":"180","type":"89"},{"description":"181","type":"179","items":"182"},"18061f7aa351f","f4b0de92e4f39","DuplicateApiKey",{"message":"152","status":401},"Duplicate API key found","2a1a2399c8f7b","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","c52ba5fb9fad1","NoAPIKey",{"message":"183","status":401},"No API key found",{"type":"89"},{"type":"97"},"status","message","470b68e5f0549","type","nullable","examples","-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f269","-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----","PEM-encoded public certificate chain of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","Unix epoch when the resource was created.","PEM-encoded private key of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","An optional set of strings associated with the Certificate for grouping and filtering.",{"type":"97"},"array","Unix epoch when the resource was last updated.","A list of SNIs associated with the certificate.\n",{"type":"97","format":"184"},"No API key found in request","hostname"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-certificate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create a new Certificate",["18"],"8ee3e1d5ca155","post","/certificates",["19"],{},"create-certificate","Create a new certificate with the provided details. Use this endpoint to add a new certificate to the system. The request body must include the certificate data and other details required for creating a new certificate.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Certificates",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","required":true,"description":"48"},[],[],[],[],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"00dbd660d0e69","11037800f3291","200",[],["55"],"Successfully created Certificate","712379ddc3695","400",[],["56"],"Invalid Certificate","713379ddc3022","401",[],["57"],"Unauthorized","ab594051f4627",["58"],"Description of the new Certificate for creation",{"id":"59","key":"60","extensions":"61","description":"62","type":"63","name":"64","in":"65"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"66","path":"67","port":"68","protocol":"69"},{"id":"70","mediaType":"71","examples":"72","encodings":"73","schema":"74"},{"id":"75","mediaType":"71","examples":"76","encodings":"77","schema":"78"},{"id":"79","mediaType":"71","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"71","examples":"84","encodings":"85","schema":"74"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"86","description":"87"},{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93","enum":"94"},"bb2b14524df23","application/json",["95"],[],{"description":"96","properties":"97","type":"98","title":"99","examples":"100","$schema":"101","x-stoplight":"102"},"3b3e45961301b",["103"],[],{"type":"98","x-examples":"104","properties":"105","$schema":"101","x-stoplight":"106"},"11d6e71a7b163",["107","108","109"],[],{"type":"98","properties":"110","required":"111","title":"112","$schema":"101","x-stoplight":"113"},"3ff830e2c5ca2",["114"],[],"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["92","115"],{"id":"116","value":"117","key":"118"},"A certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service. Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames. If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string according to the following order, main certificate on the top, followed by any intermediates.",{"cert":"119","cert_alt":"120","created_at":"121","id":"122","key":"123","key_alt":"124","tags":"125","updated_at":"126","snis":"127"},"object","Certificate",["117"],"http://json-schema.org/draft-07/schema#",{"id":"128"},{"id":"129","key":"130","value":"131"},{"Example 1":"132"},{"fields":"133","message":"134","name":"135","code":"136"},{"id":"137"},{"id":"138","key":"139","value":"140","summary":"141"},{"id":"142","key":"143","value":"144","summary":"145"},{"id":"146","key":"147","value":"148","summary":"149"},{"status":"150","message":"151"},["152","153"],"UnauthorizedError",{"id":"154"},{"id":"155","value":"117","key":"118"},"https","4dcb25f9fa19b",{"cert":"156","id":"157","key":"158"},"default",{"description":"159","type":"160"},{"description":"161","type":"160"},{"description":"162","type":"163"},{"type":"160"},{"description":"164","type":"160"},{"description":"165","type":"160"},{"description":"166","items":"167","type":"168"},{"description":"169","type":"163"},{"description":"170","type":"168","items":"171"},"18061f7aa351f","551fedebfbbee","Example 1",{"fields":"172","message":"160","name":"160","code":0},{"fields":"173","message":"174","name":"175","code":2},{"type":"98","properties":"176"},{"type":"160","description":"177","examples":"178"},{"type":"160","description":"179","examples":"180"},{"type":"163","description":"181","examples":"182"},"e0592a02d9d19","45a5070769838","DuplicateApiKey",{"message":"141","status":401},"Duplicate API key found","763dd56f26e84","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","b3946b7695d93","NoAPIKey",{"message":"183","status":401},"No API key found",{"type":"163"},{"type":"160"},"status","message","470b68e5f0549","90e46e34a407c","-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f269","-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----","PEM-encoded public certificate chain of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","string","PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","Unix epoch when the resource was created.","integer","PEM-encoded private key of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","An optional set of strings associated with the Certificate for grouping and filtering.",{"type":"160"},"array","Unix epoch when the resource was last updated.","A list of SNIs associated with the certificate.\n",{"type":"160","format":"184"},{"key":"160","cert":"160"},{"key":"185","cert":"186"},"2 schema violations (cert: invalid certificate: x509.new: asn1/tasn_dec.c:309:error:0D07803A:asn1 encoding routines:asn1_item_embed_d2i:nested asn1 error; key: invalid key: pkey.new:load_key: pem/pem_lib.c:949:error:09091064:PEM routines:PEM_read_bio_ex:bad base64 decode)","schema violation",{"key":"187","cert":"188"},"error message",["189"],"The name of the error message.",["175"],"An error code.",[2],"No API key found in request","hostname","invalid key: pkey.new:load_key: pem/pem_lib.c:949:error:09091064:PEM routines:PEM_read_bio_ex:bad base64 decode","invalid certificate: x509.new: asn1/tasn_dec.c:309:error:0D07803A:asn1 encoding routines:asn1_item_embed_d2i:nested asn1 error",{"type":"160","description":"190","examples":"191"},{"type":"160","description":"192","examples":"193"},"2 schema violations (cert: invalid certificate: x509.new: asn1/tasn_dec.c:309:error:0D07803A:asn1","Information about the key.",["194"],"Information about the certificate.",["195"],"invalid key: pkey.new:load_key: ","invalid certificate: x509.new: "]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-certificate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a Certificate",["17"],"c43bdea714970","delete","/certificates/{certificate_id}",["18"],{},"delete-certificate","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Certificates",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38"],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"00dbd660d0e69","3f6f05f9916e9","204",[],[],"Successfully deleted Certificate or the resource didn't exist","973f07d65257e","401",[],["45"],"Unauthorized",{"id":"46","name":"47","style":"48","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},{"id":"64","mediaType":"65","examples":"66","encodings":"67","schema":"68"},"e2b801d6781fa","certificate_id","simple",[],"The unique identifier of the Certificate to retrieve.",{"type":"69","examples":"70","$schema":"71","x-stoplight":"72"},["73","74","75","76","77","78"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86","enum":"87"},"e9fbde1d614f1","application/json",["88","89","90"],[],{"type":"91","properties":"92","required":"93","title":"94","$schema":"71","x-stoplight":"95"},"string",["96"],"http://json-schema.org/draft-07/schema#",{"id":"97"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["85","98"],{"id":"99","key":"100","value":"101","summary":"102"},{"id":"103","key":"104","value":"105","summary":"106"},{"id":"107","key":"108","value":"109","summary":"110"},"object",{"status":"111","message":"112"},["113","114"],"UnauthorizedError",{"id":"115"},"7fca84d6-7d37-4a74-a7b0-93e576089a41\"","04828d343cfcf","https","9602332dbbbbd","DuplicateApiKey",{"message":"102","status":401},"Duplicate API key found","914a0475811fc","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","c1334018bd444","NoAPIKey",{"message":"116","status":401},"No API key found",{"type":"117"},{"type":"69"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-certificate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a Certificate",["18"],"08a48d5195972","get","/certificates/{certificate_id}",["19"],{},"get-certificate","Get a Certificate using ID.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Certificates",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45"],["46"],{"id":"47","url":"48","name":"49","description":"50","variables":"51"},"00dbd660d0e69","adb5333429286","200",[],["52"],"Successfully fetched Certificate","732533dcb20cc","401",[],["53"],"Unauthorized","72d533dcb1f33","404",[],[],"Resource does not exist",{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},{"id":"77","mediaType":"73","examples":"78","encodings":"79","schema":"80"},"61dcde96db14b","certificate_id","simple",[],"The unique identifier of the Certificate to retrieve.",{"type":"81","examples":"82","$schema":"83","x-stoplight":"84"},["85","86","87","88","89","90"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"719c3236dfd97","application/json",["100"],[],{"description":"101","properties":"102","type":"103","title":"104","examples":"105","$schema":"83","x-stoplight":"106"},"8c734f5131833",["107","108","109"],[],{"type":"103","properties":"110","required":"111","title":"112","$schema":"83","x-stoplight":"113"},"string",["114"],"http://json-schema.org/draft-07/schema#",{"id":"115"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","116"],{"id":"117","value":"118","key":"119"},"A certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service. Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames. If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string according to the following order, main certificate on the top, followed by any intermediates.",{"cert":"120","cert_alt":"121","created_at":"122","id":"123","key":"124","key_alt":"125","tags":"126","updated_at":"127","snis":"128"},"object","Certificate",["118"],{"id":"129"},{"id":"130","key":"131","value":"132","summary":"133"},{"id":"134","key":"135","value":"136","summary":"137"},{"id":"138","key":"139","value":"140","summary":"141"},{"status":"142","message":"143"},["144","145"],"UnauthorizedError",{"id":"146"},"7fca84d6-7d37-4a74-a7b0-93e576089a41\"","5e3f533a8843d","https","24c5d1ecbc3e8",{"cert":"147","id":"148","key":"149"},"default",{"description":"150","type":"81"},{"description":"151","type":"81"},{"description":"152","type":"153"},{"type":"81"},{"description":"154","type":"81"},{"description":"155","type":"81"},{"description":"156","items":"157","type":"158"},{"description":"159","type":"153"},{"description":"160","type":"158","items":"161"},"18061f7aa351f","95b84c3a8a869","DuplicateApiKey",{"message":"133","status":401},"Duplicate API key found","704f27eef4bf2","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","de0e8791e7759","NoAPIKey",{"message":"162","status":401},"No API key found",{"type":"153"},{"type":"81"},"status","message","470b68e5f0549","-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f269","-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----","PEM-encoded public certificate chain of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","Unix epoch when the resource was created.","integer","PEM-encoded private key of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","An optional set of strings associated with the Certificate for grouping and filtering.",{"type":"81"},"array","Unix epoch when the resource was last updated.","A list of SNIs associated with the certificate.\n",{"type":"81","format":"163"},"No API key found in request","hostname"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-certificate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a Certificate",["18"],"f0ae0e3fc9b91","patch","/certificates/{certificate_id}",["19"],{},"update-certificate","Update a Certificate\n\nInserts (or replaces) the certificate under the requested `certificate_id`with the definition specified in the request body. When the `name` or `id` attribute has the structure of a UUID, the certificate being inserted/replaced will be identified by its `id`. Otherwise it will be identified by the `name`.\n\nWhen creating a new Certificate without specifying `id` (neither in the path or the request body), then it will be auto-generated.\n","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"Certificates",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55"],["56"],{"id":"57","url":"58","name":"59","description":"60","variables":"61"},"00dbd660d0e69","437cc96ef35fb","200",[],["62"],"Successfully updated Certificate","e35cc79223064","400",[],["63"],"Invalid Certificate","e34cc79223e37","401",[],["64"],"Unauthorized","e39cc792236b8","404",[],[],"Resource does not exist","16cb0296724c0",["65"],"The certificate request body",{"id":"66","name":"67","style":"68","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","key":"74","extensions":"75","description":"76","type":"77","name":"78","in":"79"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"80","path":"81","port":"82","protocol":"83"},{"id":"84","mediaType":"85","examples":"86","encodings":"87","schema":"88"},{"id":"89","mediaType":"85","examples":"90","encodings":"91","schema":"92"},{"id":"93","mediaType":"85","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"85","examples":"98","encodings":"99","schema":"100"},"6d4498313230d","certificate_id","simple",[],"The unique identifier of the Certificate to retrieve.",{"type":"101","examples":"102","$schema":"103","x-stoplight":"104"},["105","106","107","108","109","110"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"111","description":"112"},{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118","enum":"119"},"7c4dc789af262","application/json",["120"],[],{"description":"121","properties":"122","type":"123","title":"124","examples":"125","$schema":"103","x-stoplight":"126"},"016d7e4c65a63",[],[],{"type":"123","$schema":"103","x-stoplight":"127"},"410e55a6a47b8",["128","129","130"],[],{"type":"123","properties":"131","required":"132","title":"133","$schema":"103","x-stoplight":"134"},"67ab5bd8da605",[],[],{"type":"123","x-examples":"135","properties":"136","required":"137","$schema":"103","x-stoplight":"138"},"string",["139"],"http://json-schema.org/draft-07/schema#",{"id":"140"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["117","141"],{"id":"142","value":"143","key":"144"},"A certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service. Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames. If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string according to the following order, main certificate on the top, followed by any intermediates.",{"cert":"145","cert_alt":"146","created_at":"147","id":"148","key":"149","key_alt":"150","tags":"151","updated_at":"152","snis":"153"},"object","Certificate",["143"],{"id":"154"},{"id":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"id":"160","key":"161","value":"162","summary":"163"},{"id":"164","key":"165","value":"166","summary":"167"},{"status":"168","message":"169"},["170","171"],"UnauthorizedError",{"id":"172"},{"Example":"173"},{"cert":"174","key":"175","cert_alt":"176","key_alt":"177","snis":"178","tags":"179","passphrase":"180"},["181","182"],{"id":"183"},"7fca84d6-7d37-4a74-a7b0-93e576089a41\"","edf3286fb5eb7","https","c39cb998bba5d",{"cert":"184","id":"185","key":"186"},"default",{"description":"187","type":"101"},{"description":"188","type":"101"},{"description":"189","type":"190"},{"type":"101"},{"description":"191","type":"101"},{"description":"192","type":"101"},{"description":"193","items":"194","type":"195"},{"description":"196","type":"190"},{"description":"197","type":"195","items":"198"},"18061f7aa351f","795c2f9b166a2","58a9c1b904f4d","DuplicateApiKey",{"message":"159","status":401},"Duplicate API key found","4a6376933f9d1","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","de9eea8d0aab2","NoAPIKey",{"message":"199","status":401},"No API key found",{"type":"190"},{"type":"101"},"status","message","470b68e5f0549",{"id":"200","created_at":1422386534,"cert":"201","key":"202","cert_alt":"201","key_alt":"203","snis":"204","tags":"205"},{"type":"101","description":"206","examples":"207"},{"type":"101","description":"208","examples":"209"},{"type":"101","description":"210"},{"type":"101","description":"211","examples":"212"},{"type":"195","description":"213","items":"214"},{"type":"195","description":"215","items":"216"},{"type":"101","description":"217","examples":"218"},"cert","key","dabf7736eb930","-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f269","-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----","PEM-encoded public certificate chain of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","Unix epoch when the resource was created.","integer","PEM-encoded private key of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","An optional set of strings associated with the Certificate for grouping and filtering.",{"type":"101"},"array","Unix epoch when the resource was last updated.","A list of SNIs associated with the certificate.\n",{"type":"101","format":"219"},"No API key found in request","7fca84d6-7d37-4a74-a7b0-93e576089a41","-----BEGIN CERTIFICATE-----...","-----BEGIN RSA PRIVATE KEY-----...","-----BEGIN EC PRIVATE KEY-----...",["220","221"],["222","223"],"PEM-encoded public certificate chain of the SSL key pair.",["201"],"PEM-encoded private key of the SSL key pair.",["202"],"PEM-encoded public certificate chain of the alternate SSL key pair.","PEM-encoded private key of the alternate SSL key pair.",["224"],"An array of zero or more hostnames to associate with this certificate as SNIs.",{"type":"101"},"An optional set of strings associated with the Certificate for grouping and filtering.\n",{"type":"101"},"To load an encrypted private key into Kong, specify the passphrase using this attributKong will decrypt the private key and store it in its database. e. Enterprise Only",["225"],"hostname","foo.test","example.com","user-level","low-priority","\"-----BEGIN EC PRIVATE KEY-----...\"","example"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-certificate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a Certificate",["18"],"dd1e0e76b3360","put","/certificates/{certificate_id}",["19"],{},"upsert-certificate","Update details about the specified certificate using the provided path parameter `certificate_id`.\n\nInserts (or replaces) the certificate under the requested `certificate_id`with the definition specified in the request body. When the `name` or `id` attribute has the structure of a UUID, the certificate being inserted/replaced will be identified by its `id`. Otherwise it will be identified by the `name`.\n\nWhen creating a new Certificate without specifying `id` (neither in the path or the request body), then it will be auto-generated.\n","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Certificates",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"00dbd660d0e69","64fb6943dbea4","200",[],["56"],"Successfully upserted Certificate","0cdb676718238","400",[],["57"],"Invalid Certificate","0ccb676718c4b","401",[],["58"],"Unauthorized","175876219f4e7",["59"],"The certificate request body",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"79","examples":"84","encodings":"85","schema":"86"},{"id":"87","mediaType":"79","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"79","examples":"92","encodings":"93","schema":"94"},"e8bb6b772d760","certificate_id","simple",[],"The unique identifier of the Certificate to retrieve.",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110"},{"default":"111","description":"112","enum":"113"},"50c30761be053","application/json",["114"],[],{"description":"115","properties":"116","type":"117","title":"118","examples":"119","$schema":"97","x-stoplight":"120"},"89f6fd44608e8",[],[],{"type":"117","$schema":"97","x-stoplight":"121"},"ad4c6f29f2d86",["122","123","124"],[],{"type":"117","properties":"125","required":"126","title":"127","$schema":"97","x-stoplight":"128"},"74cdc6de1a147",[],[],{"type":"117","x-examples":"129","properties":"130","required":"131","$schema":"97","x-stoplight":"132"},"string",["133"],"http://json-schema.org/draft-07/schema#",{"id":"134"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["111","135"],{"id":"136","value":"137","key":"138"},"A certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service. Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames. If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string according to the following order, main certificate on the top, followed by any intermediates.",{"cert":"139","cert_alt":"140","created_at":"141","id":"142","key":"143","key_alt":"144","tags":"145","updated_at":"146","snis":"147"},"object","Certificate",["137"],{"id":"148"},{"id":"149"},{"id":"150","key":"151","value":"152","summary":"153"},{"id":"154","key":"155","value":"156","summary":"157"},{"id":"158","key":"159","value":"160","summary":"161"},{"status":"162","message":"163"},["164","165"],"UnauthorizedError",{"id":"166"},{"Example":"167"},{"cert":"168","key":"169","cert_alt":"170","key_alt":"171","snis":"172","tags":"173","passphrase":"174"},["175","176"],{"id":"177"},"7fca84d6-7d37-4a74-a7b0-93e576089a41\"","9cde3502db8f2","https","a19488fa5767f",{"cert":"178","id":"179","key":"180"},"default",{"description":"181","type":"95"},{"description":"182","type":"95"},{"description":"183","type":"184"},{"type":"95"},{"description":"185","type":"95"},{"description":"186","type":"95"},{"description":"187","items":"188","type":"189"},{"description":"190","type":"184"},{"description":"191","type":"189","items":"192"},"18061f7aa351f","6e4605d6028e6","bd00909903871","DuplicateApiKey",{"message":"153","status":401},"Duplicate API key found","1d86731d49083","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","77917e1a1552e","NoAPIKey",{"message":"193","status":401},"No API key found",{"type":"184"},{"type":"95"},"status","message","470b68e5f0549",{"id":"194","created_at":1422386534,"cert":"195","key":"196","cert_alt":"195","key_alt":"197","snis":"198","tags":"199"},{"type":"95","description":"200","examples":"201"},{"type":"95","description":"202","examples":"203"},{"type":"95","description":"204"},{"type":"95","description":"205","examples":"206"},{"type":"189","description":"207","items":"208"},{"type":"189","description":"209","items":"210"},{"type":"95","description":"211","examples":"212"},"cert","key","dabf7736eb930","-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f269","-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----","PEM-encoded public certificate chain of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","Unix epoch when the resource was created.","integer","PEM-encoded private key of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","An optional set of strings associated with the Certificate for grouping and filtering.",{"type":"95"},"array","Unix epoch when the resource was last updated.","A list of SNIs associated with the certificate.\n",{"type":"95","format":"213"},"No API key found in request","7fca84d6-7d37-4a74-a7b0-93e576089a41","-----BEGIN CERTIFICATE-----...","-----BEGIN RSA PRIVATE KEY-----...","-----BEGIN EC PRIVATE KEY-----...",["214","215"],["216","217"],"PEM-encoded public certificate chain of the SSL key pair.",["195"],"PEM-encoded private key of the SSL key pair.",["196"],"PEM-encoded public certificate chain of the alternate SSL key pair.","PEM-encoded private key of the alternate SSL key pair.",["218"],"An array of zero or more hostnames to associate with this certificate as SNIs.",{"type":"95"},"An optional set of strings associated with the Certificate for grouping and filtering.\n",{"type":"95"},"To load an encrypted private key into Kong, specify the passphrase using this attributKong will decrypt the private key and store it in its database. e. Enterprise Only",["219"],"hostname","foo.test","example.com","user-level","low-priority","\"-----BEGIN EC PRIVATE KEY-----...\"","example"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-certificate-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all Certificates in a workspace",["17"],"1bdc11c095941","get","/{workspace}/certificates",["18"],{},"list-certificate-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Certificates",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],["41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"00dbd660d0e69","1dc0ab0b101a1","200",[],["48"],"A successful response listing Certificates","75f0ace7d3952","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"71","examples":"72","description":"73","required":true,"schema":"74","explicitProperties":"75"},{"id":"76","key":"77","extensions":"78","description":"79","type":"80","name":"81","in":"82"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"83","path":"84","port":"85","protocol":"86"},{"id":"87","mediaType":"88","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"88","examples":"93","encodings":"94","schema":"95"},"ee1de00d4e19f","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103"],"5e123fd29155a","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"104","$schema":"97","x-stoplight":"105"},["99","100","101","102","103"],"4ec1962fda2fb","tags",["106"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"104","examples":"107","x-stoplight":"108","$schema":"97"},["99","109","100","101","102","103"],"24b953a9334e6","workspace","simple",[],"Name or ID of workspace",{"type":"104","examples":"110","$schema":"97","x-stoplight":"111"},["101","100","112","102","99","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"0fbadd53952de","application/json",[],[],{"properties":"122","$schema":"97","x-stoplight":"123"},"7231448640060",["124","125","126"],[],{"type":"127","properties":"128","required":"129","title":"130","$schema":"97","x-stoplight":"131"},"integer","http://json-schema.org/draft-07/schema#",{"id":"132"},"description","in","name","schema","title","string",{"id":"133"},{"id":"134","value":"135","key":"136"},["135"],{"explicitProperties":"137","id":"138"},"example",["139"],{"id":"140"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","141"],{"data":"142","offset":"143"},{"id":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},"object",{"status":"157","message":"158"},["159","160"],"UnauthorizedError",{"id":"161"},"88c50faf942c0","696e00613b7de","f364438f449f5","tag1,tag2","default",["162","163","164"],"b6468ba783b57","team-a","6175b563b7f39","https",{"items":"165","type":"166"},{"description":"167","type":"104","title":"168"},"fa899ac5ad096","cebbc5060ec1b","DuplicateApiKey",{"message":"148","status":401},"Duplicate API key found","617c5039f9793","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","7588e8df42e99","NoAPIKey",{"message":"169","status":401},"No API key found",{"type":"96"},{"type":"104"},"status","message","470b68e5f0549","type","nullable","examples",{"description":"170","properties":"171","type":"127","title":"172","examples":"173","$schema":"97","x-stoplight":"174"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","No API key found in request","A certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service. Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames. If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string according to the following order, main certificate on the top, followed by any intermediates.",{"cert":"175","cert_alt":"176","created_at":"177","id":"178","key":"179","key_alt":"180","tags":"181","updated_at":"182","snis":"183"},"Certificate",["184"],{"id":"185"},{"description":"186","type":"104"},{"description":"187","type":"104"},{"description":"188","type":"96"},{"type":"104"},{"description":"189","type":"104"},{"description":"190","type":"104"},{"description":"191","items":"192","type":"166"},{"description":"193","type":"96"},{"description":"194","type":"166","items":"195"},{"cert":"196","id":"197","key":"198"},"18061f7aa351f","PEM-encoded public certificate chain of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","Unix epoch when the resource was created.","PEM-encoded private key of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","An optional set of strings associated with the Certificate for grouping and filtering.",{"type":"104"},"Unix epoch when the resource was last updated.","A list of SNIs associated with the certificate.\n",{"type":"104","format":"199"},"-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f269","-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----","hostname"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-certificate-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new Certificate in a workspace",["17"],"f00d9c3350f56","post","/{workspace}/certificates",["18"],{},"create-certificate-in-workspace","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Certificates",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48"],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"00dbd660d0e69","c85eafc647201","200",[],["55"],"Successfully created Certificate","5dbeb057b7ddf","400",[],["56"],"Invalid Certificate","5daeb057b7c0c","401",[],["57"],"Unauthorized","004cff13abae5",["58"],"The certificate request body",{"id":"59","name":"60","style":"61","examples":"62","description":"63","required":true,"schema":"64","explicitProperties":"65"},{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},{"id":"86","mediaType":"78","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"78","examples":"91","encodings":"92","schema":"93"},"41374c3bcf76c","workspace","simple",[],"Name or ID of workspace",{"type":"94","examples":"95","$schema":"96","x-stoplight":"97"},["98","99","100","101","102","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111","enum":"112"},"562e19199e005","application/json",["113"],[],{"description":"114","properties":"115","type":"116","title":"117","examples":"118","$schema":"96","x-stoplight":"119"},"d474249262829",[],[],{"type":"116","$schema":"96","x-stoplight":"120"},"855014d79319f",["121","122","123"],[],{"type":"116","properties":"124","required":"125","title":"126","$schema":"96","x-stoplight":"127"},"2ea426cb46c5f",[],[],{"type":"116","x-examples":"128","properties":"129","required":"130","$schema":"96","x-stoplight":"131"},"string",["132"],"http://json-schema.org/draft-07/schema#",{"id":"133"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["110","134"],{"id":"135","value":"136","key":"137"},"A certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service. Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames. If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string according to the following order, main certificate on the top, followed by any intermediates.",{"cert":"138","cert_alt":"139","created_at":"140","id":"141","key":"142","key_alt":"143","tags":"144","updated_at":"145","snis":"146"},"object","Certificate",["136"],{"id":"147"},{"id":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},{"id":"157","key":"158","value":"159","summary":"160"},{"status":"161","message":"162"},["163","164"],"UnauthorizedError",{"id":"165"},{"Example":"166"},{"cert":"167","key":"168","cert_alt":"169","key_alt":"170","snis":"171","tags":"172","passphrase":"173"},["174","175"],{"id":"176"},"team-a","ecfb092fdc7d6","https","20c6456d59b83",{"cert":"177","id":"178","key":"179"},"default",{"description":"180","type":"94"},{"description":"181","type":"94"},{"description":"182","type":"183"},{"type":"94"},{"description":"184","type":"94"},{"description":"185","type":"94"},{"description":"186","items":"187","type":"188"},{"description":"189","type":"183"},{"description":"190","type":"188","items":"191"},"18061f7aa351f","8de3982dee5e4","c25135805d960","DuplicateApiKey",{"message":"152","status":401},"Duplicate API key found","76068ebfe0a2f","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","58daa43a89578","NoAPIKey",{"message":"192","status":401},"No API key found",{"type":"183"},{"type":"94"},"status","message","470b68e5f0549",{"id":"193","created_at":1422386534,"cert":"194","key":"195","cert_alt":"194","key_alt":"196","snis":"197","tags":"198"},{"type":"94","description":"199","examples":"200"},{"type":"94","description":"201","examples":"202"},{"type":"94","description":"203"},{"type":"94","description":"204","examples":"205"},{"type":"188","description":"206","items":"207"},{"type":"188","description":"208","items":"209"},{"type":"94","description":"210","examples":"211"},"cert","key","dabf7736eb930","-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f269","-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----","PEM-encoded public certificate chain of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","Unix epoch when the resource was created.","integer","PEM-encoded private key of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","An optional set of strings associated with the Certificate for grouping and filtering.",{"type":"94"},"array","Unix epoch when the resource was last updated.","A list of SNIs associated with the certificate.\n",{"type":"94","format":"212"},"No API key found in request","7fca84d6-7d37-4a74-a7b0-93e576089a41","-----BEGIN CERTIFICATE-----...","-----BEGIN RSA PRIVATE KEY-----...","-----BEGIN EC PRIVATE KEY-----...",["213","214"],["215","216"],"PEM-encoded public certificate chain of the SSL key pair.",["194"],"PEM-encoded private key of the SSL key pair.",["195"],"PEM-encoded public certificate chain of the alternate SSL key pair.","PEM-encoded private key of the alternate SSL key pair.",["217"],"An array of zero or more hostnames to associate with this certificate as SNIs.",{"type":"94"},"An optional set of strings associated with the Certificate for grouping and filtering.\n",{"type":"94"},"To load an encrypted private key into Kong, specify the passphrase using this attributKong will decrypt the private key and store it in its database. e. Enterprise Only",["218"],"hostname","foo.test","example.com","user-level","low-priority","\"-----BEGIN EC PRIVATE KEY-----...\"","example"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-certificate-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a Certificate in a workspace",["17"],"18e4a719a0b8b","delete","/{workspace}/certificates/{certificate_id}",["18"],{},"delete-certificate-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Certificates",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38","39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"00dbd660d0e69","0c5b4514d09e3","204",[],[],"Successfully deleted Certificate or the resource didn't exist","018b45b78c642","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","name":"55","style":"49","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","key":"61","extensions":"62","description":"63","type":"64","name":"65","in":"66"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"67","path":"68","port":"69","protocol":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},"6e150e069a98f","workspace","simple",[],"Name or ID of workspace",{"type":"76","examples":"77","$schema":"78","x-stoplight":"79"},["80","81","82","83","84","85"],"f25c1221d71d0","certificate_id",[],"The unique identifier of the Certificate to retrieve.",{"type":"76","examples":"86","$schema":"78","x-stoplight":"87"},["80","81","82","83","84","85"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95","enum":"96"},"aa22b3f3d0343","application/json",["97","98","99"],[],{"type":"100","properties":"101","required":"102","title":"103","$schema":"78","x-stoplight":"104"},"string",["105"],"http://json-schema.org/draft-07/schema#",{"id":"106"},"name","in","required","schema","description","title",["107"],{"id":"108"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["94","109"],{"id":"110","key":"111","value":"112","summary":"113"},{"id":"114","key":"115","value":"116","summary":"117"},{"id":"118","key":"119","value":"120","summary":"121"},"object",{"status":"122","message":"123"},["124","125"],"UnauthorizedError",{"id":"126"},"team-a","be1a727236074","7fca84d6-7d37-4a74-a7b0-93e576089a41\"","d6ff63aa2829a","https","376cada340671","DuplicateApiKey",{"message":"113","status":401},"Duplicate API key found","0368bae3b5fe7","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","6fa25fbcc74ea","NoAPIKey",{"message":"127","status":401},"No API key found",{"type":"128"},{"type":"76"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-certificate-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a Certificate in a workspace",["18"],"eb3c007c4f1e1","get","/{workspace}/certificates/{certificate_id}",["19"],{},"get-certificate-in-workspace","Get a Certificate using ID in a workspace.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Certificates",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46"],["47"],{"id":"48","url":"49","name":"50","description":"51","variables":"52"},"00dbd660d0e69","789e6a01ce997","200",[],["53"],"Successfully fetched Certificate","506e683c24af7","401",[],["54"],"Unauthorized","50be683c25368","404",[],[],"Resource does not exist",{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"57","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"7e590e8051803","workspace","simple",[],"Name or ID of workspace",{"type":"88","examples":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96","97"],"c7fd17464a8f8","certificate_id",[],"The unique identifier of the Certificate to retrieve.",{"type":"88","examples":"98","$schema":"90","x-stoplight":"99"},["92","93","94","95","96","97"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107","enum":"108"},"86735843edaab","application/json",["109"],[],{"description":"110","properties":"111","type":"112","title":"113","examples":"114","$schema":"90","x-stoplight":"115"},"7a8b8830a90ef",["116","117","118"],[],{"type":"112","properties":"119","required":"120","title":"121","$schema":"90","x-stoplight":"122"},"string",["123"],"http://json-schema.org/draft-07/schema#",{"id":"124"},"name","in","required","schema","description","title",["125"],{"id":"126"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["106","127"],{"id":"128","value":"129","key":"130"},"A certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service. Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames. If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string according to the following order, main certificate on the top, followed by any intermediates.",{"cert":"131","cert_alt":"132","created_at":"133","id":"134","key":"135","key_alt":"136","tags":"137","updated_at":"138","snis":"139"},"object","Certificate",["129"],{"id":"140"},{"id":"141","key":"142","value":"143","summary":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"status":"153","message":"154"},["155","156"],"UnauthorizedError",{"id":"157"},"team-a","71785391265ed","7fca84d6-7d37-4a74-a7b0-93e576089a41\"","53c04278e94ea","https","ee4c1c53f1be9",{"cert":"158","id":"159","key":"160"},"default",{"description":"161","type":"88"},{"description":"162","type":"88"},{"description":"163","type":"164"},{"type":"88"},{"description":"165","type":"88"},{"description":"166","type":"88"},{"description":"167","items":"168","type":"169"},{"description":"170","type":"164"},{"description":"171","type":"169","items":"172"},"18061f7aa351f","074529ec85e5f","DuplicateApiKey",{"message":"144","status":401},"Duplicate API key found","2e859efaa8daf","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","5f19cd0fef6ce","NoAPIKey",{"message":"173","status":401},"No API key found",{"type":"164"},{"type":"88"},"status","message","470b68e5f0549","-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f269","-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----","PEM-encoded public certificate chain of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","Unix epoch when the resource was created.","integer","PEM-encoded private key of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","An optional set of strings associated with the Certificate for grouping and filtering.",{"type":"88"},"array","Unix epoch when the resource was last updated.","A list of SNIs associated with the certificate.\n",{"type":"88","format":"174"},"No API key found in request","hostname"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-certificate-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update a Certificate in a workspace",["17"],"64949b6c326b3","patch","/{workspace}/certificates/{certificate_id}",["18"],{},"update-certificate-in-workspace","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Certificates",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","required":true,"description":"53"},[],[],[],["54","55"],["56"],{"id":"57","url":"58","name":"59","description":"60","variables":"61"},"00dbd660d0e69","5e48b85052d53","200",[],["62"],"Successfully updated Certificate","b668ba2d1562b","400",[],["63"],"Invalid Certificate","b678ba2d1505c","401",[],["64"],"Unauthorized","b628ba2d149df","404",[],[],"Resource does not exist","91dbbc9e54cfc",["65"],"Fields of the Certificate that need to be updated",{"id":"66","name":"67","style":"68","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","name":"74","style":"68","examples":"75","description":"76","required":true,"schema":"77","explicitProperties":"78"},{"id":"79","key":"80","extensions":"81","description":"82","type":"83","name":"84","in":"85"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"86","path":"87","port":"88","protocol":"89"},{"id":"90","mediaType":"91","examples":"92","encodings":"93","schema":"94"},{"id":"95","mediaType":"91","examples":"96","encodings":"97","schema":"98"},{"id":"99","mediaType":"91","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"91","examples":"104","encodings":"105","schema":"94"},"d1285ece0ba2f","workspace","simple",[],"Name or ID of workspace",{"type":"106","examples":"107","$schema":"108","x-stoplight":"109"},["110","111","112","113","114","115"],"ef28c84516f41","certificate_id",[],"The unique identifier of the Certificate to retrieve.",{"type":"106","examples":"116","$schema":"108","x-stoplight":"117"},["110","111","112","113","114","115"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"118","description":"119"},{"default":"120","description":"121"},{"default":"122","description":"123"},{"default":"124","description":"125","enum":"126"},"ebf1c1b42f8d7","application/json",["127"],[],{"description":"128","properties":"129","type":"130","title":"131","examples":"132","$schema":"108","x-stoplight":"133"},"e156a9d9f99b2",[],[],{"type":"130","$schema":"108","x-stoplight":"134"},"3a5688a3e06e6",["135","136","137"],[],{"type":"130","properties":"138","required":"139","title":"140","$schema":"108","x-stoplight":"141"},"0bc317ecb4fcd",["142"],[],"string",["143"],"http://json-schema.org/draft-07/schema#",{"id":"144"},"name","in","required","schema","description","title",["145"],{"id":"146"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["124","147"],{"id":"148","value":"149","key":"150"},"A certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service. Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames. If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string according to the following order, main certificate on the top, followed by any intermediates.",{"cert":"151","cert_alt":"152","created_at":"153","id":"154","key":"155","key_alt":"156","tags":"157","updated_at":"158","snis":"159"},"object","Certificate",["149"],{"id":"160"},{"id":"161"},{"id":"162","key":"163","value":"164","summary":"165"},{"id":"166","key":"167","value":"168","summary":"169"},{"id":"170","key":"171","value":"172","summary":"173"},{"status":"174","message":"175"},["176","177"],"UnauthorizedError",{"id":"178"},{"id":"179","value":"149","key":"150"},"team-a","fa3c92d638411","7fca84d6-7d37-4a74-a7b0-93e576089a41\"","4727387baad06","https","36247f15d2d1e",{"cert":"180","id":"181","key":"182"},"default",{"description":"183","type":"106"},{"description":"184","type":"106"},{"description":"185","type":"186"},{"type":"106"},{"description":"187","type":"106"},{"description":"188","type":"106"},{"description":"189","items":"190","type":"191"},{"description":"192","type":"186"},{"description":"193","type":"191","items":"194"},"18061f7aa351f","d10c4940e2d4c","27fe11ef9b3d6","DuplicateApiKey",{"message":"165","status":401},"Duplicate API key found","3b65e94ec23bc","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","f66a93871d3e9","NoAPIKey",{"message":"195","status":401},"No API key found",{"type":"186"},{"type":"106"},"status","message","470b68e5f0549","742fad8cbc6dd","-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f269","-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----","PEM-encoded public certificate chain of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","Unix epoch when the resource was created.","integer","PEM-encoded private key of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","An optional set of strings associated with the Certificate for grouping and filtering.",{"type":"106"},"array","Unix epoch when the resource was last updated.","A list of SNIs associated with the certificate.\n",{"type":"106","format":"196"},"No API key found in request","hostname"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-certificate-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a Certificate in a workspace",["18"],"b301c51d2a4a6","put","/{workspace}/certificates/{certificate_id}",["19"],{},"upsert-certificate-in-workspace","Create or Update Certificate using ID in a workspace.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Certificates",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","required":true,"description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"00dbd660d0e69","7228b82b79bac","200",[],["57"],"Successfully upserted Certificate","ca48ba083b820","400",[],["58"],"Invalid Certificate","ca58ba083c677","401",[],["59"],"Unauthorized","3d3e245fada09",["60"],"Description of the Certificate",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"89"},"a5f36a7cc7321","workspace","simple",[],"Name or ID of workspace",{"type":"101","examples":"102","$schema":"103","x-stoplight":"104"},["105","106","107","108","109","110"],"a9342993bdd01","certificate_id",[],"The unique identifier of the Certificate to retrieve.",{"type":"101","examples":"111","$schema":"103","x-stoplight":"112"},["105","106","107","108","109","110"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"2f6377d20d031","application/json",["122"],[],{"description":"123","properties":"124","type":"125","title":"126","examples":"127","$schema":"103","x-stoplight":"128"},"d068f6ba9924f",[],[],{"type":"125","$schema":"103","x-stoplight":"129"},"f05e7848e8eb9",["130","131","132"],[],{"type":"125","properties":"133","required":"134","title":"135","$schema":"103","x-stoplight":"136"},"0cbfaffa11b93",["137"],[],"string",["138"],"http://json-schema.org/draft-07/schema#",{"id":"139"},"name","in","required","schema","description","title",["140"],{"id":"141"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","142"],{"id":"143","value":"144","key":"145"},"A certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service. Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames. If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string according to the following order, main certificate on the top, followed by any intermediates.",{"cert":"146","cert_alt":"147","created_at":"148","id":"149","key":"150","key_alt":"151","tags":"152","updated_at":"153","snis":"154"},"object","Certificate",["144"],{"id":"155"},{"id":"156"},{"id":"157","key":"158","value":"159","summary":"160"},{"id":"161","key":"162","value":"163","summary":"164"},{"id":"165","key":"166","value":"167","summary":"168"},{"status":"169","message":"170"},["171","172"],"UnauthorizedError",{"id":"173"},{"id":"174","value":"144","key":"145"},"team-a","4e613199279b9","7fca84d6-7d37-4a74-a7b0-93e576089a41\"","27188035170d8","https","5c8fee7e9e0e3",{"cert":"175","id":"176","key":"177"},"default",{"description":"178","type":"101"},{"description":"179","type":"101"},{"description":"180","type":"181"},{"type":"101"},{"description":"182","type":"101"},{"description":"183","type":"101"},{"description":"184","items":"185","type":"186"},{"description":"187","type":"181"},{"description":"188","type":"186","items":"189"},"18061f7aa351f","c8cb63382a868","e15f641175912","DuplicateApiKey",{"message":"160","status":401},"Duplicate API key found","16ab43b1e7031","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","30a6333d8f710","NoAPIKey",{"message":"190","status":401},"No API key found",{"type":"181"},{"type":"101"},"status","message","470b68e5f0549","d3b3cc7eedbd6","-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f269","-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----","PEM-encoded public certificate chain of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","Unix epoch when the resource was created.","integer","PEM-encoded private key of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","An optional set of strings associated with the Certificate for grouping and filtering.",{"type":"101"},"array","Unix epoch when the resource was last updated.","A list of SNIs associated with the certificate.\n",{"type":"101","format":"191"},"No API key found in request","hostname"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-sni-with-certificate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all SNIs associated with a Certificate",["18"],"7c36a56e51000","get","/certificates/{certificate_name_or_id}/snis",["19"],{},"list-sni-with-certificate","Retrieve a paginated list of all SNIs associated with a certificate. Use this endpoint to retrieve a list of SNIs that are linked to a specific certificate. You can use the optional query parameters to filter the results based on specific criteria. The response will include the list of SNIs and pagination information. See the response schema for details on the expected format of the response body.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"SNIs",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40","41"],[],["42"],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"89ee93e7858c2","746c531607288","200",[],["49"],"A successful response listing SNIs","09bc53a7774b5","401",[],["50"],"Unauthorized",{"id":"51","name":"52","style":"53","examples":"54","description":"55","schema":"56","explicitProperties":"57"},{"id":"58","name":"59","style":"53","examples":"60","description":"61","schema":"62","explicitProperties":"63"},{"id":"64","name":"65","style":"53","examples":"66","description":"67","schema":"68","explicitProperties":"69"},{"id":"70","name":"71","style":"72","examples":"73","description":"74","required":true,"schema":"75","explicitProperties":"76"},{"id":"77","key":"78","extensions":"79","description":"80","type":"81","name":"82","in":"83"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"84","path":"85","port":"86","protocol":"87"},{"id":"88","mediaType":"89","examples":"90","encodings":"91","schema":"92"},{"id":"93","mediaType":"89","examples":"94","encodings":"95","schema":"96"},"80800c6f0ee25","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"97","$schema":"98","x-stoplight":"99"},["100","101","102","103","104"],"51a646a66fdc7","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"105","$schema":"98","x-stoplight":"106"},["100","101","102","103","104"],"519c561b5ef82","tags",["107"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"105","examples":"108","x-stoplight":"109","$schema":"98"},["100","110","101","102","103","104"],"a7246ebd5e9da","certificate_name_or_id","simple",[],"The unique identifier or the `name` attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",{"type":"105","enum":"111","examples":"112","$schema":"98","x-stoplight":"113"},["102","101","114","103","100"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120"},{"default":"121","description":"122","enum":"123"},"3abb2bcf565aa","application/json",[],[],{"properties":"124","$schema":"98","x-stoplight":"125"},"1560ca736384f",["126","127","128"],[],{"type":"129","properties":"130","required":"131","title":"132","$schema":"98","x-stoplight":"133"},"integer","http://json-schema.org/draft-07/schema#",{"id":"134"},"description","in","name","schema","title","string",{"id":"135"},{"id":"136","value":"137","key":"138"},["137"],{"explicitProperties":"139","id":"140"},"example",["141","102"],["102"],{"id":"142"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["121","143"],{"data":"144","offset":"145"},{"id":"146"},{"id":"147","key":"148","value":"149","summary":"150"},{"id":"151","key":"152","value":"153","summary":"154"},{"id":"155","key":"156","value":"157","summary":"158"},"object",{"status":"159","message":"160"},["161","162"],"UnauthorizedError",{"id":"163"},"22f7f07f13bc7","cdc003b06525f","84ef31f65ca7f","tag1,tag2","default",["164","165","166"],"69214c2be3f1a","a3ad71a8-6685-4b03-a101-980a953544f6","6e08fb38beff6","https",{"items":"167","type":"168"},{"description":"169","type":"105","title":"170"},"62217edc55287","373ed4b0a090e","DuplicateApiKey",{"message":"150","status":401},"Duplicate API key found","9dadfe843e755","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","add6246a605a5","NoAPIKey",{"message":"171","status":401},"No API key found",{"type":"97"},{"type":"105"},"status","message","470b68e5f0549","type","nullable","examples",{"description":"172","properties":"173","type":"129","title":"174","examples":"175"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","No API key found in request","An SNI object represents a many-to-one mapping of hostnames to a certificate. That is, a certificate object can have many hostnames associated with it; when Kong receives an SSL request, it uses the SNI field in the Client Hello to lookup the certificate object based on the SNI associated with the certificate.",{"certificate":"176","created_at":"177","id":"178","name":"179","tags":"180","updated_at":"181"},"SNI",["182"],{"additionalProperties":false,"description":"183","properties":"184","type":"129"},{"description":"185","type":"97"},{"type":"105"},{"description":"186","type":"105"},{"description":"187","items":"188","type":"168"},{"description":"189","type":"97"},{"certificate":"190","id":"191","name":"192"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.",{"id":"193"},"Unix epoch when the resource was created.","The SNI name to associate with the given certificate.","An optional set of strings associated with the SNIs for grouping and filtering.",{"type":"105"},"Unix epoch when the resource was last updated.",{"id":"194"},"36c4566c-14cc-4132-9011-4139fcbbe50a","some.example.org",{"type":"105"},"bd380f99-659d-415e-b0e7-72ea05df3218"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-sni-with-certificate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create a new SNI associated with a Certificate",["18"],"15c1dac304856","post","/certificates/{certificate_name_or_id}/snis",["19"],{},"create-sni-with-certificate","Create a new SNI and associate it with a certificate in the system. Use this endpoint to add a new SNI to the system and link it to a specific certificate.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"SNIs",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"89ee93e7858c2","a8249f059a2be","200",[],["56"],"Successfully created SNI","6d849fae23765","400",[],["57"],"Invalid SNI","6d749fae231d6","401",[],["58"],"Unauthorized","512f2608ecd52",["59"],"A JSON object containing the details of the new SNI, including the name, certificate, and tags.",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"79","examples":"84","encodings":"85","schema":"86"},{"id":"87","mediaType":"79","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"79","examples":"92","encodings":"93","schema":"94"},"78d1aee4edbe1","certificate_name_or_id","simple",[],"The unique identifier or the `name` attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",{"type":"95","enum":"96","examples":"97","$schema":"98","x-stoplight":"99"},["100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110"},{"default":"111","description":"112","enum":"113"},"8b7abaebdb29f","application/json",["114"],[],{"description":"115","properties":"116","type":"117","title":"118","examples":"119"},"9e304428ce98d",[],[],{"type":"117","$schema":"98","x-stoplight":"120"},"fe914cb88ec02",["121","122","123"],[],{"type":"117","properties":"124","required":"125","title":"126","$schema":"98","x-stoplight":"127"},"d2f7a57393ac4",[],[],{"type":"117","x-examples":"128","properties":"129","required":"130","$schema":"98","x-stoplight":"131"},"string",["132","100"],["100"],"http://json-schema.org/draft-07/schema#",{"id":"133"},"name","in","required","schema","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["111","134"],{"id":"135","value":"136","key":"137"},"An SNI object represents a many-to-one mapping of hostnames to a certificate. That is, a certificate object can have many hostnames associated with it; when Kong receives an SSL request, it uses the SNI field in the Client Hello to lookup the certificate object based on the SNI associated with the certificate.",{"certificate":"138","created_at":"139","id":"140","name":"141","tags":"142","updated_at":"143"},"object","SNI",["136"],{"id":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},{"status":"157","message":"158"},["159","160"],"UnauthorizedError",{"id":"161"},{"Example 1":"162"},{"name":"163","tags":"164","certificate":"165"},["100","166"],{"id":"167"},"a3ad71a8-6685-4b03-a101-980a953544f6","991871813a2df","https","9db500c6ca3b7",{"certificate":"168","id":"169","name":"170"},"default",{"additionalProperties":false,"description":"171","properties":"172","type":"117"},{"description":"173","type":"174"},{"type":"95"},{"description":"175","type":"95"},{"description":"176","items":"177","type":"178"},{"description":"179","type":"174"},"005ceb704bd61","af9256cc869af","DuplicateApiKey",{"message":"148","status":401},"Duplicate API key found","c386a35f72dcb","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","de4f1764a03ff","NoAPIKey",{"message":"180","status":401},"No API key found",{"type":"174"},{"type":"95"},"status","message","470b68e5f0549",{"name":"181","tags":"182","certificate":"183"},{"type":"95","description":"175","examples":"184"},{"type":"178","description":"185","items":"186"},{"type":"117","description":"187","properties":"188"},"certificate","de9cb28ac0ad1",{"id":"189"},"36c4566c-14cc-4132-9011-4139fcbbe50a","some.example.org","The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.",{"id":"190"},"Unix epoch when the resource was created.","integer","The SNI name to associate with the given certificate.","An optional set of strings associated with the SNIs for grouping and filtering.",{"type":"95"},"array","Unix epoch when the resource was last updated.","No API key found in request","my-sni",["191","192"],{"id":"193"},["181"],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"95","examples":"194"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object. With form-encoded, the notation is `certificate.id=<certificate id>`. With JSON, use `\"certificate\":{\"id\":\"<certificate id>\"}`.",{"id":"195"},"bd380f99-659d-415e-b0e7-72ea05df3218",{"type":"95"},"user-level","low-priority","a2e013e8-7623-4494-a347-6d29108ff68b",["196"],{"type":"95","description":"197","examples":"198"},"[\"user-level\", \"low-priority\"]","91020192-062d-416f-a275-9addeeaffaf2",["197"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-sni-with-cert",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a an SNI associated with a Certificate",["18"],"9772f84da988a","delete","/certificates/{certificate_id}/snis/{sni_name_or_id}",["19"],{},"delete-sni-with-cert","Delete a an SNI associated with a Certificate using ID or name.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"SNIs",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"89ee93e7858c2","2d0c28b9170b6","204",[],[],"Successfully deleted SNI or the resource didn't exist","84dc2a95d95bd","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"50","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},"a0dbc265646c4","certificate_id","simple",[],"The unique identifier of the Certificate to retrieve.",{"type":"77","examples":"78","$schema":"79","x-stoplight":"80"},["81","82","83","84","85","86"],"bef8946da309c","sni_name_or_id",[],"The unique identifier or the name of the SNI to retrieve.",{"type":"77","examples":"87","$schema":"79","x-stoplight":"88"},["81","82","83","84","85","86"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"89","description":"90"},{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96","enum":"97"},"248e1459078ee","application/json",["98","99","100"],[],{"type":"101","properties":"102","required":"103","title":"104","$schema":"79","x-stoplight":"105"},"string",["106"],"http://json-schema.org/draft-07/schema#",{"id":"107"},"name","in","required","schema","description","title",["108"],{"id":"109"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["95","110"],{"id":"111","key":"112","value":"113","summary":"114"},{"id":"115","key":"116","value":"117","summary":"118"},{"id":"119","key":"120","value":"121","summary":"122"},"object",{"status":"123","message":"124"},["125","126"],"UnauthorizedError",{"id":"127"},"7fca84d6-7d37-4a74-a7b0-93e576089a41\"","eabccaafa10e2","my-sni","e36740e0561ee","https","bdabfc9255a73","DuplicateApiKey",{"message":"114","status":401},"Duplicate API key found","9842d846be5f8","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","3a3a29ea3908e","NoAPIKey",{"message":"128","status":401},"No API key found",{"type":"129"},{"type":"77"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/fetch-sni-with-cert",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch an SNI associated with a Certificate",["18"],"64f72aa3a52a1","get","/certificates/{certificate_id}/snis/{sni_name_or_id}",["19"],{},"fetch-sni-with-cert","Get an SNI associated with a Certificate using ID or name.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"SNIs",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46"],["47"],{"id":"48","url":"49","name":"50","description":"51","variables":"52"},"89ee93e7858c2","73efb34edc398","200",[],["53"],"Successfully fetched SNI","1bbfb1721a767","401",[],["54"],"Unauthorized","1c0fb1721aed8","404",[],[],"Resource does not exist",{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"57","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"49b2b9b8f4729","certificate_id","simple",[],"The unique identifier of the Certificate to retrieve.",{"type":"88","examples":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96","97"],"df29416b2a22e","sni_name_or_id",[],"The unique identifier or the name of the SNI to retrieve.",{"type":"88","examples":"98","$schema":"90","x-stoplight":"99"},["92","93","94","95","96","97"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107","enum":"108"},"0d83a1d9c14cb","application/json",["109"],[],{"description":"110","properties":"111","type":"112","title":"113","examples":"114"},"1b44759f19019",["115","116","117"],[],{"type":"112","properties":"118","required":"119","title":"120","$schema":"90","x-stoplight":"121"},"string",["122"],"http://json-schema.org/draft-07/schema#",{"id":"123"},"name","in","required","schema","description","title",["124"],{"id":"125"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["106","126"],{"id":"127","value":"128","key":"129"},"An SNI object represents a many-to-one mapping of hostnames to a certificate. That is, a certificate object can have many hostnames associated with it; when Kong receives an SSL request, it uses the SNI field in the Client Hello to lookup the certificate object based on the SNI associated with the certificate.",{"certificate":"130","created_at":"131","id":"132","name":"133","tags":"134","updated_at":"135"},"object","SNI",["128"],{"id":"136","key":"137","value":"138","summary":"139"},{"id":"140","key":"141","value":"142","summary":"143"},{"id":"144","key":"145","value":"146","summary":"147"},{"status":"148","message":"149"},["150","151"],"UnauthorizedError",{"id":"152"},"7fca84d6-7d37-4a74-a7b0-93e576089a41\"","204007bfda2f9","my-sni","5a888b06a6040","https","7045b1e425531",{"certificate":"153","id":"154","name":"155"},"default",{"additionalProperties":false,"description":"156","properties":"157","type":"112"},{"description":"158","type":"159"},{"type":"88"},{"description":"160","type":"88"},{"description":"161","items":"162","type":"163"},{"description":"164","type":"159"},"9613562f71524","DuplicateApiKey",{"message":"139","status":401},"Duplicate API key found","773959bbb2d4e","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","6c9c9b61ebfd9","NoAPIKey",{"message":"165","status":401},"No API key found",{"type":"159"},{"type":"88"},"status","message","470b68e5f0549",{"id":"166"},"36c4566c-14cc-4132-9011-4139fcbbe50a","some.example.org","The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.",{"id":"167"},"Unix epoch when the resource was created.","integer","The SNI name to associate with the given certificate.","An optional set of strings associated with the SNIs for grouping and filtering.",{"type":"88"},"array","Unix epoch when the resource was last updated.","No API key found in request","bd380f99-659d-415e-b0e7-72ea05df3218",{"type":"88"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-sni-with-cert",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a an SNI associated with a Certificate",["18"],"9bd49dbe72d4f","patch","/certificates/{certificate_id}/snis/{sni_name_or_id}",["19"],{},"update-sni-with-cert","Update an existing SNI associated with a certificate in the system using the SNI ID or name. The request body should include the fields of the SNI that need to be updated, such as the name, description, or other properties. If the request body contains valid data, the endpoint will update the SNI and return a success response.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"SNIs",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55","56"],["57"],{"id":"58","url":"59","name":"60","description":"61","variables":"62"},"89ee93e7858c2","fc6e4b6fa3776","200",[],["63"],"Successfully updated SNI","370e4ac71a52e","400",[],["64"],"Invalid SNI","36fe4ac719b71","401",[],["65"],"Unauthorized","374e4ac71a3f2","404",[],[],"Resource does not exist","775f99298e49b",["66"],"A JSON object containing the details of the new SNI, including the name, certificate, and tags.",{"id":"67","name":"68","style":"69","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","name":"75","style":"69","examples":"76","description":"77","required":true,"schema":"78","explicitProperties":"79"},{"id":"80","key":"81","extensions":"82","description":"83","type":"84","name":"85","in":"86"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"87","path":"88","port":"89","protocol":"90"},{"id":"91","mediaType":"92","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"92","examples":"97","encodings":"98","schema":"99"},{"id":"100","mediaType":"92","examples":"101","encodings":"102","schema":"103"},{"id":"104","mediaType":"92","examples":"105","encodings":"106","schema":"107"},"c177352015804","certificate_id","simple",[],"The unique identifier of the Certificate to retrieve.",{"type":"108","examples":"109","$schema":"110","x-stoplight":"111"},["112","113","114","115","116","117"],"57ea6d84627ad","sni_name_or_id",[],"The unique identifier or the name of the SNI to retrieve.",{"type":"108","examples":"118","$schema":"110","x-stoplight":"119"},["112","113","114","115","116","117"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"120","description":"121"},{"default":"122","description":"123"},{"default":"124","description":"125"},{"default":"126","description":"127","enum":"128"},"1ca0a0aee6314","application/json",["129"],[],{"description":"130","properties":"131","type":"132","title":"133","examples":"134"},"7196ff2ec9124",[],[],{"type":"132","$schema":"110","x-stoplight":"135"},"6d9bf2e1de982",["136","137","138"],[],{"type":"132","properties":"139","required":"140","title":"141","$schema":"110","x-stoplight":"142"},"5536d68bef19b",[],[],{"type":"132","x-examples":"143","properties":"144","required":"145","$schema":"110","x-stoplight":"146"},"string",["147"],"http://json-schema.org/draft-07/schema#",{"id":"148"},"name","in","required","schema","description","title",["149"],{"id":"150"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["126","151"],{"id":"152","value":"153","key":"154"},"An SNI object represents a many-to-one mapping of hostnames to a certificate. That is, a certificate object can have many hostnames associated with it; when Kong receives an SSL request, it uses the SNI field in the Client Hello to lookup the certificate object based on the SNI associated with the certificate.",{"certificate":"155","created_at":"156","id":"157","name":"158","tags":"159","updated_at":"160"},"object","SNI",["153"],{"id":"161"},{"id":"162","key":"163","value":"164","summary":"165"},{"id":"166","key":"167","value":"168","summary":"169"},{"id":"170","key":"171","value":"172","summary":"173"},{"status":"174","message":"175"},["176","177"],"UnauthorizedError",{"id":"178"},{"Example 1":"179"},{"name":"180","tags":"181","certificate":"182"},["112","183"],{"id":"184"},"7fca84d6-7d37-4a74-a7b0-93e576089a41\"","0c051b20ddde7","my-sni","6747581f31524","https","b7dd561493330",{"certificate":"185","id":"186","name":"187"},"default",{"additionalProperties":false,"description":"188","properties":"189","type":"132"},{"description":"190","type":"191"},{"type":"108"},{"description":"192","type":"108"},{"description":"193","items":"194","type":"195"},{"description":"196","type":"191"},"f5fb0c59269d5","58c0ecc196fc3","DuplicateApiKey",{"message":"165","status":401},"Duplicate API key found","3bdf0275a03d5","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","a288deed6fabc","NoAPIKey",{"message":"197","status":401},"No API key found",{"type":"191"},{"type":"108"},"status","message","470b68e5f0549",{"name":"149","tags":"198","certificate":"199"},{"type":"108","description":"192","examples":"200"},{"type":"195","description":"201","items":"202"},{"type":"132","description":"203","properties":"204"},"certificate","de9cb28ac0ad1",{"id":"205"},"36c4566c-14cc-4132-9011-4139fcbbe50a","some.example.org","The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.",{"id":"206"},"Unix epoch when the resource was created.","integer","The SNI name to associate with the given certificate.","An optional set of strings associated with the SNIs for grouping and filtering.",{"type":"108"},"array","Unix epoch when the resource was last updated.","No API key found in request",["207","208"],{"id":"209"},["149"],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"108","examples":"210"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object. With form-encoded, the notation is `certificate.id=<certificate id>`. With JSON, use `\"certificate\":{\"id\":\"<certificate id>\"}`.",{"id":"211"},"bd380f99-659d-415e-b0e7-72ea05df3218",{"type":"108"},"user-level","low-priority","a2e013e8-7623-4494-a347-6d29108ff68b",["212"],{"type":"108","description":"213","examples":"214"},"[\"user-level\", \"low-priority\"]","91020192-062d-416f-a275-9addeeaffaf2",["213"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-sni-with-cert",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert an SNI associated with a Certificate",["18"],"71379390aa519","put","/certificates/{certificate_id}/snis/{sni_name_or_id}",["19"],{},"upsert-sni-with-cert","Create or Update an SNI associated with a Certificate using ID or name.\n\nInserts (or replaces) the SNI under the requested resource with the definition specified in the body. The SNI will be identified via the name or id attribute.\n\nWhen the name or id attribute has the structure of a UUID, the SNI being inserted/replaced will be identified by its id. Otherwise it will be identified by its name.\n\nWhen creating a new SNI without specifying id (neither in the URL nor in the body), then it will be auto-generated.\n","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"SNIs",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"89ee93e7858c2","ba3d6d4751b51","200",[],["57"],"Successfully upserted SNI","621d6b6a8f1ad","400",[],["58"],"Invalid SNI","620d6b6a8f05e","401",[],["59"],"Unauthorized","3f8de574f83c7",["60"],"A JSON object containing the details of the new SNI, including the name, certificate, and tags.",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"101"},"d5e84a78a9ed2","certificate_id","simple",[],"The unique identifier of the Certificate to retrieve.",{"type":"102","examples":"103","$schema":"104","x-stoplight":"105"},["106","107","108","109","110","111"],"6b5ed22adf3a4","sni_name_or_id",[],"The unique identifier or the name of the SNI to retrieve.",{"type":"102","examples":"112","$schema":"104","x-stoplight":"113"},["106","107","108","109","110","111"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121","enum":"122"},"a405fbe79c5e4","application/json",["123"],[],{"description":"124","properties":"125","type":"126","title":"127","examples":"128"},"3915b7f8028d2",[],[],{"type":"126","$schema":"104","x-stoplight":"129"},"06f9b34b29884",["130","131","132"],[],{"type":"126","properties":"133","required":"134","title":"135","$schema":"104","x-stoplight":"136"},"7ac48476520f6",[],[],{"type":"126","x-examples":"137","properties":"138","required":"139","$schema":"104","x-stoplight":"140"},"string",["141"],"http://json-schema.org/draft-07/schema#",{"id":"142"},"name","in","required","schema","description","title",["143"],{"id":"144"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["120","145"],{"id":"146","value":"147","key":"148"},"An SNI object represents a many-to-one mapping of hostnames to a certificate. That is, a certificate object can have many hostnames associated with it; when Kong receives an SSL request, it uses the SNI field in the Client Hello to lookup the certificate object based on the SNI associated with the certificate.",{"certificate":"149","created_at":"150","id":"151","name":"152","tags":"153","updated_at":"154"},"object","SNI",["147"],{"id":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"id":"160","key":"161","value":"162","summary":"163"},{"id":"164","key":"165","value":"166","summary":"167"},{"status":"168","message":"169"},["170","171"],"UnauthorizedError",{"id":"172"},{"Example 1":"173"},{"name":"174","tags":"175","certificate":"176"},["106","177"],{"id":"178"},"7fca84d6-7d37-4a74-a7b0-93e576089a41\"","55a28225e92a5","my-sni","2c5869c03639e","https","a37f457e03877",{"certificate":"179","id":"180","name":"181"},"default",{"additionalProperties":false,"description":"182","properties":"183","type":"126"},{"description":"184","type":"185"},{"type":"102"},{"description":"186","type":"102"},{"description":"187","items":"188","type":"189"},{"description":"190","type":"185"},"db8b1de42a929","a9de2cc7012ab","DuplicateApiKey",{"message":"159","status":401},"Duplicate API key found","672575a9a7544","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","9f7fb583c94fe","NoAPIKey",{"message":"191","status":401},"No API key found",{"type":"185"},{"type":"102"},"status","message","470b68e5f0549",{"name":"143","tags":"192","certificate":"193"},{"type":"102","description":"186","examples":"194"},{"type":"189","description":"195","items":"196"},{"type":"126","description":"197","properties":"198"},"certificate","de9cb28ac0ad1",{"id":"199"},"36c4566c-14cc-4132-9011-4139fcbbe50a","some.example.org","The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.",{"id":"200"},"Unix epoch when the resource was created.","integer","The SNI name to associate with the given certificate.","An optional set of strings associated with the SNIs for grouping and filtering.",{"type":"102"},"array","Unix epoch when the resource was last updated.","No API key found in request",["201","202"],{"id":"203"},["143"],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"102","examples":"204"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object. With form-encoded, the notation is `certificate.id=<certificate id>`. With JSON, use `\"certificate\":{\"id\":\"<certificate id>\"}`.",{"id":"205"},"bd380f99-659d-415e-b0e7-72ea05df3218",{"type":"102"},"user-level","low-priority","a2e013e8-7623-4494-a347-6d29108ff68b",["206"],{"type":"102","description":"207","examples":"208"},"[\"user-level\", \"low-priority\"]","91020192-062d-416f-a275-9addeeaffaf2",["207"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-sni",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all SNIs",["17"],"b8edff0f82f89","get","/snis",["18"],{},"list-sni","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"SNIs",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],[],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"89ee93e7858c2","e53fe7a489b96","200",[],["47"],"SNI response object","3d4fe9814c86e","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"51","examples":"64","description":"65","schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"ad9640fc047a0","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"88","$schema":"89","x-stoplight":"90"},["91","92","93","94","95"],"a688724be3aab","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"96","$schema":"89","x-stoplight":"97"},["91","92","93","94","95"],"90f8df11edac0","tags",["98"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"96","examples":"99","x-stoplight":"100","$schema":"89"},["91","101","92","93","94","95"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109","enum":"110"},"a694513ff4472","application/json",[],[],{"type":"111","x-examples":"112","properties":"113","$schema":"89","x-stoplight":"114"},"6227f359429ee",["115","116","117"],[],{"type":"111","properties":"118","required":"119","title":"120","$schema":"89","x-stoplight":"121"},"integer","http://json-schema.org/draft-07/schema#",{"id":"122"},"description","in","name","schema","title","string",{"id":"123"},{"id":"124","value":"125","key":"126"},["125"],{"explicitProperties":"127","id":"128"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["108","129"],"object",{"Example 1":"130"},{"data":"131","next":"132"},{"id":"133"},{"id":"134","key":"135","value":"136","summary":"137"},{"id":"138","key":"139","value":"140","summary":"141"},{"id":"142","key":"143","value":"144","summary":"145"},{"status":"146","message":"147"},["148","149"],"UnauthorizedError",{"id":"150"},"ec269c1c070e9","0c1be57cfea85","81e6f8f15fc6d","tag1,tag2","default",["151","152","153"],"1c67bbdb12466","https",{"data":"154","next":"155"},{"type":"156","description":"157","items":"158"},{"type":"96","description":"159","examples":"160"},"2fd950980b7e5","f2d67ef24f0be","DuplicateApiKey",{"message":"137","status":401},"Duplicate API key found","c382fae5707e0","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","f4de5bea712e3","NoAPIKey",{"message":"161","status":401},"No API key found",{"type":"88"},{"type":"96"},"status","message","470b68e5f0549","type","nullable","examples",["162","163"],"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","array","Array of SNIs",{"type":"111","properties":"164"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page",["155"],"No API key found in request",{"id":"165","name":"166","created_at":1422386534,"tags":"167","certificate":"168"},{"id":"169","name":"166","created_at":1422386534,"tags":"170","certificate":"171"},{"id":"172","name":"173","created_at":"174","tags":"175","certificate":"176"},"147f5ef0-1ed6-4711-b77f-489262f8bff7","my-sni",["177","178"],{"id":"179"},"b87eb55d-69a1-41d2-8653-8d706eecefc0",["180","181","182"],{"id":"183"},{"type":"96","description":"184","examples":"185"},{"type":"96","description":"186","examples":"187"},{"type":"88","description":"188","examples":"189"},{"type":"156","description":"190","items":"191"},{"type":"111","description":"192","properties":"193"},"user-level","low-priority","a3ad71a8-6685-4b03-a101-980a953544f6","admin","high-priority","critical","4e8d95d4-40f2-4818-adcb-30e00c349618","The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",["165"],"The SNI name to associate with the given certificate.\n",["166"],"Unix epoch when the resource was created.\n",[1422386534],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"96"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.\n",{"id":"194"},{"type":"96","description":"195","examples":"196"},"The unique identifier or the name attribute of the Certificate whose SNIs",["197"],"2e013e8-7623-4494-a347-6d29108ff68b"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-sni",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new SNI",["17"],"c7e5ac8d53d15","post","/snis",["18"],{},"create-sni","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"SNIs",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],[],["48"],{"id":"49","url":"50","name":"51","description":"52","variables":"53"},"89ee93e7858c2","4947b5b89850a","200",[],["54"],"SNI response object","f127b3dbd6f8b","400",[],["55"],"Invalid SNI","f117b3dbd6878","401",[],["56"],"Unauthorized","5af682786e7cf",["57"],"A JSON object containing the details of the new SNI, including the name, certificate, and tags.",{"id":"58","key":"59","extensions":"60","description":"61","type":"62","name":"63","in":"64"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"65","path":"66","port":"67","protocol":"68"},{"id":"69","mediaType":"70","examples":"71","encodings":"72","schema":"73"},{"id":"74","mediaType":"70","examples":"75","encodings":"76","schema":"77"},{"id":"78","mediaType":"70","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"70","examples":"83","encodings":"84","schema":"85"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"86","description":"87"},{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93","enum":"94"},"cdbd5f5309705","application/json",[],[],{"type":"95","x-examples":"96","properties":"97","$schema":"98","x-stoplight":"99"},"bcdee6e74ef23",[],[],{"type":"95","$schema":"98","x-stoplight":"100"},"d52d6ba59a6a0",["101","102","103"],[],{"type":"95","properties":"104","required":"105","title":"106","$schema":"98","x-stoplight":"107"},"6b27a3484e5f8",[],[],{"type":"95","x-examples":"108","properties":"109","required":"110","$schema":"98","x-stoplight":"111"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["92","112"],"object",{"Example 1":"113"},{"data":"114","next":"115"},"http://json-schema.org/draft-07/schema#",{"id":"116"},{"id":"117"},{"id":"118","key":"119","value":"120","summary":"121"},{"id":"122","key":"123","value":"124","summary":"125"},{"id":"126","key":"127","value":"128","summary":"129"},{"status":"130","message":"131"},["132","133"],"UnauthorizedError",{"id":"134"},{"Example 1":"135"},{"name":"136","tags":"137","certificate":"138"},["139","140"],{"id":"141"},"https",{"data":"142","next":"143"},{"type":"144","description":"145","items":"146"},{"type":"147","description":"148","examples":"149"},"2fd950980b7e5","7620caddc8c1c","66621fbbf4c79","DuplicateApiKey",{"message":"121","status":401},"Duplicate API key found","e24c2ab346883","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","1950b9c58b9bb","NoAPIKey",{"message":"150","status":401},"No API key found",{"type":"151"},{"type":"147"},"status","message","470b68e5f0549",{"name":"152","tags":"153","certificate":"154"},{"type":"147","description":"155","examples":"156"},{"type":"144","description":"157","items":"158"},{"type":"95","description":"159","properties":"160"},"name","certificate","de9cb28ac0ad1",["161","162"],"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","array","Array of SNIs",{"type":"95","properties":"163"},"string","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page",["143"],"No API key found in request","integer","my-sni",["164","165"],{"id":"166"},"The SNI name to associate with the given certificate.",["152"],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"147","examples":"167"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object. With form-encoded, the notation is `certificate.id=<certificate id>`. With JSON, use `\"certificate\":{\"id\":\"<certificate id>\"}`.",{"id":"168"},{"id":"169","name":"152","created_at":1422386534,"tags":"170","certificate":"171"},{"id":"172","name":"152","created_at":1422386534,"tags":"173","certificate":"174"},{"id":"175","name":"176","created_at":"177","tags":"178","certificate":"179"},"user-level","low-priority","a2e013e8-7623-4494-a347-6d29108ff68b",["180"],{"type":"147","description":"181","examples":"182"},"147f5ef0-1ed6-4711-b77f-489262f8bff7",["164","165"],{"id":"183"},"b87eb55d-69a1-41d2-8653-8d706eecefc0",["184","185","186"],{"id":"187"},{"type":"147","description":"188","examples":"189"},{"type":"147","description":"190","examples":"191"},{"type":"151","description":"192","examples":"193"},{"type":"144","description":"157","items":"194"},{"type":"95","description":"195","properties":"196"},"[\"user-level\", \"low-priority\"]","91020192-062d-416f-a275-9addeeaffaf2",["181"],"a3ad71a8-6685-4b03-a101-980a953544f6","admin","high-priority","critical","4e8d95d4-40f2-4818-adcb-30e00c349618","The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",["169"],"The SNI name to associate with the given certificate.\n",["152"],"Unix epoch when the resource was created.\n",[1422386534],{"type":"147"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.\n",{"id":"197"},{"type":"147","description":"198","examples":"199"},"The unique identifier or the name attribute of the Certificate whose SNIs",["200"],"2e013e8-7623-4494-a347-6d29108ff68b"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-sni",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete an SNI",["17"],"82f5dd65ee1cb","delete","/snis/{sni_name_or_id}",["18"],{},"delete-sni","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"SNIs",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38"],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"89ee93e7858c2","8d41553a5179b","204",[],[],"Successfully deleted SNI or the resource didn't exist","3551535d8fa2c","401",[],["45"],"Unauthorized",{"id":"46","name":"47","style":"48","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},{"id":"64","mediaType":"65","examples":"66","encodings":"67","schema":"68"},"6711852e8724d","sni_name_or_id","simple",[],"The unique identifier or the name of the SNI to retrieve.",{"type":"69","examples":"70","$schema":"71","x-stoplight":"72"},["73","74","75","76","77","78"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86","enum":"87"},"f6e65271ee941","application/json",["88","89","90"],[],{"type":"91","properties":"92","required":"93","title":"94","$schema":"71","x-stoplight":"95"},"string",["96"],"http://json-schema.org/draft-07/schema#",{"id":"97"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["85","98"],{"id":"99","key":"100","value":"101","summary":"102"},{"id":"103","key":"104","value":"105","summary":"106"},{"id":"107","key":"108","value":"109","summary":"110"},"object",{"status":"111","message":"112"},["113","114"],"UnauthorizedError",{"id":"115"},"my-sni","a6a23c8a7b8c6","https","49ae7a1e3670e","DuplicateApiKey",{"message":"102","status":401},"Duplicate API key found","77f0a70d4dee0","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","ed7eabe06647e","NoAPIKey",{"message":"116","status":401},"No API key found",{"type":"117"},{"type":"69"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-sni",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch an SNI",["18"],"eab2e3f2f1a3c","get","/snis/{sni_name_or_id}",["19"],{},"get-sni","Get an SNI using ID or name.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"SNIs",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45"],["46"],{"id":"47","url":"48","name":"49","description":"50","variables":"51"},"89ee93e7858c2","2a7e7edfc9271","200",[],["52"],"SNI response object","650e7e3740f6d","401",[],["53"],"Unauthorized","655e7e37407ee","404",[],[],"Resource does not exist",{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},{"id":"77","mediaType":"73","examples":"78","encodings":"79","schema":"80"},"92b7324e8887b","sni_name_or_id","simple",[],"The unique identifier or the name of the SNI to retrieve.",{"type":"81","examples":"82","$schema":"83","x-stoplight":"84"},["85","86","87","88","89","90"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"9ffdf411dab68","application/json",[],[],{"type":"100","x-examples":"101","properties":"102","$schema":"83","x-stoplight":"103"},"09b4758ebe09e",["104","105","106"],[],{"type":"100","properties":"107","required":"108","title":"109","$schema":"83","x-stoplight":"110"},"string",["111"],"http://json-schema.org/draft-07/schema#",{"id":"112"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","113"],"object",{"Example 1":"114"},{"data":"115","next":"116"},{"id":"117"},{"id":"118","key":"119","value":"120","summary":"121"},{"id":"122","key":"123","value":"124","summary":"125"},{"id":"126","key":"127","value":"128","summary":"129"},{"status":"130","message":"131"},["132","133"],"UnauthorizedError",{"id":"134"},"my-sni","b62543fd8ccdb","https",{"data":"135","next":"136"},{"type":"137","description":"138","items":"139"},{"type":"81","description":"140","examples":"141"},"2fd950980b7e5","2356fc81c3edd","DuplicateApiKey",{"message":"121","status":401},"Duplicate API key found","fdedd8362d39f","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","ea8bbb9ccd54f","NoAPIKey",{"message":"142","status":401},"No API key found",{"type":"143"},{"type":"81"},"status","message","470b68e5f0549",["144","145"],"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","array","Array of SNIs",{"type":"100","properties":"146"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page",["136"],"No API key found in request","integer",{"id":"147","name":"111","created_at":1422386534,"tags":"148","certificate":"149"},{"id":"150","name":"111","created_at":1422386534,"tags":"151","certificate":"152"},{"id":"153","name":"154","created_at":"155","tags":"156","certificate":"157"},"147f5ef0-1ed6-4711-b77f-489262f8bff7",["158","159"],{"id":"160"},"b87eb55d-69a1-41d2-8653-8d706eecefc0",["161","162","163"],{"id":"164"},{"type":"81","description":"165","examples":"166"},{"type":"81","description":"167","examples":"168"},{"type":"143","description":"169","examples":"170"},{"type":"137","description":"171","items":"172"},{"type":"100","description":"173","properties":"174"},"user-level","low-priority","a3ad71a8-6685-4b03-a101-980a953544f6","admin","high-priority","critical","4e8d95d4-40f2-4818-adcb-30e00c349618","The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",["147"],"The SNI name to associate with the given certificate.\n",["111"],"Unix epoch when the resource was created.\n",[1422386534],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"81"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.\n",{"id":"175"},{"type":"81","description":"176","examples":"177"},"The unique identifier or the name attribute of the Certificate whose SNIs",["178"],"2e013e8-7623-4494-a347-6d29108ff68b"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-sni",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update an SNI",["17"],"e5ee1c159eec5","patch","/snis/{sni_name_or_id}",["18"],{},"update-sni","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"SNIs",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54"],["55"],{"id":"56","url":"57","name":"58","description":"59","variables":"60"},"89ee93e7858c2","16ab36768fda7","200",[],["61"],"SNI response object","194b35d3c63a9","400",[],["62"],"Invalid SNI","195b35d3c61e6","401",[],["63"],"Unauthorized","198b35d3c649d","404",[],[],"Resource does not exist","2cdc8bfc8520e",["64"],"A JSON object containing the details of the new SNI, including the name, certificate, and tags.",{"id":"65","name":"66","style":"67","examples":"68","description":"69","required":true,"schema":"70","explicitProperties":"71"},{"id":"72","key":"73","extensions":"74","description":"75","type":"76","name":"77","in":"78"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"79","path":"80","port":"81","protocol":"82"},{"id":"83","mediaType":"84","examples":"85","encodings":"86","schema":"87"},{"id":"88","mediaType":"84","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"84","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"84","examples":"97","encodings":"98","schema":"99"},"4bac74d598c28","sni_name_or_id","simple",[],"The unique identifier or the name of the SNI to retrieve.",{"type":"100","examples":"101","$schema":"102","x-stoplight":"103"},["104","105","106","107","108","109"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"110","description":"111"},{"default":"112","description":"113"},{"default":"114","description":"115"},{"default":"116","description":"117","enum":"118"},"0b0be54241a89","application/json",[],[],{"type":"119","x-examples":"120","properties":"121","$schema":"102","x-stoplight":"122"},"bb6a5bc6bf26e",[],[],{"type":"119","$schema":"102","x-stoplight":"123"},"f3f26e7f69b36",["124","125","126"],[],{"type":"119","properties":"127","required":"128","title":"129","$schema":"102","x-stoplight":"130"},"9044602e292cb",[],[],{"type":"119","x-examples":"131","properties":"132","required":"133","$schema":"102","x-stoplight":"134"},"string",["135"],"http://json-schema.org/draft-07/schema#",{"id":"136"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["116","137"],"object",{"Example 1":"138"},{"data":"139","next":"140"},{"id":"141"},{"id":"142"},{"id":"143","key":"144","value":"145","summary":"146"},{"id":"147","key":"148","value":"149","summary":"150"},{"id":"151","key":"152","value":"153","summary":"154"},{"status":"155","message":"156"},["157","158"],"UnauthorizedError",{"id":"159"},{"Example 1":"160"},{"name":"161","tags":"162","certificate":"163"},["104","164"],{"id":"165"},"my-sni","971f4cc2077b3","https",{"data":"166","next":"167"},{"type":"168","description":"169","items":"170"},{"type":"100","description":"171","examples":"172"},"2fd950980b7e5","a38f30756b675","5a9253134b390","DuplicateApiKey",{"message":"146","status":401},"Duplicate API key found","da8f8941efc5c","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","75138909b8790","NoAPIKey",{"message":"173","status":401},"No API key found",{"type":"174"},{"type":"100"},"status","message","470b68e5f0549",{"name":"135","tags":"175","certificate":"176"},{"type":"100","description":"177","examples":"178"},{"type":"168","description":"179","items":"180"},{"type":"119","description":"181","properties":"182"},"certificate","de9cb28ac0ad1",["183","184"],"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","array","Array of SNIs",{"type":"119","properties":"185"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page",["167"],"No API key found in request","integer",["186","187"],{"id":"188"},"The SNI name to associate with the given certificate.",["135"],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"100","examples":"189"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object. With form-encoded, the notation is `certificate.id=<certificate id>`. With JSON, use `\"certificate\":{\"id\":\"<certificate id>\"}`.",{"id":"190"},{"id":"191","name":"135","created_at":1422386534,"tags":"192","certificate":"193"},{"id":"194","name":"135","created_at":1422386534,"tags":"195","certificate":"196"},{"id":"197","name":"198","created_at":"199","tags":"200","certificate":"201"},"user-level","low-priority","a2e013e8-7623-4494-a347-6d29108ff68b",["202"],{"type":"100","description":"203","examples":"204"},"147f5ef0-1ed6-4711-b77f-489262f8bff7",["186","187"],{"id":"205"},"b87eb55d-69a1-41d2-8653-8d706eecefc0",["206","207","208"],{"id":"209"},{"type":"100","description":"210","examples":"211"},{"type":"100","description":"212","examples":"213"},{"type":"174","description":"214","examples":"215"},{"type":"168","description":"179","items":"216"},{"type":"119","description":"217","properties":"218"},"[\"user-level\", \"low-priority\"]","91020192-062d-416f-a275-9addeeaffaf2",["203"],"a3ad71a8-6685-4b03-a101-980a953544f6","admin","high-priority","critical","4e8d95d4-40f2-4818-adcb-30e00c349618","The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",["191"],"The SNI name to associate with the given certificate.\n",["135"],"Unix epoch when the resource was created.\n",[1422386534],{"type":"100"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.\n",{"id":"219"},{"type":"100","description":"220","examples":"221"},"The unique identifier or the name attribute of the Certificate whose SNIs",["222"],"2e013e8-7623-4494-a347-6d29108ff68b"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-sni",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a SNI",["18"],"f00059dc1a316","put","/snis/{sni_name_or_id}",["19"],{},"upsert-sni","Create or Update SNI using ID or name.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"SNIs",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"89ee93e7858c2","51c442924c3f9","200",[],["56"],"SNI response object","5c6441ef9020f","400",[],["57"],"Invalid SNI","5c7441ef90040","401",[],["58"],"Unauthorized","1e431ddc2cc59",["59"],"A JSON object containing the details of the new SNI, including the name, certificate, and tags.",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"79","examples":"84","encodings":"85","schema":"86"},{"id":"87","mediaType":"79","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"79","examples":"92","encodings":"93","schema":"94"},"113a7fae5034a","sni_name_or_id","simple",[],"The unique identifier or the name of the SNI to retrieve.",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110"},{"default":"111","description":"112","enum":"113"},"89f723318a47f","application/json",[],[],{"type":"114","x-examples":"115","properties":"116","$schema":"97","x-stoplight":"117"},"74c6cb02b2c55",[],[],{"type":"114","$schema":"97","x-stoplight":"118"},"b33b9a9fdacb5",["119","120","121"],[],{"type":"114","properties":"122","required":"123","title":"124","$schema":"97","x-stoplight":"125"},"e073cd98338ea",[],[],{"type":"114","x-examples":"126","properties":"127","required":"128","$schema":"97","x-stoplight":"129"},"string",["130"],"http://json-schema.org/draft-07/schema#",{"id":"131"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["111","132"],"object",{"Example 1":"133"},{"data":"134","next":"135"},{"id":"136"},{"id":"137"},{"id":"138","key":"139","value":"140","summary":"141"},{"id":"142","key":"143","value":"144","summary":"145"},{"id":"146","key":"147","value":"148","summary":"149"},{"status":"150","message":"151"},["152","153"],"UnauthorizedError",{"id":"154"},{"Example 1":"155"},{"name":"156","tags":"157","certificate":"158"},["99","159"],{"id":"160"},"my-sni","a81c0f45fea00","https",{"data":"161","next":"162"},{"type":"163","description":"164","items":"165"},{"type":"95","description":"166","examples":"167"},"2fd950980b7e5","0c95b5efe1061","9425e82dc9556","DuplicateApiKey",{"message":"141","status":401},"Duplicate API key found","b6c40461d97a7","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","6f97a6a135c70","NoAPIKey",{"message":"168","status":401},"No API key found",{"type":"169"},{"type":"95"},"status","message","470b68e5f0549",{"name":"130","tags":"170","certificate":"171"},{"type":"95","description":"172","examples":"173"},{"type":"163","description":"174","items":"175"},{"type":"114","description":"176","properties":"177"},"certificate","de9cb28ac0ad1",["178","179"],"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","array","Array of SNIs",{"type":"114","properties":"180"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page",["162"],"No API key found in request","integer",["181","182"],{"id":"183"},"The SNI name to associate with the given certificate.",["130"],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"95","examples":"184"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object. With form-encoded, the notation is `certificate.id=<certificate id>`. With JSON, use `\"certificate\":{\"id\":\"<certificate id>\"}`.",{"id":"185"},{"id":"186","name":"130","created_at":1422386534,"tags":"187","certificate":"188"},{"id":"189","name":"130","created_at":1422386534,"tags":"190","certificate":"191"},{"id":"192","name":"193","created_at":"194","tags":"195","certificate":"196"},"user-level","low-priority","a2e013e8-7623-4494-a347-6d29108ff68b",["197"],{"type":"95","description":"198","examples":"199"},"147f5ef0-1ed6-4711-b77f-489262f8bff7",["181","182"],{"id":"200"},"b87eb55d-69a1-41d2-8653-8d706eecefc0",["201","202","203"],{"id":"204"},{"type":"95","description":"205","examples":"206"},{"type":"95","description":"207","examples":"208"},{"type":"169","description":"209","examples":"210"},{"type":"163","description":"174","items":"211"},{"type":"114","description":"212","properties":"213"},"[\"user-level\", \"low-priority\"]","91020192-062d-416f-a275-9addeeaffaf2",["198"],"a3ad71a8-6685-4b03-a101-980a953544f6","admin","high-priority","critical","4e8d95d4-40f2-4818-adcb-30e00c349618","The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",["186"],"The SNI name to associate with the given certificate.\n",["130"],"Unix epoch when the resource was created.\n",[1422386534],{"type":"95"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.\n",{"id":"214"},{"type":"95","description":"215","examples":"216"},"The unique identifier or the name attribute of the Certificate whose SNIs",["217"],"2e013e8-7623-4494-a347-6d29108ff68b"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-sni-with-cert-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all SNIs associated with a Certificate in a workspace",["17"],"86ce6b454d9cc","get","/{workspace}/certificates/{certificate_id}/snis",["18"],{},"list-sni-with-cert-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"SNIs",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],["41","42"],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"89ee93e7858c2","db2995e6613cd","200",[],["49"],"SNI response object","a079968eea26b","401",[],["50"],"Unauthorized",{"id":"51","name":"52","style":"53","examples":"54","description":"55","schema":"56","explicitProperties":"57"},{"id":"58","name":"59","style":"53","examples":"60","description":"61","schema":"62","explicitProperties":"63"},{"id":"64","name":"65","style":"53","examples":"66","description":"67","schema":"68","explicitProperties":"69"},{"id":"70","name":"71","style":"72","examples":"73","description":"74","required":true,"schema":"75","explicitProperties":"76"},{"id":"77","name":"78","style":"72","examples":"79","description":"80","required":true,"schema":"81","explicitProperties":"82"},{"id":"83","key":"84","extensions":"85","description":"86","type":"87","name":"88","in":"89"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"90","path":"91","port":"92","protocol":"93"},{"id":"94","mediaType":"95","examples":"96","encodings":"97","schema":"98"},{"id":"99","mediaType":"95","examples":"100","encodings":"101","schema":"102"},"5b737be5c72d9","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"103","$schema":"104","x-stoplight":"105"},["106","107","108","109","110"],"6c4162a899525","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"111","$schema":"104","x-stoplight":"112"},["106","107","108","109","110"],"fa8fc597e17ac","tags",["113"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"111","examples":"114","x-stoplight":"115","$schema":"104"},["106","116","107","108","109","110"],"fc81a4c3d5c38","workspace","simple",[],"Name or ID of workspace",{"type":"111","examples":"117","$schema":"104","x-stoplight":"118"},["108","107","119","109","106","110"],"12cdc559d0f01","certificate_id",[],"The unique identifier of the Certificate to retrieve.",{"type":"111","examples":"120","$schema":"104","x-stoplight":"121"},["108","107","119","109","106","110"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"122","description":"123"},{"default":"124","description":"125"},{"default":"126","description":"127"},{"default":"128","description":"129","enum":"130"},"20b387a51c122","application/json",[],[],{"type":"131","x-examples":"132","properties":"133","$schema":"104","x-stoplight":"134"},"45690d833c7fb",["135","136","137"],[],{"type":"131","properties":"138","required":"139","title":"140","$schema":"104","x-stoplight":"141"},"integer","http://json-schema.org/draft-07/schema#",{"id":"142"},"description","in","name","schema","title","string",{"id":"143"},{"id":"144","value":"145","key":"146"},["145"],{"explicitProperties":"147","id":"148"},"example",["149"],{"id":"150"},"required",["151"],{"id":"152"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["128","153"],"object",{"Example 1":"154"},{"data":"155","next":"156"},{"id":"157"},{"id":"158","key":"159","value":"160","summary":"161"},{"id":"162","key":"163","value":"164","summary":"165"},{"id":"166","key":"167","value":"168","summary":"169"},{"status":"170","message":"171"},["172","173"],"UnauthorizedError",{"id":"174"},"e8172eba0d59d","86f0a0979290b","908b01cd860ba","tag1,tag2","default",["175","176","177"],"d8954bb6a8a55","team-a","5249690fc3b59","7fca84d6-7d37-4a74-a7b0-93e576089a41\"","87c42a2c623ee","https",{"data":"178","next":"179"},{"type":"180","description":"181","items":"182"},{"type":"111","description":"183","examples":"184"},"2fd950980b7e5","68a4d18c92eb2","DuplicateApiKey",{"message":"161","status":401},"Duplicate API key found","c982591b4ec09","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","29cdea3841fee","NoAPIKey",{"message":"185","status":401},"No API key found",{"type":"103"},{"type":"111"},"status","message","470b68e5f0549","type","nullable","examples",["186","187"],"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","array","Array of SNIs",{"type":"131","properties":"188"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page",["179"],"No API key found in request",{"id":"189","name":"190","created_at":1422386534,"tags":"191","certificate":"192"},{"id":"193","name":"190","created_at":1422386534,"tags":"194","certificate":"195"},{"id":"196","name":"197","created_at":"198","tags":"199","certificate":"200"},"147f5ef0-1ed6-4711-b77f-489262f8bff7","my-sni",["201","202"],{"id":"203"},"b87eb55d-69a1-41d2-8653-8d706eecefc0",["204","205","206"],{"id":"207"},{"type":"111","description":"208","examples":"209"},{"type":"111","description":"210","examples":"211"},{"type":"103","description":"212","examples":"213"},{"type":"180","description":"214","items":"215"},{"type":"131","description":"216","properties":"217"},"user-level","low-priority","a3ad71a8-6685-4b03-a101-980a953544f6","admin","high-priority","critical","4e8d95d4-40f2-4818-adcb-30e00c349618","The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",["189"],"The SNI name to associate with the given certificate.\n",["190"],"Unix epoch when the resource was created.\n",[1422386534],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"111"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.\n",{"id":"218"},{"type":"111","description":"219","examples":"220"},"The unique identifier or the name attribute of the Certificate whose SNIs",["221"],"2e013e8-7623-4494-a347-6d29108ff68b"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-sni-with-cert-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new SNI associated with a Certificate in a workspace",["17"],"5ade02bfe9459","post","/{workspace}/certificates/{certificate_id}/snis",["18"],{},"create-sni-with-cert-in-workspace","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"SNIs",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48","49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"89ee93e7858c2","7acc629239675","200",[],["56"],"SNI response object","22ac60b577171","400",[],["57"],"Invalid SNI","22bc60b5770a2","401",[],["58"],"Unauthorized","98c12597a4a81",["59"],"A JSON object containing the details of the new SNI, including the name, certificate, and tags.",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","name":"68","style":"62","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","key":"74","extensions":"75","description":"76","type":"77","name":"78","in":"79"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"80","path":"81","port":"82","protocol":"83"},{"id":"84","mediaType":"85","examples":"86","encodings":"87","schema":"88"},{"id":"89","mediaType":"85","examples":"90","encodings":"91","schema":"92"},{"id":"93","mediaType":"85","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"85","examples":"98","encodings":"99","schema":"100"},"2aa736259b4d9","workspace","simple",[],"Name or ID of workspace",{"type":"101","examples":"102","$schema":"103","x-stoplight":"104"},["105","106","107","108","109","110"],"be43de247ce37","certificate_id",[],"The unique identifier of the Certificate to retrieve.",{"type":"101","examples":"111","$schema":"103","x-stoplight":"112"},["105","106","107","108","109","110"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"0142ac2845d2e","application/json",[],[],{"type":"122","x-examples":"123","properties":"124","$schema":"103","x-stoplight":"125"},"f32a6e805dcd9",[],[],{"type":"122","$schema":"103","x-stoplight":"126"},"57ad71d78e01f",["127","128","129"],[],{"type":"122","properties":"130","required":"131","title":"132","$schema":"103","x-stoplight":"133"},"c4e81f7b13380",[],[],{"type":"122","x-examples":"134","properties":"135","required":"136","$schema":"103","x-stoplight":"137"},"string",["138"],"http://json-schema.org/draft-07/schema#",{"id":"139"},"name","in","required","schema","description","title",["140"],{"id":"141"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","142"],"object",{"Example 1":"143"},{"data":"144","next":"145"},{"id":"146"},{"id":"147"},{"id":"148","key":"149","value":"150","summary":"151"},{"id":"152","key":"153","value":"154","summary":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"status":"160","message":"161"},["162","163"],"UnauthorizedError",{"id":"164"},{"Example 1":"165"},{"name":"166","tags":"167","certificate":"168"},["105","169"],{"id":"170"},"team-a","764702053cad7","7fca84d6-7d37-4a74-a7b0-93e576089a41\"","38146ab1874bc","https",{"data":"171","next":"172"},{"type":"173","description":"174","items":"175"},{"type":"101","description":"176","examples":"177"},"2fd950980b7e5","2a37d100af363","2e84b56cf6484","DuplicateApiKey",{"message":"151","status":401},"Duplicate API key found","f7edcb531508c","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","19831c55e7e44","NoAPIKey",{"message":"178","status":401},"No API key found",{"type":"179"},{"type":"101"},"status","message","470b68e5f0549",{"name":"180","tags":"181","certificate":"182"},{"type":"101","description":"183","examples":"184"},{"type":"173","description":"185","items":"186"},{"type":"122","description":"187","properties":"188"},"certificate","de9cb28ac0ad1",["189","190"],"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","array","Array of SNIs",{"type":"122","properties":"191"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page",["172"],"No API key found in request","integer","my-sni",["192","193"],{"id":"194"},"The SNI name to associate with the given certificate.",["180"],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"101","examples":"195"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object. With form-encoded, the notation is `certificate.id=<certificate id>`. With JSON, use `\"certificate\":{\"id\":\"<certificate id>\"}`.",{"id":"196"},{"id":"197","name":"180","created_at":1422386534,"tags":"198","certificate":"199"},{"id":"200","name":"180","created_at":1422386534,"tags":"201","certificate":"202"},{"id":"203","name":"204","created_at":"205","tags":"206","certificate":"207"},"user-level","low-priority","a2e013e8-7623-4494-a347-6d29108ff68b",["208"],{"type":"101","description":"209","examples":"210"},"147f5ef0-1ed6-4711-b77f-489262f8bff7",["192","193"],{"id":"211"},"b87eb55d-69a1-41d2-8653-8d706eecefc0",["212","213","214"],{"id":"215"},{"type":"101","description":"216","examples":"217"},{"type":"101","description":"218","examples":"219"},{"type":"179","description":"220","examples":"221"},{"type":"173","description":"185","items":"222"},{"type":"122","description":"223","properties":"224"},"[\"user-level\", \"low-priority\"]","91020192-062d-416f-a275-9addeeaffaf2",["209"],"a3ad71a8-6685-4b03-a101-980a953544f6","admin","high-priority","critical","4e8d95d4-40f2-4818-adcb-30e00c349618","The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",["197"],"The SNI name to associate with the given certificate.\n",["180"],"Unix epoch when the resource was created.\n",[1422386534],{"type":"101"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.\n",{"id":"225"},{"type":"101","description":"226","examples":"227"},"The unique identifier or the name attribute of the Certificate whose SNIs",["228"],"2e013e8-7623-4494-a347-6d29108ff68b"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-sni-with-cert-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete an SNI associated with a Certificate in a workspace",["18"],"06bd2ad58e7fa","delete","/{workspace}/certificates/{certificate_id}/snis/{sni_name_or_id}",["19"],{},"delete-sni-with-cert-in-workspace","Delete a an SNI associated with a Certificate using ID or name in a workspace.","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"SNIs",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33","34","35"],["36"],{"id":"37","url":"38","name":"39","description":"40","variables":"41"},"89ee93e7858c2","38cb707de57b5","204",[],[],"Successfully deleted SNI or the resource didn't exist",{"id":"42","name":"43","style":"44","examples":"45","description":"46","required":true,"schema":"47","explicitProperties":"48"},{"id":"49","name":"50","style":"44","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"44","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},"48c01cf1dbca0","workspace","simple",[],"Name or ID of workspace",{"type":"72","examples":"73","$schema":"74","x-stoplight":"75"},["76","77","78","79","80","81"],"032b028a205ac","certificate_id",[],"The unique identifier of the Certificate to retrieve.",{"type":"72","examples":"82","$schema":"74","x-stoplight":"83"},["76","77","78","79","80","81"],"10c539ab77467","sni_name_or_id",[],"The unique identifier or the name of the SNI to retrieve.",{"type":"72","examples":"84","$schema":"74","x-stoplight":"85"},["76","77","78","79","80","81"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"86","description":"87"},{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93","enum":"94"},"string",["95"],"http://json-schema.org/draft-07/schema#",{"id":"96"},"name","in","required","schema","description","title",["97"],{"id":"98"},["99"],{"id":"100"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["92","101"],"team-a","b1c97911f7ca9","7fca84d6-7d37-4a74-a7b0-93e576089a41\"","17eae5c2febe8","my-sni","dd7b3ae7b3c2e","https"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/fetch-sni-with-cert-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch an SNI associated with a Certificate in a workspace",["18"],"005f6007fcdd6","get","/{workspace}/certificates/{certificate_id}/snis/{sni_name_or_id}",["19"],{},"fetch-sni-with-cert-in-workspace","Get an SNI associated with a Certificate using ID or name in a workspace.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"SNIs",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46","47"],["48"],{"id":"49","url":"50","name":"51","description":"52","variables":"53"},"89ee93e7858c2","f68aaebfbb6e4","200",[],["54"],"SNI response object","4ebab09c7e00e","401",[],["55"],"Unauthorized","4e6ab09c7d98d","404",[],[],"Resource does not exist",{"id":"56","name":"57","style":"58","examples":"59","description":"60","required":true,"schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"58","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"58","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","key":"76","extensions":"77","description":"78","type":"79","name":"80","in":"81"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"82","path":"83","port":"84","protocol":"85"},{"id":"86","mediaType":"87","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"87","examples":"92","encodings":"93","schema":"94"},"dc998bf7b6680","workspace","simple",[],"Name or ID of workspace",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"330d5ff52ea59","certificate_id",[],"The unique identifier of the Certificate to retrieve.",{"type":"95","examples":"105","$schema":"97","x-stoplight":"106"},["99","100","101","102","103","104"],"a30a67896989a","sni_name_or_id",[],"The unique identifier or the name of the SNI to retrieve.",{"type":"95","examples":"107","$schema":"97","x-stoplight":"108"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"109","description":"110"},{"default":"111","description":"112"},{"default":"113","description":"114"},{"default":"115","description":"116","enum":"117"},"ab99587591329","application/json",[],[],{"type":"118","x-examples":"119","properties":"120","$schema":"97","x-stoplight":"121"},"419288d8cc795",["122","123","124"],[],{"type":"118","properties":"125","required":"126","title":"127","$schema":"97","x-stoplight":"128"},"string",["129"],"http://json-schema.org/draft-07/schema#",{"id":"130"},"name","in","required","schema","description","title",["131"],{"id":"132"},["133"],{"id":"134"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["115","135"],"object",{"Example 1":"136"},{"data":"137","next":"138"},{"id":"139"},{"id":"140","key":"141","value":"142","summary":"143"},{"id":"144","key":"145","value":"146","summary":"147"},{"id":"148","key":"149","value":"150","summary":"151"},{"status":"152","message":"153"},["154","155"],"UnauthorizedError",{"id":"156"},"team-a","a438790bdb395","7fca84d6-7d37-4a74-a7b0-93e576089a41\"","ea3fbcb128009","my-sni","23c0ccceb2615","https",{"data":"157","next":"158"},{"type":"159","description":"160","items":"161"},{"type":"95","description":"162","examples":"163"},"2fd950980b7e5","dfe13ebd93274","DuplicateApiKey",{"message":"143","status":401},"Duplicate API key found","71ecfb31bb4a6","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","2c72bf82f93e0","NoAPIKey",{"message":"164","status":401},"No API key found",{"type":"165"},{"type":"95"},"status","message","470b68e5f0549",["166","167"],"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","array","Array of SNIs",{"type":"118","properties":"168"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page",["158"],"No API key found in request","integer",{"id":"169","name":"133","created_at":1422386534,"tags":"170","certificate":"171"},{"id":"172","name":"133","created_at":1422386534,"tags":"173","certificate":"174"},{"id":"175","name":"176","created_at":"177","tags":"178","certificate":"179"},"147f5ef0-1ed6-4711-b77f-489262f8bff7",["180","181"],{"id":"182"},"b87eb55d-69a1-41d2-8653-8d706eecefc0",["183","184","185"],{"id":"186"},{"type":"95","description":"187","examples":"188"},{"type":"95","description":"189","examples":"190"},{"type":"165","description":"191","examples":"192"},{"type":"159","description":"193","items":"194"},{"type":"118","description":"195","properties":"196"},"user-level","low-priority","a3ad71a8-6685-4b03-a101-980a953544f6","admin","high-priority","critical","4e8d95d4-40f2-4818-adcb-30e00c349618","The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",["169"],"The SNI name to associate with the given certificate.\n",["133"],"Unix epoch when the resource was created.\n",[1422386534],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"95"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.\n",{"id":"197"},{"type":"95","description":"198","examples":"199"},"The unique identifier or the name attribute of the Certificate whose SNIs",["200"],"2e013e8-7623-4494-a347-6d29108ff68b"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-sni-with-cert-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update an SNI associated with a Certificate in a workspace",["18"],"53a7b6a5473ed","patch","/{workspace}/certificates/{certificate_id}/snis/{sni_name_or_id}",["19"],{},"update-sni-with-cert-in-workspace","Update a an SNI associated with a Certificate using ID or name in a workspace.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"SNIs",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55","56","57"],["58"],{"id":"59","url":"60","name":"61","description":"62","variables":"63"},"89ee93e7858c2","b43b24c70b3ad","200",[],["64"],"SNI response object","5c1b22ea48629","400",[],["65"],"Invalid SNI","5c2b22ea4847a","401",[],["66"],"Unauthorized","5c5b22ea49f15","404",[],[],"Resource does not exist","984110e79f54f",["67"],"A JSON object containing the details of the new SNI, including the name, certificate, and tags.",{"id":"68","name":"69","style":"70","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","name":"76","style":"70","examples":"77","description":"78","required":true,"schema":"79","explicitProperties":"80"},{"id":"81","name":"82","style":"70","examples":"83","description":"84","required":true,"schema":"85","explicitProperties":"86"},{"id":"87","key":"88","extensions":"89","description":"90","type":"91","name":"92","in":"93"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"94","path":"95","port":"96","protocol":"97"},{"id":"98","mediaType":"99","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"99","examples":"104","encodings":"105","schema":"106"},{"id":"107","mediaType":"99","examples":"108","encodings":"109","schema":"110"},{"id":"111","mediaType":"99","examples":"112","encodings":"113","schema":"114"},"2968f335a05f5","workspace","simple",[],"Name or ID of workspace",{"type":"115","examples":"116","$schema":"117","x-stoplight":"118"},["119","120","121","122","123","124"],"a384607f6af06","certificate_id",[],"The unique identifier of the Certificate to retrieve.",{"type":"115","examples":"125","$schema":"117","x-stoplight":"126"},["119","120","121","122","123","124"],"8961d390ce337","sni_name_or_id",[],"The unique identifier or the name of the SNI to retrieve.",{"type":"115","examples":"127","$schema":"117","x-stoplight":"128"},["119","120","121","122","123","124"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"129","description":"130"},{"default":"131","description":"132"},{"default":"133","description":"134"},{"default":"135","description":"136","enum":"137"},"e474498cf30f7","application/json",[],[],{"type":"138","x-examples":"139","properties":"140","$schema":"117","x-stoplight":"141"},"9eb38be6e05ed",[],[],{"type":"138","$schema":"117","x-stoplight":"142"},"4f563c7221b3f",["143","144","145"],[],{"type":"138","properties":"146","required":"147","title":"148","$schema":"117","x-stoplight":"149"},"e866ddaf7daab",[],[],{"type":"138","x-examples":"150","properties":"151","required":"152","$schema":"117","x-stoplight":"153"},"string",["154"],"http://json-schema.org/draft-07/schema#",{"id":"155"},"name","in","required","schema","description","title",["156"],{"id":"157"},["158"],{"id":"159"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["135","160"],"object",{"Example 1":"161"},{"data":"162","next":"163"},{"id":"164"},{"id":"165"},{"id":"166","key":"167","value":"168","summary":"169"},{"id":"170","key":"171","value":"172","summary":"173"},{"id":"174","key":"175","value":"176","summary":"177"},{"status":"178","message":"179"},["180","181"],"UnauthorizedError",{"id":"182"},{"Example 1":"183"},{"name":"184","tags":"185","certificate":"186"},["119","187"],{"id":"188"},"team-a","10bc988948707","7fca84d6-7d37-4a74-a7b0-93e576089a41\"","55b6c03bb7ea1","my-sni","cbd632c04dc17","https",{"data":"189","next":"190"},{"type":"191","description":"192","items":"193"},{"type":"115","description":"194","examples":"195"},"2fd950980b7e5","6e7b765438cdf","0aaac56799985","DuplicateApiKey",{"message":"169","status":401},"Duplicate API key found","5f707146c2ed4","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","c18d5a31d0cad","NoAPIKey",{"message":"196","status":401},"No API key found",{"type":"197"},{"type":"115"},"status","message","470b68e5f0549",{"name":"158","tags":"198","certificate":"199"},{"type":"115","description":"200","examples":"201"},{"type":"191","description":"202","items":"203"},{"type":"138","description":"204","properties":"205"},"certificate","de9cb28ac0ad1",["206","207"],"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","array","Array of SNIs",{"type":"138","properties":"208"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page",["190"],"No API key found in request","integer",["209","210"],{"id":"211"},"The SNI name to associate with the given certificate.",["158"],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"115","examples":"212"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object. With form-encoded, the notation is `certificate.id=<certificate id>`. With JSON, use `\"certificate\":{\"id\":\"<certificate id>\"}`.",{"id":"213"},{"id":"214","name":"158","created_at":1422386534,"tags":"215","certificate":"216"},{"id":"217","name":"158","created_at":1422386534,"tags":"218","certificate":"219"},{"id":"220","name":"221","created_at":"222","tags":"223","certificate":"224"},"user-level","low-priority","a2e013e8-7623-4494-a347-6d29108ff68b",["225"],{"type":"115","description":"226","examples":"227"},"147f5ef0-1ed6-4711-b77f-489262f8bff7",["209","210"],{"id":"228"},"b87eb55d-69a1-41d2-8653-8d706eecefc0",["229","230","231"],{"id":"232"},{"type":"115","description":"233","examples":"234"},{"type":"115","description":"235","examples":"236"},{"type":"197","description":"237","examples":"238"},{"type":"191","description":"202","items":"239"},{"type":"138","description":"240","properties":"241"},"[\"user-level\", \"low-priority\"]","91020192-062d-416f-a275-9addeeaffaf2",["226"],"a3ad71a8-6685-4b03-a101-980a953544f6","admin","high-priority","critical","4e8d95d4-40f2-4818-adcb-30e00c349618","The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",["214"],"The SNI name to associate with the given certificate.\n",["158"],"Unix epoch when the resource was created.\n",[1422386534],{"type":"115"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.\n",{"id":"242"},{"type":"115","description":"243","examples":"244"},"The unique identifier or the name attribute of the Certificate whose SNIs",["245"],"2e013e8-7623-4494-a347-6d29108ff68b"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-sni-with-cert-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert an SNI associated with a Certificate in a workspace",["18"],"d6c0204c7ce71","put","/{workspace}/certificates/{certificate_id}/snis/{sni_name_or_id}",["19"],{},"upsert-sni-with-cert-in-workspace","Create or Update an SNI associated with a Certificate using ID or name in a workspace.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"SNIs",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50","51"],["52"],{"id":"53","url":"54","name":"55","description":"56","variables":"57"},"89ee93e7858c2","94b9fd9084c18","200",[],["58"],"SNI response object","9f59fcedc8e6e","400",[],["59"],"Invalid SNI","9f69fcedc90a1","401",[],["60"],"Unauthorized","aaeb602a394b8",["61"],"A JSON object containing the details of the new SNI, including the name, certificate, and tags.",{"id":"62","name":"63","style":"64","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"64","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","name":"76","style":"64","examples":"77","description":"78","required":true,"schema":"79","explicitProperties":"80"},{"id":"81","key":"82","extensions":"83","description":"84","type":"85","name":"86","in":"87"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"88","path":"89","port":"90","protocol":"91"},{"id":"92","mediaType":"93","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"93","examples":"98","encodings":"99","schema":"100"},{"id":"101","mediaType":"93","examples":"102","encodings":"103","schema":"104"},{"id":"105","mediaType":"93","examples":"106","encodings":"107","schema":"108"},"d4ea01287fa70","workspace","simple",[],"Name or ID of workspace",{"type":"109","examples":"110","$schema":"111","x-stoplight":"112"},["113","114","115","116","117","118"],"18db6af0dc3cb","certificate_id",[],"The unique identifier of the Certificate to retrieve.",{"type":"109","examples":"119","$schema":"111","x-stoplight":"120"},["113","114","115","116","117","118"],"88d8728517d28","sni_name_or_id",[],"The unique identifier or the name of the SNI to retrieve.",{"type":"109","examples":"121","$schema":"111","x-stoplight":"122"},["113","114","115","116","117","118"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"123","description":"124"},{"default":"125","description":"126"},{"default":"127","description":"128"},{"default":"129","description":"130","enum":"131"},"faaab0fa15160","application/json",[],[],{"type":"132","x-examples":"133","properties":"134","$schema":"111","x-stoplight":"135"},"057ead975ca09",[],[],{"type":"132","$schema":"111","x-stoplight":"136"},"40fad1a648fa5",["137","138","139"],[],{"type":"132","properties":"140","required":"141","title":"142","$schema":"111","x-stoplight":"143"},"141aff2d6db43",[],[],{"type":"132","x-examples":"144","properties":"145","required":"146","$schema":"111","x-stoplight":"147"},"string",["148"],"http://json-schema.org/draft-07/schema#",{"id":"149"},"name","in","required","schema","description","title",["150"],{"id":"151"},["152"],{"id":"153"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["129","154"],"object",{"Example 1":"155"},{"data":"156","next":"157"},{"id":"158"},{"id":"159"},{"id":"160","key":"161","value":"162","summary":"163"},{"id":"164","key":"165","value":"166","summary":"167"},{"id":"168","key":"169","value":"170","summary":"171"},{"status":"172","message":"173"},["174","175"],"UnauthorizedError",{"id":"176"},{"Example 1":"177"},{"name":"178","tags":"179","certificate":"180"},["113","181"],{"id":"182"},"team-a","de05df337874a","7fca84d6-7d37-4a74-a7b0-93e576089a41\"","ffec9c0f6ef62","my-sni","d7a2bd969b632","https",{"data":"183","next":"184"},{"type":"185","description":"186","items":"187"},{"type":"109","description":"188","examples":"189"},"2fd950980b7e5","b07b553773a96","8a8b47008f6e3","DuplicateApiKey",{"message":"163","status":401},"Duplicate API key found","595348678847a","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","9a1ca54c1e2a5","NoAPIKey",{"message":"190","status":401},"No API key found",{"type":"191"},{"type":"109"},"status","message","470b68e5f0549",{"name":"152","tags":"192","certificate":"193"},{"type":"109","description":"194","examples":"195"},{"type":"185","description":"196","items":"197"},{"type":"132","description":"198","properties":"199"},"certificate","de9cb28ac0ad1",["200","201"],"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","array","Array of SNIs",{"type":"132","properties":"202"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page",["184"],"No API key found in request","integer",["203","204"],{"id":"205"},"The SNI name to associate with the given certificate.",["152"],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"109","examples":"206"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object. With form-encoded, the notation is `certificate.id=<certificate id>`. With JSON, use `\"certificate\":{\"id\":\"<certificate id>\"}`.",{"id":"207"},{"id":"208","name":"152","created_at":1422386534,"tags":"209","certificate":"210"},{"id":"211","name":"152","created_at":1422386534,"tags":"212","certificate":"213"},{"id":"214","name":"215","created_at":"216","tags":"217","certificate":"218"},"user-level","low-priority","a2e013e8-7623-4494-a347-6d29108ff68b",["219"],{"type":"109","description":"220","examples":"221"},"147f5ef0-1ed6-4711-b77f-489262f8bff7",["203","204"],{"id":"222"},"b87eb55d-69a1-41d2-8653-8d706eecefc0",["223","224","225"],{"id":"226"},{"type":"109","description":"227","examples":"228"},{"type":"109","description":"229","examples":"230"},{"type":"191","description":"231","examples":"232"},{"type":"185","description":"196","items":"233"},{"type":"132","description":"234","properties":"235"},"[\"user-level\", \"low-priority\"]","91020192-062d-416f-a275-9addeeaffaf2",["220"],"a3ad71a8-6685-4b03-a101-980a953544f6","admin","high-priority","critical","4e8d95d4-40f2-4818-adcb-30e00c349618","The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",["208"],"The SNI name to associate with the given certificate.\n",["152"],"Unix epoch when the resource was created.\n",[1422386534],{"type":"109"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.\n",{"id":"236"},{"type":"109","description":"237","examples":"238"},"The unique identifier or the name attribute of the Certificate whose SNIs",["239"],"2e013e8-7623-4494-a347-6d29108ff68b"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-sni-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all SNIs in a workspace",["17"],"bf0d44c662306","get","/{workspace}/snis",["18"],{},"list-sni-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"SNIs",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],["41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"89ee93e7858c2","31d1451284be8","200",[],["48"],"SNI response object","91e146ef54a33","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"71","examples":"72","description":"73","required":true,"schema":"74","explicitProperties":"75"},{"id":"76","key":"77","extensions":"78","description":"79","type":"80","name":"81","in":"82"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"83","path":"84","port":"85","protocol":"86"},{"id":"87","mediaType":"88","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"88","examples":"93","encodings":"94","schema":"95"},"1b9761b8098cf","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103"],"b48e3ac71dd5b","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"104","$schema":"97","x-stoplight":"105"},["99","100","101","102","103"],"15f9fac61c21e","tags",["106"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"104","examples":"107","x-stoplight":"108","$schema":"97"},["99","109","100","101","102","103"],"71e2f78cda0d0","workspace","simple",[],"Name or ID of workspace",{"type":"104","examples":"110","$schema":"97","x-stoplight":"111"},["101","100","112","102","99","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"4c5eedcd45f02","application/json",[],[],{"type":"122","x-examples":"123","properties":"124","$schema":"97","x-stoplight":"125"},"65769122ed497",["126","127","128"],[],{"type":"122","properties":"129","required":"130","title":"131","$schema":"97","x-stoplight":"132"},"integer","http://json-schema.org/draft-07/schema#",{"id":"133"},"description","in","name","schema","title","string",{"id":"134"},{"id":"135","value":"136","key":"137"},["136"],{"explicitProperties":"138","id":"139"},"example",["140"],{"id":"141"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","142"],"object",{"Example 1":"143"},{"data":"144","next":"145"},{"id":"146"},{"id":"147","key":"148","value":"149","summary":"150"},{"id":"151","key":"152","value":"153","summary":"154"},{"id":"155","key":"156","value":"157","summary":"158"},{"status":"159","message":"160"},["161","162"],"UnauthorizedError",{"id":"163"},"b7de108fd8de4","601060995fa81","d2e58425f1ebe","tag1,tag2","default",["164","165","166"],"0c6eb2ccb7439","team-a","800db3ea240d5","https",{"data":"167","next":"168"},{"type":"169","description":"170","items":"171"},{"type":"104","description":"172","examples":"173"},"2fd950980b7e5","f1dc42e690d33","DuplicateApiKey",{"message":"150","status":401},"Duplicate API key found","c01fac56c2d12","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","32fddbfb35637","NoAPIKey",{"message":"174","status":401},"No API key found",{"type":"96"},{"type":"104"},"status","message","470b68e5f0549","type","nullable","examples",["175","176"],"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","array","Array of SNIs",{"type":"122","properties":"177"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page",["168"],"No API key found in request",{"id":"178","name":"179","created_at":1422386534,"tags":"180","certificate":"181"},{"id":"182","name":"179","created_at":1422386534,"tags":"183","certificate":"184"},{"id":"185","name":"186","created_at":"187","tags":"188","certificate":"189"},"147f5ef0-1ed6-4711-b77f-489262f8bff7","my-sni",["190","191"],{"id":"192"},"b87eb55d-69a1-41d2-8653-8d706eecefc0",["193","194","195"],{"id":"196"},{"type":"104","description":"197","examples":"198"},{"type":"104","description":"199","examples":"200"},{"type":"96","description":"201","examples":"202"},{"type":"169","description":"203","items":"204"},{"type":"122","description":"205","properties":"206"},"user-level","low-priority","a3ad71a8-6685-4b03-a101-980a953544f6","admin","high-priority","critical","4e8d95d4-40f2-4818-adcb-30e00c349618","The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",["178"],"The SNI name to associate with the given certificate.\n",["179"],"Unix epoch when the resource was created.\n",[1422386534],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"104"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.\n",{"id":"207"},{"type":"104","description":"208","examples":"209"},"The unique identifier or the name attribute of the Certificate whose SNIs",["210"],"2e013e8-7623-4494-a347-6d29108ff68b"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-sni-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new SNI in a workspace",["17"],"ac947f9fc40e4","post","/{workspace}/snis",["18"],{},"create-sni-in-workspace","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"SNIs",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48"],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"89ee93e7858c2","87254764b418c","200",[],["55"],"SNI response object","7c8548077007a","400",[],["56"],"Invalid SNI","7c95480771f89","401",[],["57"],"Unauthorized","68c31e8cf39b8",["58"],"A JSON object containing the details of the new SNI, including the name, certificate, and tags.",{"id":"59","name":"60","style":"61","examples":"62","description":"63","required":true,"schema":"64","explicitProperties":"65"},{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},{"id":"86","mediaType":"78","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"78","examples":"91","encodings":"92","schema":"93"},"bb5b7a9e58632","workspace","simple",[],"Name or ID of workspace",{"type":"94","examples":"95","$schema":"96","x-stoplight":"97"},["98","99","100","101","102","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111","enum":"112"},"6e9bec80e062e","application/json",[],[],{"type":"113","x-examples":"114","properties":"115","$schema":"96","x-stoplight":"116"},"ac204b67d2b5b",[],[],{"type":"113","$schema":"96","x-stoplight":"117"},"982709bff2684",["118","119","120"],[],{"type":"113","properties":"121","required":"122","title":"123","$schema":"96","x-stoplight":"124"},"5699ef792b723",[],[],{"type":"113","x-examples":"125","properties":"126","required":"127","$schema":"96","x-stoplight":"128"},"string",["129"],"http://json-schema.org/draft-07/schema#",{"id":"130"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["110","131"],"object",{"Example 1":"132"},{"data":"133","next":"134"},{"id":"135"},{"id":"136"},{"id":"137","key":"138","value":"139","summary":"140"},{"id":"141","key":"142","value":"143","summary":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"status":"149","message":"150"},["151","152"],"UnauthorizedError",{"id":"153"},{"Example 1":"154"},{"name":"155","tags":"156","certificate":"157"},["98","158"],{"id":"159"},"team-a","f40dbc8d909a0","https",{"data":"160","next":"161"},{"type":"162","description":"163","items":"164"},{"type":"94","description":"165","examples":"166"},"2fd950980b7e5","62b95575d3717","bb11991a3e4c0","DuplicateApiKey",{"message":"140","status":401},"Duplicate API key found","137ddb5e100a9","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","70410690e53a4","NoAPIKey",{"message":"167","status":401},"No API key found",{"type":"168"},{"type":"94"},"status","message","470b68e5f0549",{"name":"169","tags":"170","certificate":"171"},{"type":"94","description":"172","examples":"173"},{"type":"162","description":"174","items":"175"},{"type":"113","description":"176","properties":"177"},"certificate","de9cb28ac0ad1",["178","179"],"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","array","Array of SNIs",{"type":"113","properties":"180"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page",["161"],"No API key found in request","integer","my-sni",["181","182"],{"id":"183"},"The SNI name to associate with the given certificate.",["169"],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"94","examples":"184"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object. With form-encoded, the notation is `certificate.id=<certificate id>`. With JSON, use `\"certificate\":{\"id\":\"<certificate id>\"}`.",{"id":"185"},{"id":"186","name":"169","created_at":1422386534,"tags":"187","certificate":"188"},{"id":"189","name":"169","created_at":1422386534,"tags":"190","certificate":"191"},{"id":"192","name":"193","created_at":"194","tags":"195","certificate":"196"},"user-level","low-priority","a2e013e8-7623-4494-a347-6d29108ff68b",["197"],{"type":"94","description":"198","examples":"199"},"147f5ef0-1ed6-4711-b77f-489262f8bff7",["181","182"],{"id":"200"},"b87eb55d-69a1-41d2-8653-8d706eecefc0",["201","202","203"],{"id":"204"},{"type":"94","description":"205","examples":"206"},{"type":"94","description":"207","examples":"208"},{"type":"168","description":"209","examples":"210"},{"type":"162","description":"174","items":"211"},{"type":"113","description":"212","properties":"213"},"[\"user-level\", \"low-priority\"]","91020192-062d-416f-a275-9addeeaffaf2",["198"],"a3ad71a8-6685-4b03-a101-980a953544f6","admin","high-priority","critical","4e8d95d4-40f2-4818-adcb-30e00c349618","The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",["186"],"The SNI name to associate with the given certificate.\n",["169"],"Unix epoch when the resource was created.\n",[1422386534],{"type":"94"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.\n",{"id":"214"},{"type":"94","description":"215","examples":"216"},"The unique identifier or the name attribute of the Certificate whose SNIs",["217"],"2e013e8-7623-4494-a347-6d29108ff68b"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-sni-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete an SNI in a workspace",["17"],"8d5012595b903","delete","/{workspace}/snis/{sni_name_or_id}",["18"],{},"delete-sni-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"SNIs",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38","39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"89ee93e7858c2","e620ed54eaec1","204",[],[],"Successfully deleted SNI or the resource didn't exist","0e10ef1a93c4c","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","name":"55","style":"49","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","key":"61","extensions":"62","description":"63","type":"64","name":"65","in":"66"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"67","path":"68","port":"69","protocol":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},"ea06dda106a17","workspace","simple",[],"Name or ID of workspace",{"type":"76","examples":"77","$schema":"78","x-stoplight":"79"},["80","81","82","83","84","85"],"2d3812bc33fec","sni_name_or_id",[],"The unique identifier or the name of the SNI to retrieve.",{"type":"76","examples":"86","$schema":"78","x-stoplight":"87"},["80","81","82","83","84","85"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95","enum":"96"},"9ea847811df1c","application/json",["97","98","99"],[],{"type":"100","properties":"101","required":"102","title":"103","$schema":"78","x-stoplight":"104"},"string",["105"],"http://json-schema.org/draft-07/schema#",{"id":"106"},"name","in","required","schema","description","title",["107"],{"id":"108"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["94","109"],{"id":"110","key":"111","value":"112","summary":"113"},{"id":"114","key":"115","value":"116","summary":"117"},{"id":"118","key":"119","value":"120","summary":"121"},"object",{"status":"122","message":"123"},["124","125"],"UnauthorizedError",{"id":"126"},"team-a","376ace3f02c24","my-sni","255029f48e0d9","https","b03bcee06e2a4","DuplicateApiKey",{"message":"113","status":401},"Duplicate API key found","8005ea5dca087","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","1324aec94954b","NoAPIKey",{"message":"127","status":401},"No API key found",{"type":"128"},{"type":"76"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-sni-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch an SNI in a workspace",["18"],"47162f036df7d","get","/{workspace}/snis/{sni_name_or_id}",["19"],{},"get-sni-in-workspace","Get an SNI using ID or name in a workspace.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"SNIs",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46"],["47"],{"id":"48","url":"49","name":"50","description":"51","variables":"52"},"89ee93e7858c2","2a8d6a8f21919","200",[],["53"],"SNI response object","f7dd6b37b83fe","401",[],["54"],"Unauthorized","f7ad6b37b86d1","404",[],[],"Resource does not exist",{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"57","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"8c57d9e3a0e62","workspace","simple",[],"Name or ID of workspace",{"type":"88","examples":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96","97"],"81ee3fac56a46","sni_name_or_id",[],"The unique identifier or the name of the SNI to retrieve.",{"type":"88","examples":"98","$schema":"90","x-stoplight":"99"},["92","93","94","95","96","97"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107","enum":"108"},"a4eb3bd98294a","application/json",[],[],{"type":"109","x-examples":"110","properties":"111","$schema":"90","x-stoplight":"112"},"5735b8869f0f2",["113","114","115"],[],{"type":"109","properties":"116","required":"117","title":"118","$schema":"90","x-stoplight":"119"},"string",["120"],"http://json-schema.org/draft-07/schema#",{"id":"121"},"name","in","required","schema","description","title",["122"],{"id":"123"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["106","124"],"object",{"Example 1":"125"},{"data":"126","next":"127"},{"id":"128"},{"id":"129","key":"130","value":"131","summary":"132"},{"id":"133","key":"134","value":"135","summary":"136"},{"id":"137","key":"138","value":"139","summary":"140"},{"status":"141","message":"142"},["143","144"],"UnauthorizedError",{"id":"145"},"team-a","7ef55897b4ebe","my-sni","2851e4ce5818c","https",{"data":"146","next":"147"},{"type":"148","description":"149","items":"150"},{"type":"88","description":"151","examples":"152"},"2fd950980b7e5","cd54b3be30714","DuplicateApiKey",{"message":"132","status":401},"Duplicate API key found","25c0f6020207d","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","77d061901c12c","NoAPIKey",{"message":"153","status":401},"No API key found",{"type":"154"},{"type":"88"},"status","message","470b68e5f0549",["155","156"],"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","array","Array of SNIs",{"type":"109","properties":"157"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page",["147"],"No API key found in request","integer",{"id":"158","name":"122","created_at":1422386534,"tags":"159","certificate":"160"},{"id":"161","name":"122","created_at":1422386534,"tags":"162","certificate":"163"},{"id":"164","name":"165","created_at":"166","tags":"167","certificate":"168"},"147f5ef0-1ed6-4711-b77f-489262f8bff7",["169","170"],{"id":"171"},"b87eb55d-69a1-41d2-8653-8d706eecefc0",["172","173","174"],{"id":"175"},{"type":"88","description":"176","examples":"177"},{"type":"88","description":"178","examples":"179"},{"type":"154","description":"180","examples":"181"},{"type":"148","description":"182","items":"183"},{"type":"109","description":"184","properties":"185"},"user-level","low-priority","a3ad71a8-6685-4b03-a101-980a953544f6","admin","high-priority","critical","4e8d95d4-40f2-4818-adcb-30e00c349618","The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",["158"],"The SNI name to associate with the given certificate.\n",["122"],"Unix epoch when the resource was created.\n",[1422386534],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"88"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.\n",{"id":"186"},{"type":"88","description":"187","examples":"188"},"The unique identifier or the name attribute of the Certificate whose SNIs",["189"],"2e013e8-7623-4494-a347-6d29108ff68b"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-sni-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update an SNI in a workspace",["17"],"8d1d63575a104","patch","/{workspace}/snis/{sni_name_or_id}",["18"],{},"update-sni-in-workspace","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"SNIs",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54","55"],["56"],{"id":"57","url":"58","name":"59","description":"60","variables":"61"},"89ee93e7858c2","b84a6e71dabad","200",[],["62"],"SNI response object","106a704e9d226","400",[],["63"],"Invalid SNI","107a704e9d051","401",[],["64"],"Unauthorized","102a704e9c8d2","404",[],[],"Resource does not exist","37d8e65f1e813",["65"],"A JSON object containing the details of the new SNI, including the name, certificate, and tags.",{"id":"66","name":"67","style":"68","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","name":"74","style":"68","examples":"75","description":"76","required":true,"schema":"77","explicitProperties":"78"},{"id":"79","key":"80","extensions":"81","description":"82","type":"83","name":"84","in":"85"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"86","path":"87","port":"88","protocol":"89"},{"id":"90","mediaType":"91","examples":"92","encodings":"93","schema":"94"},{"id":"95","mediaType":"91","examples":"96","encodings":"97","schema":"98"},{"id":"99","mediaType":"91","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"91","examples":"104","encodings":"105","schema":"106"},"d317c465f9a63","workspace","simple",[],"Name or ID of workspace",{"type":"107","examples":"108","$schema":"109","x-stoplight":"110"},["111","112","113","114","115","116"],"2d02561762a5a","sni_name_or_id",[],"The unique identifier or the name of the SNI to retrieve.",{"type":"107","examples":"117","$schema":"109","x-stoplight":"118"},["111","112","113","114","115","116"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"119","description":"120"},{"default":"121","description":"122"},{"default":"123","description":"124"},{"default":"125","description":"126","enum":"127"},"5328cda61c6f2","application/json",[],[],{"type":"128","x-examples":"129","properties":"130","$schema":"109","x-stoplight":"131"},"8bb58f7ec2561",[],[],{"type":"128","$schema":"109","x-stoplight":"132"},"1b889e8bb8f0e",["133","134","135"],[],{"type":"128","properties":"136","required":"137","title":"138","$schema":"109","x-stoplight":"139"},"ae1c16218ed0a",[],[],{"type":"128","x-examples":"140","properties":"141","required":"142","$schema":"109","x-stoplight":"143"},"string",["144"],"http://json-schema.org/draft-07/schema#",{"id":"145"},"name","in","required","schema","description","title",["146"],{"id":"147"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["125","148"],"object",{"Example 1":"149"},{"data":"150","next":"151"},{"id":"152"},{"id":"153"},{"id":"154","key":"155","value":"156","summary":"157"},{"id":"158","key":"159","value":"160","summary":"161"},{"id":"162","key":"163","value":"164","summary":"165"},{"status":"166","message":"167"},["168","169"],"UnauthorizedError",{"id":"170"},{"Example 1":"171"},{"name":"172","tags":"173","certificate":"174"},["111","175"],{"id":"176"},"team-a","db3e718cc1b83","my-sni","8cdb9ad76ba0f","https",{"data":"177","next":"178"},{"type":"179","description":"180","items":"181"},{"type":"107","description":"182","examples":"183"},"2fd950980b7e5","0a9d337c704dc","4fc545f213b50","DuplicateApiKey",{"message":"157","status":401},"Duplicate API key found","8994ec421d840","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","f9c09d8a3ba44","NoAPIKey",{"message":"184","status":401},"No API key found",{"type":"185"},{"type":"107"},"status","message","470b68e5f0549",{"name":"146","tags":"186","certificate":"187"},{"type":"107","description":"188","examples":"189"},{"type":"179","description":"190","items":"191"},{"type":"128","description":"192","properties":"193"},"certificate","de9cb28ac0ad1",["194","195"],"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","array","Array of SNIs",{"type":"128","properties":"196"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page",["178"],"No API key found in request","integer",["197","198"],{"id":"199"},"The SNI name to associate with the given certificate.",["146"],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"107","examples":"200"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object. With form-encoded, the notation is `certificate.id=<certificate id>`. With JSON, use `\"certificate\":{\"id\":\"<certificate id>\"}`.",{"id":"201"},{"id":"202","name":"146","created_at":1422386534,"tags":"203","certificate":"204"},{"id":"205","name":"146","created_at":1422386534,"tags":"206","certificate":"207"},{"id":"208","name":"209","created_at":"210","tags":"211","certificate":"212"},"user-level","low-priority","a2e013e8-7623-4494-a347-6d29108ff68b",["213"],{"type":"107","description":"214","examples":"215"},"147f5ef0-1ed6-4711-b77f-489262f8bff7",["197","198"],{"id":"216"},"b87eb55d-69a1-41d2-8653-8d706eecefc0",["217","218","219"],{"id":"220"},{"type":"107","description":"221","examples":"222"},{"type":"107","description":"223","examples":"224"},{"type":"185","description":"225","examples":"226"},{"type":"179","description":"190","items":"227"},{"type":"128","description":"228","properties":"229"},"[\"user-level\", \"low-priority\"]","91020192-062d-416f-a275-9addeeaffaf2",["214"],"a3ad71a8-6685-4b03-a101-980a953544f6","admin","high-priority","critical","4e8d95d4-40f2-4818-adcb-30e00c349618","The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",["202"],"The SNI name to associate with the given certificate.\n",["146"],"Unix epoch when the resource was created.\n",[1422386534],{"type":"107"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.\n",{"id":"230"},{"type":"107","description":"231","examples":"232"},"The unique identifier or the name attribute of the Certificate whose SNIs",["233"],"2e013e8-7623-4494-a347-6d29108ff68b"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-sni-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a SNI in a workspace",["18"],"39cb432fc020d","put","/{workspace}/snis/{sni_name_or_id}",["19"],{},"upsert-sni-in-workspace","Create or Update SNI using ID or name in a workspace.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"SNIs",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"89ee93e7858c2","e504281c6e23b","200",[],["57"],"SNI response object","1fa42773e52c3","400",[],["58"],"Invalid SNI","1fb42773e549c","401",[],["59"],"Unauthorized","357043ee2f675",["60"],"A JSON object containing the details of the new SNI, including the name, certificate, and tags.",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"101"},"dca1de7925c3f","workspace","simple",[],"Name or ID of workspace",{"type":"102","examples":"103","$schema":"104","x-stoplight":"105"},["106","107","108","109","110","111"],"b95046a92dfc5","sni_name_or_id",[],"The unique identifier or the name of the SNI to retrieve.",{"type":"102","examples":"112","$schema":"104","x-stoplight":"113"},["106","107","108","109","110","111"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121","enum":"122"},"5af7c150c5d29","application/json",[],[],{"type":"123","x-examples":"124","properties":"125","$schema":"104","x-stoplight":"126"},"b0fc431f6ec15",[],[],{"type":"123","$schema":"104","x-stoplight":"127"},"39f779136a6f1",["128","129","130"],[],{"type":"123","properties":"131","required":"132","title":"133","$schema":"104","x-stoplight":"134"},"1215c15a5df71",[],[],{"type":"123","x-examples":"135","properties":"136","required":"137","$schema":"104","x-stoplight":"138"},"string",["139"],"http://json-schema.org/draft-07/schema#",{"id":"140"},"name","in","required","schema","description","title",["141"],{"id":"142"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["120","143"],"object",{"Example 1":"144"},{"data":"145","next":"146"},{"id":"147"},{"id":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},{"id":"157","key":"158","value":"159","summary":"160"},{"status":"161","message":"162"},["163","164"],"UnauthorizedError",{"id":"165"},{"Example 1":"166"},{"name":"167","tags":"168","certificate":"169"},["106","170"],{"id":"171"},"team-a","6ab2f15c35f94","my-sni","6fecadfb1c6a8","https",{"data":"172","next":"173"},{"type":"174","description":"175","items":"176"},{"type":"102","description":"177","examples":"178"},"2fd950980b7e5","6404957fff427","57fc1ca23425f","DuplicateApiKey",{"message":"152","status":401},"Duplicate API key found","602e9a782484c","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","0c67f735c521a","NoAPIKey",{"message":"179","status":401},"No API key found",{"type":"180"},{"type":"102"},"status","message","470b68e5f0549",{"name":"141","tags":"181","certificate":"182"},{"type":"102","description":"183","examples":"184"},{"type":"174","description":"185","items":"186"},{"type":"123","description":"187","properties":"188"},"certificate","de9cb28ac0ad1",["189","190"],"http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","array","Array of SNIs",{"type":"123","properties":"191"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page",["173"],"No API key found in request","integer",["192","193"],{"id":"194"},"The SNI name to associate with the given certificate.",["141"],"An optional set of strings associated with the SNIs for grouping and filtering.\n",{"type":"102","examples":"195"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object. With form-encoded, the notation is `certificate.id=<certificate id>`. With JSON, use `\"certificate\":{\"id\":\"<certificate id>\"}`.",{"id":"196"},{"id":"197","name":"141","created_at":1422386534,"tags":"198","certificate":"199"},{"id":"200","name":"141","created_at":1422386534,"tags":"201","certificate":"202"},{"id":"203","name":"204","created_at":"205","tags":"206","certificate":"207"},"user-level","low-priority","a2e013e8-7623-4494-a347-6d29108ff68b",["208"],{"type":"102","description":"209","examples":"210"},"147f5ef0-1ed6-4711-b77f-489262f8bff7",["192","193"],{"id":"211"},"b87eb55d-69a1-41d2-8653-8d706eecefc0",["212","213","214"],{"id":"215"},{"type":"102","description":"216","examples":"217"},{"type":"102","description":"218","examples":"219"},{"type":"180","description":"220","examples":"221"},{"type":"174","description":"185","items":"222"},{"type":"123","description":"223","properties":"224"},"[\"user-level\", \"low-priority\"]","91020192-062d-416f-a275-9addeeaffaf2",["209"],"a3ad71a8-6685-4b03-a101-980a953544f6","admin","high-priority","critical","4e8d95d4-40f2-4818-adcb-30e00c349618","The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.",["197"],"The SNI name to associate with the given certificate.\n",["141"],"Unix epoch when the resource was created.\n",[1422386534],{"type":"102"},"The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.\n",{"id":"225"},{"type":"102","description":"226","examples":"227"},"The unique identifier or the name attribute of the Certificate whose SNIs",["228"],"2e013e8-7623-4494-a347-6d29108ff68b"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-target-with-upstream",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all Targets associated with an Upstream",["18"],"905d8c525eb28","get","/upstreams/{upstream_id_or_name}/targets",["19"],{},"list-target-with-upstream","List all Targets associated with a an Upstream","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Targets",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40","41"],[],["42"],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"3695ceb40c20e","ea05b2ae75c40","200",[],["49"],"A successful response listing Targets","5495b21d059fe","401",[],["50"],"Unauthorized",{"id":"51","name":"52","style":"53","examples":"54","description":"55","schema":"56","explicitProperties":"57"},{"id":"58","name":"59","style":"53","examples":"60","description":"61","schema":"62","explicitProperties":"63"},{"id":"64","name":"65","style":"53","examples":"66","description":"67","schema":"68","explicitProperties":"69"},{"id":"70","name":"71","style":"72","examples":"73","description":"74","required":true,"schema":"75","explicitProperties":"76"},{"id":"77","key":"78","extensions":"79","description":"80","type":"81","name":"82","in":"83"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"84","path":"85","port":"86","protocol":"87"},{"id":"88","mediaType":"89","examples":"90","encodings":"91","schema":"92"},{"id":"93","mediaType":"89","examples":"94","encodings":"95","schema":"96"},"46f9cca401fbf","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"97","$schema":"98","x-stoplight":"99"},["100","101","102","103","104"],"e6fef952de8b6","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"105","$schema":"98","x-stoplight":"106"},["100","101","102","103","104"],"e0d83f8665982","tags",["107"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"105","examples":"108","x-stoplight":"109","$schema":"98"},["100","110","101","102","103","104"],"f03c596d38d67","upstream_id_or_name","simple",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"105","examples":"111","$schema":"98","x-stoplight":"112"},["102","101","113","103","100","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121","enum":"122"},"5b2ea396f5134","application/json",[],[],{"properties":"123","$schema":"98","x-stoplight":"124"},"e68ec908bf519",["125","126","127"],[],{"type":"128","properties":"129","required":"130","title":"131","$schema":"98","x-stoplight":"132"},"integer","http://json-schema.org/draft-07/schema#",{"id":"133"},"description","in","name","schema","title","string",{"id":"134"},{"id":"135","value":"136","key":"137"},["136"],{"explicitProperties":"138","id":"139"},"example",["140"],{"id":"141"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["120","142"],{"data":"143","offset":"144"},{"id":"145"},{"id":"146","key":"147","value":"148","summary":"149"},{"id":"150","key":"151","value":"152","summary":"153"},{"id":"154","key":"155","value":"156","summary":"157"},"object",{"status":"158","message":"159"},["160","161"],"UnauthorizedError",{"id":"162"},"8b684c9a86e4a","64a1b99fd3241","d4635aec4c47e","tag1,tag2","default",["163","164","165"],"4ca213236dbbc","7fca84d6-7d37-4a74-a7b0-93e576089a41","9611ee079df7d","https",{"items":"166","type":"167"},{"description":"168","type":"105","title":"169"},"17cafe5fe76e3","20b0f42625eae","DuplicateApiKey",{"message":"149","status":401},"Duplicate API key found","b2bcb09a4df5d","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","1282e064c5a75","NoAPIKey",{"message":"170","status":401},"No API key found",{"type":"97"},{"type":"105"},"status","message","470b68e5f0549","type","nullable","examples",{"description":"171","properties":"172","type":"128","title":"173","examples":"174"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","No API key found in request","A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly. To disable a target, post a new one with `weight=0`; alternatively, use the `DELETE` convenience method to accomplish the same. The current target object definition is the one with the latest `created_at`.",{"created_at":"175","id":"176","tags":"177","target":"178","updated_at":"179","upstream":"180","weight":"181"},"Target",["182"],{"description":"183","type":"184"},{"type":"105"},{"description":"185","items":"186","type":"167"},{"description":"187","type":"105"},{"description":"188","type":"184"},{"additionalProperties":false,"properties":"189","type":"128"},{"default":100,"description":"190","type":"97"},{"id":"191","target":"192","upstream":"193","weight":100},"Unix epoch when the resource was created.","number","An optional set of strings associated with the Target for grouping and filtering.",{"type":"105"},"The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the `port` value will be overridden by the value from the DNS record.","Unix epoch when the resource was last updated.",{"id":"194"},"The weight this target gets within the upstream loadbalancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","089292a7-ba3d-4d88-acf0-97b4b2e2621a","203.0.113.42",{"id":"195"},{"type":"105"},"5f1d7e76-2fed-4806-a6af-869984f025cb"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-target-with-upstream",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new Target associated with an Upstream",["17"],"99fdf4f0580ee","post","/upstreams/{upstream_id_or_name}/targets",["18"],{},"create-target-with-upstream","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Targets",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48"],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"3695ceb40c20e","6e60ed6974793","200",[],["55"],"Successfully created Target","3bc0edf5242fa","400",[],["56"],"Invalid Target","3bd0edf5240a9","401",[],["57"],"Unauthorized","6abb797517723",["58"],"The request body for creating a new target entity.",{"id":"59","name":"60","style":"61","examples":"62","description":"63","required":true,"schema":"64","explicitProperties":"65"},{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},{"id":"86","mediaType":"78","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"78","examples":"91","encodings":"92","schema":"93"},"62a5436d633a7","upstream_id_or_name","simple",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"94","examples":"95","$schema":"96","x-stoplight":"97"},["98","99","100","101","102","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111","enum":"112"},"d7ed2e68ea9be","application/json",["113"],[],{"description":"114","properties":"115","type":"116","title":"117","examples":"118"},"9cbabcc3b927d",[],[],{"type":"116","$schema":"96","x-stoplight":"119"},"4136ffbd06043",["120","121","122"],[],{"type":"116","properties":"123","required":"124","title":"125","$schema":"96","x-stoplight":"126"},"3c1f253eaed44",["127"],[],{"type":"116","x-examples":"128","properties":"129","$schema":"96","x-stoplight":"130"},"string",["131"],"http://json-schema.org/draft-07/schema#",{"id":"132"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["110","133"],{"id":"134","value":"135","key":"136"},"A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly. To disable a target, post a new one with `weight=0`; alternatively, use the `DELETE` convenience method to accomplish the same. The current target object definition is the one with the latest `created_at`.",{"created_at":"137","id":"138","tags":"139","target":"140","updated_at":"141","upstream":"142","weight":"143"},"object","Target",["135"],{"id":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},{"status":"157","message":"158"},["159","160"],"UnauthorizedError",{"id":"161"},{"id":"162","key":"163","value":"164"},{"Example 1":"165"},{"upstream":"166","weight":"167","tags":"168"},{"id":"169"},"7fca84d6-7d37-4a74-a7b0-93e576089a41","4cddd99f7ad53","https","d52eca51462ed",{"id":"170","target":"171","upstream":"172","weight":100},"default",{"description":"173","type":"174"},{"type":"94"},{"description":"175","items":"176","type":"177"},{"description":"178","type":"94"},{"description":"179","type":"174"},{"additionalProperties":false,"properties":"180","type":"116"},{"default":100,"description":"181","type":"182"},"b076946e42556","9e66cc903ed42","DuplicateApiKey",{"message":"148","status":401},"Duplicate API key found","82e773ed00853","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","3f31ce55c0cfa","NoAPIKey",{"message":"183","status":401},"No API key found",{"type":"182"},{"type":"94"},"status","message","470b68e5f0549","fc96422344299","Example",{"upstream":"184","weight":100,"tags":"185"},{"upstream":"186","target":"187","weight":100,"tags":"188"},{"type":"116","description":"189","properties":"190"},{"default":100,"description":"191","type":"182","minimum":0,"maximum":65535},{"type":"177","description":"192","items":"193"},"536eb446aedaf","089292a7-ba3d-4d88-acf0-97b4b2e2621a","203.0.113.42",{"id":"194"},"Unix epoch when the resource was created.","number","An optional set of strings associated with the Target for grouping and filtering.",{"type":"94"},"array","The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the `port` value will be overridden by the value from the DNS record.","Unix epoch when the resource was last updated.",{"id":"195"},"The weight this target gets within the upstream loadbalancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","integer","No API key found in request",{"id":"196"},["94"],{"id":"197"},"example.com:8000",["198","199"],"The unique identifier or the name of the upstream for which to update the target.\n",{"id":"200"},"The weight this target gets within the upstream load balancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","An optional set of strings associated with the target for grouping and filtering.",{"type":"94"},"5f1d7e76-2fed-4806-a6af-869984f025cb",{"type":"94"},"173a6cee-90d1-40a7-89cf-0329eca780a6","bdab0e47-4e37-4f0b-8fd0-87d95cc4addc","user-level","low-priority",{"type":"94","description":"201","examples":"202"},"The unique identifier or the name of the upstream for which to update the target.",["196"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-target-with-upstream",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a Target associated with a an Upstream",["18"],"66b0a3093d19b","delete","/upstreams/{upstream_id_or_name}/targets/{target_id_or_target}",["19"],{},"delete-target-with-upstream","Delete a Target associated with a an Upstream using ID or target.","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Targets",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33","34"],["35"],{"id":"36","url":"37","name":"38","description":"39","variables":"40"},"3695ceb40c20e","865bf7ec90f21","204",[],[],"Successfully deleted Target or the resource didn't exist",{"id":"41","name":"42","style":"43","examples":"44","description":"45","required":true,"schema":"46","explicitProperties":"47"},{"id":"48","name":"49","style":"43","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},"1e5dc59aa3dd0","upstream_id_or_name","simple",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"65","examples":"66","$schema":"67","x-stoplight":"68"},["69","70","71","72","73","74"],"960f7a1becd4b","target_id_or_target",[],"The host/port combination element of the target to set as unhealthy, or the `id` of an existing target entry.",{"type":"65","examples":"75","$schema":"67","x-stoplight":"76"},["69","70","71","72","73","74"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"77","description":"78"},{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84","enum":"85"},"string",["86"],"http://json-schema.org/draft-07/schema#",{"id":"87"},"name","in","required","schema","description","title",["88"],{"id":"89"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["83","90"],"7fca84d6-7d37-4a74-a7b0-93e576089a41","473c26ea8b976","example.com:8000","64028a79c025d","https"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/fetch-target-with-upstream",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a Target associated with an Upstream",["18"],"df72bf8607e85","get","/upstreams/{upstream_id_or_name}/targets/{target_id_or_target}",["19"],{},"fetch-target-with-upstream","Get a Target associated with an Upstream using ID or target.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Targets",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46"],["47"],{"id":"48","url":"49","name":"50","description":"51","variables":"52"},"3695ceb40c20e","8acfd2f058fb3","200",[],["53"],"Successfully fetched Target","bd5fd247c1d4f","401",[],["54"],"Unauthorized","bdafd247c22cc","404",[],[],"Resource does not exist",{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"57","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"659d08ce3d842","upstream_id_or_name","simple",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"88","examples":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96","97"],"64928d1ea7bd0","target_id_or_target",[],"The host/port combination element of the target to set as unhealthy, or the `id` of an existing target entry.",{"type":"88","examples":"98","$schema":"90","x-stoplight":"99"},["92","93","94","95","96","97"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107","enum":"108"},"45398293dfb95","application/json",["109"],[],{"description":"110","properties":"111","type":"112","title":"113","examples":"114"},"669ce582f81c6",["115","116","117"],[],{"type":"112","properties":"118","required":"119","title":"120","$schema":"90","x-stoplight":"121"},"string",["122"],"http://json-schema.org/draft-07/schema#",{"id":"123"},"name","in","required","schema","description","title",["124"],{"id":"125"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["106","126"],{"id":"127","value":"128","key":"129"},"A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly. To disable a target, post a new one with `weight=0`; alternatively, use the `DELETE` convenience method to accomplish the same. The current target object definition is the one with the latest `created_at`.",{"created_at":"130","id":"131","tags":"132","target":"133","updated_at":"134","upstream":"135","weight":"136"},"object","Target",["128"],{"id":"137","key":"138","value":"139","summary":"140"},{"id":"141","key":"142","value":"143","summary":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"status":"149","message":"150"},["151","152"],"UnauthorizedError",{"id":"153"},"7fca84d6-7d37-4a74-a7b0-93e576089a41","0d46f745c6d17","example.com:8000","b41bb5a66866b","https","a22408e686b81",{"id":"154","target":"155","upstream":"156","weight":100},"default",{"description":"157","type":"158"},{"type":"88"},{"description":"159","items":"160","type":"161"},{"description":"162","type":"88"},{"description":"163","type":"158"},{"additionalProperties":false,"properties":"164","type":"112"},{"default":100,"description":"165","type":"166"},"b15baee401f27","DuplicateApiKey",{"message":"140","status":401},"Duplicate API key found","755efc0ec7018","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","f9b466ec129c8","NoAPIKey",{"message":"167","status":401},"No API key found",{"type":"166"},{"type":"88"},"status","message","470b68e5f0549","089292a7-ba3d-4d88-acf0-97b4b2e2621a","203.0.113.42",{"id":"168"},"Unix epoch when the resource was created.","number","An optional set of strings associated with the Target for grouping and filtering.",{"type":"88"},"array","The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the `port` value will be overridden by the value from the DNS record.","Unix epoch when the resource was last updated.",{"id":"169"},"The weight this target gets within the upstream loadbalancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","integer","No API key found in request","5f1d7e76-2fed-4806-a6af-869984f025cb",{"type":"88"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-target-with-upstream",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a Target associated with a an Upstream",["18"],"44af51a5fd16f","patch","/upstreams/{upstream_id_or_name}/targets/{target_id_or_target}",["19"],{},"update-target-with-upstream","Update a Target associated with a an Upstream using ID or target.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"Targets",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55","56"],["57"],{"id":"58","url":"59","name":"60","description":"61","variables":"62"},"3695ceb40c20e","19edb21a412f6","200",[],["63"],"Successfully updated Target","548db171b82af","400",[],["64"],"Invalid Target","547db171b80f0","401",[],["65"],"Unauthorized","54cdb171b8973","404",[],[],"Resource does not exist","77cef0fe44cc7",["66"],"The request body for creating a new target entity.",{"id":"67","name":"68","style":"69","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","name":"75","style":"69","examples":"76","description":"77","required":true,"schema":"78","explicitProperties":"79"},{"id":"80","key":"81","extensions":"82","description":"83","type":"84","name":"85","in":"86"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"87","path":"88","port":"89","protocol":"90"},{"id":"91","mediaType":"92","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"92","examples":"97","encodings":"98","schema":"99"},{"id":"100","mediaType":"92","examples":"101","encodings":"102","schema":"103"},{"id":"104","mediaType":"92","examples":"105","encodings":"106","schema":"107"},"54a6921ade84e","upstream_id_or_name","simple",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"108","examples":"109","$schema":"110","x-stoplight":"111"},["112","113","114","115","116","117"],"9c4f43c33c6d8","target_id_or_target",[],"The host/port combination element of the target to set as unhealthy, or the `id` of an existing target entry.",{"type":"108","examples":"118","$schema":"110","x-stoplight":"119"},["112","113","114","115","116","117"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"120","description":"121"},{"default":"122","description":"123"},{"default":"124","description":"125"},{"default":"126","description":"127","enum":"128"},"4295eca6e36a2","application/json",["129"],[],{"description":"130","properties":"131","type":"132","title":"133","examples":"134"},"e0aafe62906fb",[],[],{"type":"132","$schema":"110","x-stoplight":"135"},"8b04bc8d67449",["136","137","138"],[],{"type":"132","properties":"139","required":"140","title":"141","$schema":"110","x-stoplight":"142"},"cbd8ef0ad4c2e",["143"],[],{"type":"132","x-examples":"144","properties":"145","$schema":"110","x-stoplight":"146"},"string",["147"],"http://json-schema.org/draft-07/schema#",{"id":"148"},"name","in","required","schema","description","title",["149"],{"id":"150"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["126","151"],{"id":"152","value":"153","key":"154"},"A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly. To disable a target, post a new one with `weight=0`; alternatively, use the `DELETE` convenience method to accomplish the same. The current target object definition is the one with the latest `created_at`.",{"created_at":"155","id":"156","tags":"157","target":"158","updated_at":"159","upstream":"160","weight":"161"},"object","Target",["153"],{"id":"162"},{"id":"163","key":"164","value":"165","summary":"166"},{"id":"167","key":"168","value":"169","summary":"170"},{"id":"171","key":"172","value":"173","summary":"174"},{"status":"175","message":"176"},["177","178"],"UnauthorizedError",{"id":"179"},{"id":"180","key":"181","value":"182"},{"Example 1":"183"},{"upstream":"184","weight":"185","tags":"186"},{"id":"187"},"7fca84d6-7d37-4a74-a7b0-93e576089a41","c14ba66333c4d","example.com:8000","9d2c9e106d6e9","https","da485fbc3ec8e",{"id":"188","target":"189","upstream":"190","weight":100},"default",{"description":"191","type":"192"},{"type":"108"},{"description":"193","items":"194","type":"195"},{"description":"196","type":"108"},{"description":"197","type":"192"},{"additionalProperties":false,"properties":"198","type":"132"},{"default":100,"description":"199","type":"200"},"1aeba91c3b697","96a9aa66db3ec","DuplicateApiKey",{"message":"166","status":401},"Duplicate API key found","b5ae205cb8e2d","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","e22349adc22ee","NoAPIKey",{"message":"201","status":401},"No API key found",{"type":"200"},{"type":"108"},"status","message","470b68e5f0549","9741f18568654","Example",{"upstream":"202","weight":100,"tags":"203"},{"upstream":"204","target":"149","weight":100,"tags":"205"},{"type":"132","description":"206","properties":"207"},{"default":100,"description":"208","type":"200","minimum":0,"maximum":65535},{"type":"195","description":"209","items":"210"},"536eb446aedaf","089292a7-ba3d-4d88-acf0-97b4b2e2621a","203.0.113.42",{"id":"211"},"Unix epoch when the resource was created.","number","An optional set of strings associated with the Target for grouping and filtering.",{"type":"108"},"array","The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the `port` value will be overridden by the value from the DNS record.","Unix epoch when the resource was last updated.",{"id":"212"},"The weight this target gets within the upstream loadbalancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","integer","No API key found in request",{"id":"213"},["108"],{"id":"214"},["215","216"],"The unique identifier or the name of the upstream for which to update the target.\n",{"id":"217"},"The weight this target gets within the upstream load balancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","An optional set of strings associated with the target for grouping and filtering.",{"type":"108"},"5f1d7e76-2fed-4806-a6af-869984f025cb",{"type":"108"},"173a6cee-90d1-40a7-89cf-0329eca780a6","bdab0e47-4e37-4f0b-8fd0-87d95cc4addc","user-level","low-priority",{"type":"108","description":"218","examples":"219"},"The unique identifier or the name of the upstream for which to update the target.",["213"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-target-with-upstream",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a Target associated with an Upstream",["18"],"eff8aab02970a","put","/upstreams/{upstream_id_or_name}/targets/{target_id_or_target}",["19"],{},"upsert-target-with-upstream","Create or Update a Target associated with an Upstream using ID or target.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Targets",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"3695ceb40c20e","b06673d001edc","200",[],["57"],"Successfully upserted Target","584671f33e2a0","400",[],["58"],"Invalid Target","583671f33ecd3","401",[],["59"],"Unauthorized","426db3f1514e8",["60"],"The request body for creating a new target entity.",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"101"},"d4c1ec61dd8c2","upstream_id_or_name","simple",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"102","examples":"103","$schema":"104","x-stoplight":"105"},["106","107","108","109","110","111"],"3d0670865e85b","target_id_or_target",[],"The host/port combination element of the target to set as unhealthy, or the `id` of an existing target entry.",{"type":"102","examples":"112","$schema":"104","x-stoplight":"113"},["106","107","108","109","110","111"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121","enum":"122"},"6f276e6679827","application/json",["123"],[],{"description":"124","properties":"125","type":"126","title":"127","examples":"128"},"102906b30b87d",[],[],{"type":"126","$schema":"104","x-stoplight":"129"},"6df977c598ab4",["130","131","132"],[],{"type":"126","properties":"133","required":"134","title":"135","$schema":"104","x-stoplight":"136"},"171997084ab20",["137"],[],{"type":"126","x-examples":"138","properties":"139","$schema":"104","x-stoplight":"140"},"string",["141"],"http://json-schema.org/draft-07/schema#",{"id":"142"},"name","in","required","schema","description","title",["143"],{"id":"144"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["120","145"],{"id":"146","value":"147","key":"148"},"A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly. To disable a target, post a new one with `weight=0`; alternatively, use the `DELETE` convenience method to accomplish the same. The current target object definition is the one with the latest `created_at`.",{"created_at":"149","id":"150","tags":"151","target":"152","updated_at":"153","upstream":"154","weight":"155"},"object","Target",["147"],{"id":"156"},{"id":"157","key":"158","value":"159","summary":"160"},{"id":"161","key":"162","value":"163","summary":"164"},{"id":"165","key":"166","value":"167","summary":"168"},{"status":"169","message":"170"},["171","172"],"UnauthorizedError",{"id":"173"},{"id":"174","key":"175","value":"176"},{"Example 1":"177"},{"upstream":"178","weight":"179","tags":"180"},{"id":"181"},"7fca84d6-7d37-4a74-a7b0-93e576089a41","40ee068942779","example.com:8000","094495d930b6a","https","870ea7c88cda1",{"id":"182","target":"183","upstream":"184","weight":100},"default",{"description":"185","type":"186"},{"type":"102"},{"description":"187","items":"188","type":"189"},{"description":"190","type":"102"},{"description":"191","type":"186"},{"additionalProperties":false,"properties":"192","type":"126"},{"default":100,"description":"193","type":"194"},"93ff18339a55c","62e9960867590","DuplicateApiKey",{"message":"160","status":401},"Duplicate API key found","03eb323c15d69","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","068f7475e9510","NoAPIKey",{"message":"195","status":401},"No API key found",{"type":"194"},{"type":"102"},"status","message","470b68e5f0549","71ac2f283d8e2","Example",{"upstream":"196","weight":100,"tags":"197"},{"upstream":"198","target":"143","weight":100,"tags":"199"},{"type":"126","description":"200","properties":"201"},{"default":100,"description":"202","type":"194","minimum":0,"maximum":65535},{"type":"189","description":"203","items":"204"},"536eb446aedaf","089292a7-ba3d-4d88-acf0-97b4b2e2621a","203.0.113.42",{"id":"205"},"Unix epoch when the resource was created.","number","An optional set of strings associated with the Target for grouping and filtering.",{"type":"102"},"array","The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the `port` value will be overridden by the value from the DNS record.","Unix epoch when the resource was last updated.",{"id":"206"},"The weight this target gets within the upstream loadbalancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","integer","No API key found in request",{"id":"207"},["102"],{"id":"208"},["209","210"],"The unique identifier or the name of the upstream for which to update the target.\n",{"id":"211"},"The weight this target gets within the upstream load balancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","An optional set of strings associated with the target for grouping and filtering.",{"type":"102"},"5f1d7e76-2fed-4806-a6af-869984f025cb",{"type":"102"},"173a6cee-90d1-40a7-89cf-0329eca780a6","bdab0e47-4e37-4f0b-8fd0-87d95cc4addc","user-level","low-priority",{"type":"102","description":"212","examples":"213"},"The unique identifier or the name of the upstream for which to update the target.",["207"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-targets-with-upstream-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all Targets associated with an Upstream in a workspace",["18"],"28406a61551b2","get","/{workspace}/upstreams/{upstream_id_or_name}/targets",["19"],{},"list-targets-with-upstream-workspace","List all Targets associated with a an Upstream in a workspace","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Targets",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40","41"],[],["42","43"],["44"],{"id":"45","url":"46","name":"47","description":"48","variables":"49"},"3695ceb40c20e","b9fcf9423ca2b","200",[],["50"],"A successful response listing Targets","ecacf8b68c98f","401",[],["51"],"Unauthorized",{"id":"52","name":"53","style":"54","examples":"55","description":"56","schema":"57","explicitProperties":"58"},{"id":"59","name":"60","style":"54","examples":"61","description":"62","schema":"63","explicitProperties":"64"},{"id":"65","name":"66","style":"54","examples":"67","description":"68","schema":"69","explicitProperties":"70"},{"id":"71","name":"72","style":"73","examples":"74","description":"75","required":true,"schema":"76","explicitProperties":"77"},{"id":"78","name":"79","style":"73","examples":"80","description":"81","required":true,"schema":"82","explicitProperties":"83"},{"id":"84","key":"85","extensions":"86","description":"87","type":"88","name":"89","in":"90"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"91","path":"92","port":"93","protocol":"94"},{"id":"95","mediaType":"96","examples":"97","encodings":"98","schema":"99"},{"id":"100","mediaType":"96","examples":"101","encodings":"102","schema":"103"},"600f49c3fb438","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"104","$schema":"105","x-stoplight":"106"},["107","108","109","110","111"],"496a95f43af45","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"112","$schema":"105","x-stoplight":"113"},["107","108","109","110","111"],"eeb3001a83fd0","tags",["114"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"112","examples":"115","x-stoplight":"116","$schema":"105"},["107","117","108","109","110","111"],"a4d167280d6dc","workspace","simple",[],"Name or ID of workspace",{"type":"112","examples":"118","$schema":"105","x-stoplight":"119"},["109","108","120","110","107","111"],"bc32f5bd8699f","upstream_id_or_name",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"112","examples":"121","$schema":"105","x-stoplight":"122"},["109","108","120","110","107","111"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"123","description":"124"},{"default":"125","description":"126"},{"default":"127","description":"128"},{"default":"129","description":"130","enum":"131"},"471ea506f27ce","application/json",["132"],[],{"description":"133","properties":"134","type":"135","title":"136","examples":"137"},"15e7935058e7b",["138","139","140"],[],{"type":"135","properties":"141","required":"142","title":"143","$schema":"105","x-stoplight":"144"},"integer","http://json-schema.org/draft-07/schema#",{"id":"145"},"description","in","name","schema","title","string",{"id":"146"},{"id":"147","value":"148","key":"149"},["148"],{"explicitProperties":"150","id":"151"},"example",["152"],{"id":"153"},"required",["154"],{"id":"155"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["129","156"],{"id":"157","value":"158","key":"149"},"A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly. To disable a target, post a new one with `weight=0`; alternatively, use the `DELETE` convenience method to accomplish the same. The current target object definition is the one with the latest `created_at`.",{"created_at":"159","id":"160","tags":"161","target":"162","updated_at":"163","upstream":"164","weight":"165"},"object","Target",["158"],{"id":"166","key":"167","value":"168","summary":"169"},{"id":"170","key":"171","value":"172","summary":"173"},{"id":"174","key":"175","value":"176","summary":"177"},{"status":"178","message":"179"},["180","181"],"UnauthorizedError",{"id":"182"},"d274b1817079a","84563c836585a","96ec8d4d44efa","tag1,tag2","default",["183","184","185"],"b2e8c81a46815","team-a","e1f5473ddf2fb","7fca84d6-7d37-4a74-a7b0-93e576089a41","c47f275475376","https","988bc22f54c30",{"id":"186","target":"187","upstream":"188","weight":100},{"description":"189","type":"190"},{"type":"112"},{"description":"191","items":"192","type":"193"},{"description":"194","type":"112"},{"description":"195","type":"190"},{"additionalProperties":false,"properties":"196","type":"135"},{"default":100,"description":"197","type":"104"},"42422d5d34757","DuplicateApiKey",{"message":"169","status":401},"Duplicate API key found","8445ee6cd4bf3","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","f1936ceca21db","NoAPIKey",{"message":"198","status":401},"No API key found",{"type":"104"},{"type":"112"},"status","message","470b68e5f0549","type","nullable","examples","089292a7-ba3d-4d88-acf0-97b4b2e2621a","203.0.113.42",{"id":"199"},"Unix epoch when the resource was created.","number","An optional set of strings associated with the Target for grouping and filtering.",{"type":"112"},"array","The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the `port` value will be overridden by the value from the DNS record.","Unix epoch when the resource was last updated.",{"id":"200"},"The weight this target gets within the upstream loadbalancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","No API key found in request","5f1d7e76-2fed-4806-a6af-869984f025cb",{"type":"112"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-target-with-upstream-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new Target associated with an Upstream in a workspace",["17"],"c72067e0874c7","post","/{workspace}/upstreams/{upstream_id_or_name}/targets",["18"],{},"create-target-with-upstream-workspace","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Targets",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48","49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"3695ceb40c20e","02da1c0b580e4","200",[],["56"],"Successfully created Target","62fa1de828d68","400",[],["57"],"Invalid Target","630a1de828fdf","401",[],["58"],"Unauthorized","48570978089a2",["59"],"The request body for creating a new target entity.",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","name":"68","style":"62","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","key":"74","extensions":"75","description":"76","type":"77","name":"78","in":"79"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"80","path":"81","port":"82","protocol":"83"},{"id":"84","mediaType":"85","examples":"86","encodings":"87","schema":"88"},{"id":"89","mediaType":"85","examples":"90","encodings":"91","schema":"92"},{"id":"93","mediaType":"85","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"85","examples":"98","encodings":"99","schema":"100"},"bc7a03747548a","workspace","simple",[],"Name or ID of workspace",{"type":"101","examples":"102","$schema":"103","x-stoplight":"104"},["105","106","107","108","109","110"],"1f2d71ef849a6","upstream_id_or_name",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"101","examples":"111","$schema":"103","x-stoplight":"112"},["105","106","107","108","109","110"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"b08ed0b189e9d","application/json",["122"],[],{"description":"123","properties":"124","type":"125","title":"126","examples":"127"},"90937323f69da",[],[],{"type":"125","$schema":"103","x-stoplight":"128"},"d79a677d85150",["129","130","131"],[],{"type":"125","properties":"132","required":"133","title":"134","$schema":"103","x-stoplight":"135"},"d54b4fda278e9",["136"],[],{"type":"125","x-examples":"137","properties":"138","$schema":"103","x-stoplight":"139"},"string",["140"],"http://json-schema.org/draft-07/schema#",{"id":"141"},"name","in","required","schema","description","title",["142"],{"id":"143"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","144"],{"id":"145","value":"146","key":"147"},"A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly. To disable a target, post a new one with `weight=0`; alternatively, use the `DELETE` convenience method to accomplish the same. The current target object definition is the one with the latest `created_at`.",{"created_at":"148","id":"149","tags":"150","target":"151","updated_at":"152","upstream":"153","weight":"154"},"object","Target",["146"],{"id":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"id":"160","key":"161","value":"162","summary":"163"},{"id":"164","key":"165","value":"166","summary":"167"},{"status":"168","message":"169"},["170","171"],"UnauthorizedError",{"id":"172"},{"id":"173","key":"174","value":"175"},{"Example 1":"176"},{"upstream":"177","weight":"178","tags":"179"},{"id":"180"},"team-a","02f41dc10b8f1","7fca84d6-7d37-4a74-a7b0-93e576089a41","45936507763c8","https","cbf9bf22e56c9",{"id":"181","target":"182","upstream":"183","weight":100},"default",{"description":"184","type":"185"},{"type":"101"},{"description":"186","items":"187","type":"188"},{"description":"189","type":"101"},{"description":"190","type":"185"},{"additionalProperties":false,"properties":"191","type":"125"},{"default":100,"description":"192","type":"193"},"15289c799c5e1","8b0e1c22946e7","DuplicateApiKey",{"message":"159","status":401},"Duplicate API key found","dd0508e5fc5ef","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","d7f4c07352a96","NoAPIKey",{"message":"194","status":401},"No API key found",{"type":"193"},{"type":"101"},"status","message","470b68e5f0549","6902cacfe49ab","Example",{"upstream":"195","weight":100,"tags":"196"},{"upstream":"197","target":"198","weight":100,"tags":"199"},{"type":"125","description":"200","properties":"201"},{"default":100,"description":"202","type":"193","minimum":0,"maximum":65535},{"type":"188","description":"203","items":"204"},"536eb446aedaf","089292a7-ba3d-4d88-acf0-97b4b2e2621a","203.0.113.42",{"id":"205"},"Unix epoch when the resource was created.","number","An optional set of strings associated with the Target for grouping and filtering.",{"type":"101"},"array","The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the `port` value will be overridden by the value from the DNS record.","Unix epoch when the resource was last updated.",{"id":"206"},"The weight this target gets within the upstream loadbalancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","integer","No API key found in request",{"id":"207"},["101"],{"id":"208"},"example.com:8000",["209","210"],"The unique identifier or the name of the upstream for which to update the target.\n",{"id":"211"},"The weight this target gets within the upstream load balancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","An optional set of strings associated with the target for grouping and filtering.",{"type":"101"},"5f1d7e76-2fed-4806-a6af-869984f025cb",{"type":"101"},"173a6cee-90d1-40a7-89cf-0329eca780a6","bdab0e47-4e37-4f0b-8fd0-87d95cc4addc","user-level","low-priority",{"type":"101","description":"212","examples":"213"},"The unique identifier or the name of the upstream for which to update the target.",["207"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-target-with-upstream-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a Target associated with a an Upstream in a workspace",["18"],"147e8d1cb28dd","delete","/{workspace}/upstreams/{upstream_id_or_name}/targets/{target_id_or_target}",["19"],{},"delete-target-with-upstream-workspace","Delete a Target associated with a an Upstream using ID or target in a workspace.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Targets",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40","41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"3695ceb40c20e","ff0ca71a2ebf7","204",[],[],"Successfully deleted Target or the resource didn't exist","26fca8dfd7b52","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","required":true,"schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"51","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},"4331318278592","workspace","simple",[],"Name or ID of workspace",{"type":"84","examples":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92","93"],"83b7b0609f361","upstream_id_or_name",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"84","examples":"94","$schema":"86","x-stoplight":"95"},["88","89","90","91","92","93"],"6fb37b288a3d5","target_id_or_target",[],"The host/port combination element of the target to set as unhealthy, or the `id` of an existing target entry.",{"type":"84","examples":"96","$schema":"86","x-stoplight":"97"},["88","89","90","91","92","93"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"98","description":"99"},{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105","enum":"106"},"9956182990628","application/json",["107","108","109"],[],{"type":"110","properties":"111","required":"112","title":"113","$schema":"86","x-stoplight":"114"},"string",["115"],"http://json-schema.org/draft-07/schema#",{"id":"116"},"name","in","required","schema","description","title",["117"],{"id":"118"},["119"],{"id":"120"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["104","121"],{"id":"122","key":"123","value":"124","summary":"125"},{"id":"126","key":"127","value":"128","summary":"129"},{"id":"130","key":"131","value":"132","summary":"133"},"object",{"status":"134","message":"135"},["136","137"],"UnauthorizedError",{"id":"138"},"team-a","8af0e8fd3809f","7fca84d6-7d37-4a74-a7b0-93e576089a41","d2024186ab10e","example.com:8000","84d6e82aba989","https","55dcda775a73f","DuplicateApiKey",{"message":"125","status":401},"Duplicate API key found","ec1e8cdfc8af2","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","e9a1226166d39","NoAPIKey",{"message":"139","status":401},"No API key found",{"type":"140"},{"type":"84"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/fetch-target-with-upstream-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a Target associated with an Upstream in a workspace",["18"],"351e25dd8b206","get","/{workspace}/upstreams/{upstream_id_or_name}/targets/{target_id_or_target}",["19"],{},"fetch-target-with-upstream-workspace","Get a Target associated with an Upstream using ID or target in a workspace.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Targets",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46","47"],["48"],{"id":"49","url":"50","name":"51","description":"52","variables":"53"},"3695ceb40c20e","232bd3a528d0b","200",[],["54"],"Successfully fetched Target","4b5bd56ad16c3","401",[],["55"],"Unauthorized","4b0bd56ad1f40","404",[],[],"Resource does not exist",{"id":"56","name":"57","style":"58","examples":"59","description":"60","required":true,"schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"58","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"58","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","key":"76","extensions":"77","description":"78","type":"79","name":"80","in":"81"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"82","path":"83","port":"84","protocol":"85"},{"id":"86","mediaType":"87","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"87","examples":"92","encodings":"93","schema":"94"},"5d06b6f060288","workspace","simple",[],"Name or ID of workspace",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"3124be3676c65","upstream_id_or_name",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"95","examples":"105","$schema":"97","x-stoplight":"106"},["99","100","101","102","103","104"],"11bdbb2a6ec63","target_id_or_target",[],"The host/port combination element of the target to set as unhealthy, or the `id` of an existing target entry.",{"type":"95","examples":"107","$schema":"97","x-stoplight":"108"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"109","description":"110"},{"default":"111","description":"112"},{"default":"113","description":"114"},{"default":"115","description":"116","enum":"117"},"3312a06ee9c4a","application/json",["118"],[],{"description":"119","properties":"120","type":"121","title":"122","examples":"123"},"e6e5a7446b5d1",["124","125","126"],[],{"type":"121","properties":"127","required":"128","title":"129","$schema":"97","x-stoplight":"130"},"string",["131"],"http://json-schema.org/draft-07/schema#",{"id":"132"},"name","in","required","schema","description","title",["133"],{"id":"134"},["135"],{"id":"136"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["115","137"],{"id":"138","value":"139","key":"140"},"A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly. To disable a target, post a new one with `weight=0`; alternatively, use the `DELETE` convenience method to accomplish the same. The current target object definition is the one with the latest `created_at`.",{"created_at":"141","id":"142","tags":"143","target":"144","updated_at":"145","upstream":"146","weight":"147"},"object","Target",["139"],{"id":"148","key":"149","value":"150","summary":"151"},{"id":"152","key":"153","value":"154","summary":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"status":"160","message":"161"},["162","163"],"UnauthorizedError",{"id":"164"},"team-a","87e2c607728a0","7fca84d6-7d37-4a74-a7b0-93e576089a41","78bf9bdeca64d","example.com:8000","e5e1474639bda","https","d5a864b13a60c",{"id":"165","target":"166","upstream":"167","weight":100},"default",{"description":"168","type":"169"},{"type":"95"},{"description":"170","items":"171","type":"172"},{"description":"173","type":"95"},{"description":"174","type":"169"},{"additionalProperties":false,"properties":"175","type":"121"},{"default":100,"description":"176","type":"177"},"7e27437113899","DuplicateApiKey",{"message":"151","status":401},"Duplicate API key found","8ab6381c8748d","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","0fbc5e33784e3","NoAPIKey",{"message":"178","status":401},"No API key found",{"type":"177"},{"type":"95"},"status","message","470b68e5f0549","089292a7-ba3d-4d88-acf0-97b4b2e2621a","203.0.113.42",{"id":"179"},"Unix epoch when the resource was created.","number","An optional set of strings associated with the Target for grouping and filtering.",{"type":"95"},"array","The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the `port` value will be overridden by the value from the DNS record.","Unix epoch when the resource was last updated.",{"id":"180"},"The weight this target gets within the upstream loadbalancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","integer","No API key found in request","5f1d7e76-2fed-4806-a6af-869984f025cb",{"type":"95"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-target-with-upstream-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a Target associated with a an Upstream in a workspace",["18"],"3cb9d04388815","patch","/{workspace}/upstreams/{upstream_id_or_name}/targets/{target_id_or_target}",["19"],{},"update-target-with-upstream-workspace","Update a Target associated with a an Upstream using ID or target in a workspace.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"Targets",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55","56","57"],["58"],{"id":"59","url":"60","name":"61","description":"62","variables":"63"},"3695ceb40c20e","5edb83f1198ec","200",[],["64"],"Successfully updated Target","b6fb85cddbd10","400",[],["65"],"Invalid Target","b6eb85cddbb67","401",[],["66"],"Unauthorized","b6bb85cddb44c","404",[],[],"Resource does not exist","cdf90d820db13",["67"],"The request body for creating a new target entity.",{"id":"68","name":"69","style":"70","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","name":"76","style":"70","examples":"77","description":"78","required":true,"schema":"79","explicitProperties":"80"},{"id":"81","name":"82","style":"70","examples":"83","description":"84","required":true,"schema":"85","explicitProperties":"86"},{"id":"87","key":"88","extensions":"89","description":"90","type":"91","name":"92","in":"93"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"94","path":"95","port":"96","protocol":"97"},{"id":"98","mediaType":"99","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"99","examples":"104","encodings":"105","schema":"106"},{"id":"107","mediaType":"99","examples":"108","encodings":"109","schema":"110"},{"id":"111","mediaType":"99","examples":"112","encodings":"113","schema":"114"},"64f562ecab136","workspace","simple",[],"Name or ID of workspace",{"type":"115","examples":"116","$schema":"117","x-stoplight":"118"},["119","120","121","122","123","124"],"8dc93be6d9c72","upstream_id_or_name",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"115","examples":"125","$schema":"117","x-stoplight":"126"},["119","120","121","122","123","124"],"63fc56097aef1","target_id_or_target",[],"The host/port combination element of the target to set as unhealthy, or the `id` of an existing target entry.",{"type":"115","examples":"127","$schema":"117","x-stoplight":"128"},["119","120","121","122","123","124"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"129","description":"130"},{"default":"131","description":"132"},{"default":"133","description":"134"},{"default":"135","description":"136","enum":"137"},"b54e41f3a904b","application/json",["138"],[],{"description":"139","properties":"140","type":"141","title":"142","examples":"143"},"a6f0238d325d4",[],[],{"type":"141","$schema":"117","x-stoplight":"144"},"c011a78484f02",["145","146","147"],[],{"type":"141","properties":"148","required":"149","title":"150","$schema":"117","x-stoplight":"151"},"173ddc25870b2",["152"],[],{"type":"141","x-examples":"153","properties":"154","$schema":"117","x-stoplight":"155"},"string",["156"],"http://json-schema.org/draft-07/schema#",{"id":"157"},"name","in","required","schema","description","title",["158"],{"id":"159"},["160"],{"id":"161"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["135","162"],{"id":"163","value":"164","key":"165"},"A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly. To disable a target, post a new one with `weight=0`; alternatively, use the `DELETE` convenience method to accomplish the same. The current target object definition is the one with the latest `created_at`.",{"created_at":"166","id":"167","tags":"168","target":"169","updated_at":"170","upstream":"171","weight":"172"},"object","Target",["164"],{"id":"173"},{"id":"174","key":"175","value":"176","summary":"177"},{"id":"178","key":"179","value":"180","summary":"181"},{"id":"182","key":"183","value":"184","summary":"185"},{"status":"186","message":"187"},["188","189"],"UnauthorizedError",{"id":"190"},{"id":"191","key":"192","value":"193"},{"Example 1":"194"},{"upstream":"195","weight":"196","tags":"197"},{"id":"198"},"team-a","604916a37a0b7","7fca84d6-7d37-4a74-a7b0-93e576089a41","45de0f07a5af8","example.com:8000","7fbe63073cb4f","https","6601728e45871",{"id":"199","target":"200","upstream":"201","weight":100},"default",{"description":"202","type":"203"},{"type":"115"},{"description":"204","items":"205","type":"206"},{"description":"207","type":"115"},{"description":"208","type":"203"},{"additionalProperties":false,"properties":"209","type":"141"},{"default":100,"description":"210","type":"211"},"1c9bf9e42c5e9","507970b6019a3","DuplicateApiKey",{"message":"177","status":401},"Duplicate API key found","f9b4453f2c007","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","d4c3830a54afb","NoAPIKey",{"message":"212","status":401},"No API key found",{"type":"211"},{"type":"115"},"status","message","470b68e5f0549","1afe39334f92b","Example",{"upstream":"213","weight":100,"tags":"214"},{"upstream":"215","target":"160","weight":100,"tags":"216"},{"type":"141","description":"217","properties":"218"},{"default":100,"description":"219","type":"211","minimum":0,"maximum":65535},{"type":"206","description":"220","items":"221"},"536eb446aedaf","089292a7-ba3d-4d88-acf0-97b4b2e2621a","203.0.113.42",{"id":"222"},"Unix epoch when the resource was created.","number","An optional set of strings associated with the Target for grouping and filtering.",{"type":"115"},"array","The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the `port` value will be overridden by the value from the DNS record.","Unix epoch when the resource was last updated.",{"id":"223"},"The weight this target gets within the upstream loadbalancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","integer","No API key found in request",{"id":"224"},["115"],{"id":"225"},["226","227"],"The unique identifier or the name of the upstream for which to update the target.\n",{"id":"228"},"The weight this target gets within the upstream load balancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","An optional set of strings associated with the target for grouping and filtering.",{"type":"115"},"5f1d7e76-2fed-4806-a6af-869984f025cb",{"type":"115"},"173a6cee-90d1-40a7-89cf-0329eca780a6","bdab0e47-4e37-4f0b-8fd0-87d95cc4addc","user-level","low-priority",{"type":"115","description":"229","examples":"230"},"The unique identifier or the name of the upstream for which to update the target.",["224"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-target-with-upstream-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a Target associated with an Upstream in a workspace",["18"],"3240db58539f7","put","/{workspace}/upstreams/{upstream_id_or_name}/targets/{target_id_or_target}",["19"],{},"upsert-target-with-upstream-workspace","Create or Update a Target associated with an Upstream using ID or target in a workspace.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Targets",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50","51"],["52"],{"id":"53","url":"54","name":"55","description":"56","variables":"57"},"3695ceb40c20e","84fadc7194986","200",[],["58"],"Successfully upserted Target","1a5add0303658","400",[],["59"],"Invalid Target","1a4add030318b","401",[],["60"],"Unauthorized","b3b7b7f244781",["61"],"The request body for creating a new target entity.",{"id":"62","name":"63","style":"64","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"64","examples":"71","description":"72","required":true,"schema":"73","explicitProperties":"74"},{"id":"75","name":"76","style":"64","examples":"77","description":"78","required":true,"schema":"79","explicitProperties":"80"},{"id":"81","key":"82","extensions":"83","description":"84","type":"85","name":"86","in":"87"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"88","path":"89","port":"90","protocol":"91"},{"id":"92","mediaType":"93","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"93","examples":"98","encodings":"99","schema":"100"},{"id":"101","mediaType":"93","examples":"102","encodings":"103","schema":"104"},{"id":"105","mediaType":"93","examples":"106","encodings":"107","schema":"108"},"ca9506336bcb5","workspace","simple",[],"Name or ID of workspace",{"type":"109","examples":"110","$schema":"111","x-stoplight":"112"},["113","114","115","116","117","118"],"dc228857ce123","upstream_id_or_name",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"109","examples":"119","$schema":"111","x-stoplight":"120"},["113","114","115","116","117","118"],"b84b41fa0d77e","target_id_or_target",[],"The host/port combination element of the target to set as unhealthy, or the `id` of an existing target entry.",{"type":"109","examples":"121","$schema":"111","x-stoplight":"122"},["113","114","115","116","117","118"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"123","description":"124"},{"default":"125","description":"126"},{"default":"127","description":"128"},{"default":"129","description":"130","enum":"131"},"d2ab389ee0d1c","application/json",["132"],[],{"description":"133","properties":"134","type":"135","title":"136","examples":"137"},"ee4b7bd2a69b8",[],[],{"type":"135","$schema":"111","x-stoplight":"138"},"3e01d33b8b520",["139","140","141"],[],{"type":"135","properties":"142","required":"143","title":"144","$schema":"111","x-stoplight":"145"},"1aa1a832be7f1",["146"],[],{"type":"135","x-examples":"147","properties":"148","$schema":"111","x-stoplight":"149"},"string",["150"],"http://json-schema.org/draft-07/schema#",{"id":"151"},"name","in","required","schema","description","title",["152"],{"id":"153"},["154"],{"id":"155"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["129","156"],{"id":"157","value":"158","key":"159"},"A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly. To disable a target, post a new one with `weight=0`; alternatively, use the `DELETE` convenience method to accomplish the same. The current target object definition is the one with the latest `created_at`.",{"created_at":"160","id":"161","tags":"162","target":"163","updated_at":"164","upstream":"165","weight":"166"},"object","Target",["158"],{"id":"167"},{"id":"168","key":"169","value":"170","summary":"171"},{"id":"172","key":"173","value":"174","summary":"175"},{"id":"176","key":"177","value":"178","summary":"179"},{"status":"180","message":"181"},["182","183"],"UnauthorizedError",{"id":"184"},{"id":"185","key":"186","value":"187"},{"Example 1":"188"},{"upstream":"189","weight":"190","tags":"191"},{"id":"192"},"team-a","281dd50dba942","7fca84d6-7d37-4a74-a7b0-93e576089a41","187d2f6363bf4","example.com:8000","4f3d5822d5cd1","https","6f82332a2ad2a",{"id":"193","target":"194","upstream":"195","weight":100},"default",{"description":"196","type":"197"},{"type":"109"},{"description":"198","items":"199","type":"200"},{"description":"201","type":"109"},{"description":"202","type":"197"},{"additionalProperties":false,"properties":"203","type":"135"},{"default":100,"description":"204","type":"205"},"6fe45011bf851","084fe8140623a","DuplicateApiKey",{"message":"171","status":401},"Duplicate API key found","05e47f42172b1","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","447c72bac3b2e","NoAPIKey",{"message":"206","status":401},"No API key found",{"type":"205"},{"type":"109"},"status","message","470b68e5f0549","4fbbdbc0e4dca","Example",{"upstream":"207","weight":100,"tags":"208"},{"upstream":"209","target":"154","weight":100,"tags":"210"},{"type":"135","description":"211","properties":"212"},{"default":100,"description":"213","type":"205","minimum":0,"maximum":65535},{"type":"200","description":"214","items":"215"},"536eb446aedaf","089292a7-ba3d-4d88-acf0-97b4b2e2621a","203.0.113.42",{"id":"216"},"Unix epoch when the resource was created.","number","An optional set of strings associated with the Target for grouping and filtering.",{"type":"109"},"array","The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the `port` value will be overridden by the value from the DNS record.","Unix epoch when the resource was last updated.",{"id":"217"},"The weight this target gets within the upstream loadbalancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","integer","No API key found in request",{"id":"218"},["109"],{"id":"219"},["220","221"],"The unique identifier or the name of the upstream for which to update the target.\n",{"id":"222"},"The weight this target gets within the upstream load balancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","An optional set of strings associated with the target for grouping and filtering.",{"type":"109"},"5f1d7e76-2fed-4806-a6af-869984f025cb",{"type":"109"},"173a6cee-90d1-40a7-89cf-0329eca780a6","bdab0e47-4e37-4f0b-8fd0-87d95cc4addc","user-level","low-priority",{"type":"109","description":"223","examples":"224"},"The unique identifier or the name of the upstream for which to update the target.",["218"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-ca_certificate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all CA Certificates",["18"],"71af8ab3d7e67","get","/ca_certificates",["19"],{},"list-ca_certificate","Retrieve a list of all available Certificate Authority (CA) certificates, including the certificate ID, creation date, and other details. You can use query parameters to filter the results by size or tags, for example `/ca-certificates?size=50&tags=enterprise`.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"CA Certificates",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40","41"],[],[],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"4039566baa973","14505419f8f3f","200",[],["48"],"A successful response listing CA Certificates","d9a054c281f54","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","key":"70","extensions":"71","description":"72","type":"73","name":"74","in":"75"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"76","path":"77","port":"78","protocol":"79"},{"id":"80","mediaType":"81","examples":"82","encodings":"83","schema":"84"},{"id":"85","mediaType":"81","examples":"86","encodings":"87","schema":"88"},"41f80124c56c9","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96"],"954506e8d7800","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"97","$schema":"90","x-stoplight":"98"},["92","93","94","95","96"],"13144ad1157d6","tags",["99"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"97","examples":"100","x-stoplight":"101","$schema":"90"},["92","102","93","94","95","96"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"103","description":"104"},{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110","enum":"111"},"4cc485c8d1ffb","application/json",["112"],[],{"description":"113","type":"114","properties":"115","title":"116","examples":"117","$schema":"90","x-stoplight":"118"},"cfa2a056b0bc2",["119","120","121"],[],{"type":"114","properties":"122","required":"123","title":"124","$schema":"90","x-stoplight":"125"},"integer","http://json-schema.org/draft-07/schema#",{"id":"126"},"description","in","name","schema","title","string",{"id":"127"},{"id":"128","value":"129","key":"130"},["129"],{"explicitProperties":"131","id":"132"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["109","133"],{"id":"134","value":"135","key":"130"},"A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate.","object",{"cert":"136","cert_digest":"137","created_at":"138","id":"139","tags":"140"},"CA-Certificate",["135"],{"id":"141"},{"id":"142","key":"143","value":"144","summary":"145"},{"id":"146","key":"147","value":"148","summary":"149"},{"id":"150","key":"151","value":"152","summary":"153"},{"status":"154","message":"155"},["156","157"],"UnauthorizedError",{"id":"158"},"34c15b21245b9","f42292a83c137","a1db020e1f49f","tag1,tag2","default",["159","160","161"],"787619a8ac303","https","de9f6cd21f1e6",{"cert":"162","id":"163"},{"description":"164","type":"97"},{"description":"165","type":"97"},{"description":"166","type":"89"},{"type":"97"},{"description":"167","type":"168","items":"169"},"30b8233d5fdfe","7a252bce9de08","DuplicateApiKey",{"message":"145","status":401},"Duplicate API key found","daab0e52e4a19","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","4fbbb880c10f6","NoAPIKey",{"message":"170","status":401},"No API key found",{"type":"89"},{"type":"97"},"status","message","470b68e5f0549","type","nullable","examples","-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f260","PEM-encoded public certificate of the CA.","SHA256 hex digest of the public certificate. This field is read-only and it cannot be set by the caller, the value is automatically computed.","Unix epoch when the resource was created.","An optional set of strings associated with the Certificate for grouping and filtering.","array",{"type":"97","examples":"171"},"No API key found in request",["172"],"tag"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-ca_certificate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create a new CA Certificate",["18"],"22c2d043a88ca","post","/ca_certificates",["19"],{},"create-ca_certificate","Create a new Certificate Authority (CA) certificate. The request body must include the `cert` property, the certificate data in PEM format; it can also include `cert_digest`, a digest of the certificate in hex format for verifying the certificates integrity, and `tags`, an optional list of tags to categorize the certificate.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"CA Certificates",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],[],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"4039566baa973","2a054d37fd39c","200",[],["55"],"Successfully created CA Certificate","82254f14bfd10","400",[],["56"],"400 Bad Request","82354f14bff67","401",[],["57"],"Unauthorized","49674a5d79c84",["58"],"This request body represents a new Certificate Authority (CA) certificate and includes the properties required to create a new certificate.",{"id":"59","key":"60","extensions":"61","description":"62","type":"63","name":"64","in":"65"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"66","path":"67","port":"68","protocol":"69"},{"id":"70","mediaType":"71","examples":"72","encodings":"73","schema":"74"},{"id":"75","mediaType":"71","examples":"76","encodings":"77","schema":"78"},{"id":"79","mediaType":"71","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"71","examples":"84","encodings":"85","schema":"86"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"87","description":"88"},{"default":"89","description":"90"},{"default":"91","description":"92"},{"default":"93","description":"94","enum":"95"},"e7e7484b6c78b","application/json",["96"],[],{"description":"97","type":"98","properties":"99","title":"100","examples":"101","$schema":"102","x-stoplight":"103"},"1f9c198bc7871",["104"],[],{"type":"98","x-examples":"105","properties":"106","$schema":"102","x-stoplight":"107"},"76600acfba309",["108","109","110"],[],{"type":"98","properties":"111","required":"112","title":"113","$schema":"102","x-stoplight":"114"},"71d970063bc62",[],[],{"type":"98","x-examples":"115","properties":"116","required":"117","$schema":"102","x-stoplight":"118"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["93","119"],{"id":"120","value":"121","key":"122"},"A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate.","object",{"cert":"123","cert_digest":"124","created_at":"125","id":"126","tags":"127"},"CA-Certificate",["121"],"http://json-schema.org/draft-07/schema#",{"id":"128"},{"id":"129","key":"130","value":"131"},{"Example 1":"132"},{"fields":"133","message":"134","name":"135","code":"136"},{"id":"137"},{"id":"138","key":"139","value":"140","summary":"141"},{"id":"142","key":"143","value":"144","summary":"145"},{"id":"146","key":"147","value":"148","summary":"149"},{"status":"150","message":"151"},["152","153"],"UnauthorizedError",{"id":"154"},{"Example 1":"155"},{"cert":"156","cert_digest":"157","tags":"158"},["159"],{"id":"160"},"https","7ca83fe187814",{"cert":"161","id":"162"},"default",{"description":"163","type":"164"},{"description":"165","type":"164"},{"description":"166","type":"167"},{"type":"164"},{"description":"168","type":"169","items":"170"},"30b8233d5fdfe","ae17f64744067","invalid certificate",{"fields":"171","message":"172","name":"173","code":2},{"fields":"174","message":"175","name":"173","code":2},{"type":"98","properties":"176"},{"type":"164","description":"177","examples":"178"},{"type":"164","description":"179","examples":"180"},{"type":"167","description":"181","examples":"182"},"a60827f08fb6c","14ac5e4285342","DuplicateApiKey",{"message":"141","status":401},"Duplicate API key found","f3fcedfe30322","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","e3ccaeb4ed7a2","NoAPIKey",{"message":"183","status":401},"No API key found",{"type":"167"},{"type":"164"},"status","message","470b68e5f0549",{"cert":"184","cert_digest":"185","tags":"186"},{"type":"164","description":"187","examples":"188"},{"type":"164","description":"189","examples":"190"},{"type":"169","description":"168","items":"191"},"cert","8bc821357346a","-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f260","PEM-encoded public certificate of the CA.","string","SHA256 hex digest of the public certificate. This field is read-only and it cannot be set by the caller, the value is automatically computed.","Unix epoch when the resource was created.","integer","An optional set of strings associated with the Certificate for grouping and filtering.","array",{"type":"164","examples":"192"},{"cert":"193"},"schema violation (cert: invalid certificate: x509.new:","schema violation",{"cert":"194"},"schema violation (cert: invalid certificate: x509.new: asn1/a_d2i_fp.c:197:error:0D06B08E:asn1 encoding routines:asn1_d2i_read_bio:not enough data)",{"cert":"195"},"More information about the error",["172"],"The name of the error.",["173"],"An error code.",[2],"No API key found in request","-----BEGIN CERTIFICATE-----...","c641e28d77e93544f2fa87b2cf3f3d51...",["196","197"],"PEM-encoded public certificate of the CA.\n",["198"],"SHA256 hex digest of the public certificate.\n",["185"],{"type":"164"},["199"],"invalid certificate: x509.new:","invalid certificate: x509.new: asn1/a_d2i_fp.c:197:error:0D06B08E:asn1 encoding routines:asn1_d2i_read_bio:not enough data",{"type":"164","description":"200","examples":"201"},"user-level","low-priority","\"-----BEGIN CERTIFICATE-----...\"","tag","Error information about the certificate.",["193"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-ca_certificate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a CA Certificate",["18"],"940b97389bbf6","delete","/ca_certificates/{ca_certificate_id}",["19"],{},"delete-ca_certificate","Delete the specified Certificate Authority (CA) certificate using the provided ca_certificate_id.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"CA Certificates",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"4039566baa973","5367b12504032","204",[],[],"Successfully deleted CA Certificate or the resource didn't exist","7b57b2eaada1c","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},{"id":"65","mediaType":"66","examples":"67","encodings":"68","schema":"69"},"5c29a07263676","ca_certificate_id","simple",[],"ID of the related certificate",{"type":"70","examples":"71","$schema":"72","x-stoplight":"73"},["74","75","76","77","78","79"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"80","description":"81"},{"default":"82","description":"83"},{"default":"84","description":"85"},{"default":"86","description":"87","enum":"88"},"17c2ed48d9223","application/json",["89","90","91"],[],{"type":"92","properties":"93","required":"94","title":"95","$schema":"72","x-stoplight":"96"},"string",["97"],"http://json-schema.org/draft-07/schema#",{"id":"98"},"name","description","in","required","schema","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["86","99"],{"id":"100","key":"101","value":"102","summary":"103"},{"id":"104","key":"105","value":"106","summary":"107"},{"id":"108","key":"109","value":"110","summary":"111"},"object",{"status":"112","message":"113"},["114","115"],"UnauthorizedError",{"id":"116"},"7fca84d6-7d37-4a74-a7b0-93e576089a41\"","6185ece998214","https","37dbf5cc3a834","DuplicateApiKey",{"message":"103","status":401},"Duplicate API key found","6b6b91e9f29e1","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","079faf3b8f17f","NoAPIKey",{"message":"117","status":401},"No API key found",{"type":"118"},{"type":"70"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-ca_certificate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a CA Certificate",["18"],"efc60395d5e88","get","/ca_certificates/{ca_certificate_id}",["19"],{},"get-ca_certificate","Retrieve details about the specified Certificate Authority (CA) certificate using the provided path parameter `ca_certificate_id`.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"CA Certificates",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45"],["46"],{"id":"47","url":"48","name":"49","description":"50","variables":"51"},"4039566baa973","0446779de297b","200",[],["52"],"Successfully fetched CA Certificate","a43675c112c11","401",[],["53"],"Unauthorized","a46675c11313e","404",[],[],"Resource does not exist",{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},{"id":"77","mediaType":"73","examples":"78","encodings":"79","schema":"80"},"0a95ad5602461","ca_certificate_id","simple",[],"ID of the related certificate",{"type":"81","examples":"82","$schema":"83","x-stoplight":"84"},["85","86","87","88","89","90"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"9b43d5f2ed383","application/json",["100"],[],{"description":"101","type":"102","properties":"103","title":"104","examples":"105","$schema":"83","x-stoplight":"106"},"8a8ac29d43416",["107","108","109"],[],{"type":"102","properties":"110","required":"111","title":"112","$schema":"83","x-stoplight":"113"},"string",["114"],"http://json-schema.org/draft-07/schema#",{"id":"115"},"name","description","in","required","schema","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","116"],{"id":"117","value":"118","key":"119"},"A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate.","object",{"cert":"120","cert_digest":"121","created_at":"122","id":"123","tags":"124"},"CA-Certificate",["118"],{"id":"125"},{"id":"126","key":"127","value":"128","summary":"129"},{"id":"130","key":"131","value":"132","summary":"133"},{"id":"134","key":"135","value":"136","summary":"137"},{"status":"138","message":"139"},["140","141"],"UnauthorizedError",{"id":"142"},"7fca84d6-7d37-4a74-a7b0-93e576089a41\"","a7388e9d7ebaa","https","21d7179f26b10",{"cert":"143","id":"144"},"default",{"description":"145","type":"81"},{"description":"146","type":"81"},{"description":"147","type":"148"},{"type":"81"},{"description":"149","type":"150","items":"151"},"30b8233d5fdfe","6124e8a0a54a4","DuplicateApiKey",{"message":"129","status":401},"Duplicate API key found","c915c7ab231fc","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","b164a54c3ac16","NoAPIKey",{"message":"152","status":401},"No API key found",{"type":"148"},{"type":"81"},"status","message","470b68e5f0549","-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f260","PEM-encoded public certificate of the CA.","SHA256 hex digest of the public certificate. This field is read-only and it cannot be set by the caller, the value is automatically computed.","Unix epoch when the resource was created.","integer","An optional set of strings associated with the Certificate for grouping and filtering.","array",{"type":"81","examples":"153"},"No API key found in request",["154"],"tag"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-ca_certificate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update a CA Certificate",["17"],"7388a2bed6097","patch","/ca_certificates/{ca_certificate_id}",["18"],{},"update-ca_certificate","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"CA Certificates",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54"],["55"],{"id":"56","url":"57","name":"58","description":"59","variables":"60"},"4039566baa973","8250c845f9d8f","200",[],["61"],"Successfully updated CA Certificate","2a30c66937a07","400",[],["62"],"Invalid CA Certificate","2a20c669379f4","401",[],["63"],"Unauthorized","2a70c6693714b","404",[],[],"Resource does not exist","0f4e35ff4935a",["64"],"This request body represents a new Certificate Authority (CA) certificate and includes the properties required to create a new certificate.",{"id":"65","name":"66","style":"67","examples":"68","description":"69","required":true,"schema":"70","explicitProperties":"71"},{"id":"72","key":"73","extensions":"74","description":"75","type":"76","name":"77","in":"78"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"79","path":"80","port":"81","protocol":"82"},{"id":"83","mediaType":"84","examples":"85","encodings":"86","schema":"87"},{"id":"88","mediaType":"84","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"84","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"84","examples":"97","encodings":"98","schema":"99"},"93a3c22f0f3d5","ca_certificate_id","simple",[],"ID of the related certificate",{"type":"100","examples":"101","$schema":"102","x-stoplight":"103"},["104","105","106","107","108","109"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"110","description":"111"},{"default":"112","description":"113"},{"default":"114","description":"115"},{"default":"116","description":"117","enum":"118"},"a7d49a3dba56a","application/json",["119"],[],{"description":"120","type":"121","properties":"122","title":"123","examples":"124","$schema":"102","x-stoplight":"125"},"4437e4f4bb338",[],[],{"type":"121","$schema":"102","x-stoplight":"126"},"7c74cb695eaa3",["127","128","129"],[],{"type":"121","properties":"130","required":"131","title":"132","$schema":"102","x-stoplight":"133"},"cfab1e5b8808f",[],[],{"type":"121","x-examples":"134","properties":"135","required":"136","$schema":"102","x-stoplight":"137"},"string",["138"],"http://json-schema.org/draft-07/schema#",{"id":"139"},"name","description","in","required","schema","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["116","140"],{"id":"141","value":"142","key":"143"},"A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate.","object",{"cert":"144","cert_digest":"145","created_at":"146","id":"147","tags":"148"},"CA-Certificate",["142"],{"id":"149"},{"id":"150"},{"id":"151","key":"152","value":"153","summary":"154"},{"id":"155","key":"156","value":"157","summary":"158"},{"id":"159","key":"160","value":"161","summary":"162"},{"status":"163","message":"164"},["165","166"],"UnauthorizedError",{"id":"167"},{"Example 1":"168"},{"cert":"169","cert_digest":"170","tags":"171"},["172"],{"id":"173"},"7fca84d6-7d37-4a74-a7b0-93e576089a41\"","541048de2ffe9","https","70a6fe4b49bf1",{"cert":"174","id":"175"},"default",{"description":"176","type":"100"},{"description":"177","type":"100"},{"description":"178","type":"179"},{"type":"100"},{"description":"180","type":"181","items":"182"},"30b8233d5fdfe","b6ae0c6bcc15e","216fbea32f504","DuplicateApiKey",{"message":"154","status":401},"Duplicate API key found","4e81848b606f8","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","cf8b1131550db","NoAPIKey",{"message":"183","status":401},"No API key found",{"type":"179"},{"type":"100"},"status","message","470b68e5f0549",{"cert":"184","cert_digest":"185","tags":"186"},{"type":"100","description":"187","examples":"188"},{"type":"100","description":"189","examples":"190"},{"type":"181","description":"180","items":"191"},"cert","8bc821357346a","-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f260","PEM-encoded public certificate of the CA.","SHA256 hex digest of the public certificate. This field is read-only and it cannot be set by the caller, the value is automatically computed.","Unix epoch when the resource was created.","integer","An optional set of strings associated with the Certificate for grouping and filtering.","array",{"type":"100","examples":"192"},"No API key found in request","-----BEGIN CERTIFICATE-----...","c641e28d77e93544f2fa87b2cf3f3d51...",["193","194"],"PEM-encoded public certificate of the CA.\n",["195"],"SHA256 hex digest of the public certificate.\n",["185"],{"type":"100"},["196"],"user-level","low-priority","\"-----BEGIN CERTIFICATE-----...\"","tag"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-ca_certificate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a CA Certificate",["18"],"30b1ecc855467","put","/ca_certificates/{ca_certificate_id}",["19"],{},"upsert-ca_certificate","Update the specified Certificate Authority (CA) certificate using the provided `ca_certificate_id`. Use this endpoint to modify an existing CA certificate in the system. The request body should include the fields of the CA certificate that need to be updated.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"CA Certificates",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55"],["56"],{"id":"57","url":"58","name":"59","description":"60","variables":"61"},"4039566baa973","9020ea33abff9","200",[],["62"],"Successfully upserted CA Certificate","3800e856e81f5","400",[],["63"],"Invalid CA Certificate","37f0e856e8006","401",[],["64"],"Unauthorized","3840e856e98b9","404",[],[],"Not Found","9688b86677756",["65"],"This request body represents a new Certificate Authority (CA) certificate and includes the properties required to create a new certificate.",{"id":"66","name":"67","style":"68","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","key":"74","extensions":"75","description":"76","type":"77","name":"78","in":"79"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"80","path":"81","port":"82","protocol":"83"},{"id":"84","mediaType":"85","examples":"86","encodings":"87","schema":"88"},{"id":"89","mediaType":"85","examples":"90","encodings":"91","schema":"92"},{"id":"93","mediaType":"85","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"85","examples":"98","encodings":"99","schema":"100"},"3349c0fc21670","ca_certificate_id","simple",[],"ID of the related certificate",{"type":"101","examples":"102","$schema":"103","x-stoplight":"104"},["105","106","107","108","109","110"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"111","description":"112"},{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118","enum":"119"},"cd7f8b9b090a7","application/json",["120"],[],{"description":"121","type":"122","properties":"123","title":"124","examples":"125","$schema":"103","x-stoplight":"126"},"aab35e0c62d8e",[],[],{"type":"122","$schema":"103","x-stoplight":"127"},"2b45b5cb3dc89",["128","129","130"],[],{"type":"122","properties":"131","required":"132","title":"133","$schema":"103","x-stoplight":"134"},"9a24882c20004",[],[],{"type":"122","x-examples":"135","properties":"136","required":"137","$schema":"103","x-stoplight":"138"},"string",["139"],"http://json-schema.org/draft-07/schema#",{"id":"140"},"name","description","in","required","schema","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["117","141"],{"id":"142","value":"143","key":"144"},"A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate.","object",{"cert":"145","cert_digest":"146","created_at":"147","id":"148","tags":"149"},"CA-Certificate",["143"],{"id":"150"},{"id":"151"},{"id":"152","key":"153","value":"154","summary":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"id":"160","key":"161","value":"162","summary":"163"},{"status":"164","message":"165"},["166","167"],"UnauthorizedError",{"id":"168"},{"Example 1":"169"},{"cert":"170","cert_digest":"171","tags":"172"},["173"],{"id":"174"},"7fca84d6-7d37-4a74-a7b0-93e576089a41\"","6d40f26c7e22a","https","c1012e498f38c",{"cert":"175","id":"176"},"default",{"description":"177","type":"101"},{"description":"178","type":"101"},{"description":"179","type":"180"},{"type":"101"},{"description":"181","type":"182","items":"183"},"30b8233d5fdfe","08029a330d9b0","bbdab67e2c8ec","DuplicateApiKey",{"message":"155","status":401},"Duplicate API key found","cfcf031119c0a","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","be85dbac7bd3a","NoAPIKey",{"message":"184","status":401},"No API key found",{"type":"180"},{"type":"101"},"status","message","470b68e5f0549",{"cert":"185","cert_digest":"186","tags":"187"},{"type":"101","description":"188","examples":"189"},{"type":"101","description":"190","examples":"191"},{"type":"182","description":"181","items":"192"},"cert","8bc821357346a","-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f260","PEM-encoded public certificate of the CA.","SHA256 hex digest of the public certificate. This field is read-only and it cannot be set by the caller, the value is automatically computed.","Unix epoch when the resource was created.","integer","An optional set of strings associated with the Certificate for grouping and filtering.","array",{"type":"101","examples":"193"},"No API key found in request","-----BEGIN CERTIFICATE-----...","c641e28d77e93544f2fa87b2cf3f3d51...",["194","195"],"PEM-encoded public certificate of the CA.\n",["196"],"SHA256 hex digest of the public certificate.\n",["186"],{"type":"101"},["197"],"user-level","low-priority","\"-----BEGIN CERTIFICATE-----...\"","tag"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-upstream",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all Upstreams",["18"],"e1f52b59cd3b2","get","/upstreams",["19"],{},"list-upstream","List all registered upstreams. You can filter the results by pagination size, offset, or tags like /upstreams?size=10&offset=0.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Upstreams",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40","41"],[],[],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"2a5a4b1190f40","89508846b35d6","200",[],["48"],"A successful response listing Upstreams","b1808a0c5ccf4","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","key":"70","extensions":"71","description":"72","type":"73","name":"74","in":"75"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"76","path":"77","port":"78","protocol":"79"},{"id":"80","mediaType":"81","examples":"82","encodings":"83","schema":"84"},{"id":"85","mediaType":"81","examples":"86","encodings":"87","schema":"88"},"3e92c03a683ad","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96"],"53fee1b1776db","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"97","$schema":"90","x-stoplight":"98"},["92","93","94","95","96"],"c6362ce4c0c53","tags",["99"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"97","examples":"100","x-stoplight":"101","$schema":"90"},["92","102","93","94","95","96"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"103","description":"104"},{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110","enum":"111"},"75427dcd72180","application/json",[],[],{"properties":"112","$schema":"90","x-stoplight":"113"},"c036625bae11a",["114","115","116"],[],{"type":"117","properties":"118","required":"119","title":"120","$schema":"90","x-stoplight":"121"},"integer","http://json-schema.org/draft-07/schema#",{"id":"122"},"description","in","name","schema","title","string",{"id":"123"},{"id":"124","value":"125","key":"126"},["125"],{"explicitProperties":"127","id":"128"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["109","129"],{"data":"130","offset":"131"},{"id":"132"},{"id":"133","key":"134","value":"135","summary":"136"},{"id":"137","key":"138","value":"139","summary":"140"},{"id":"141","key":"142","value":"143","summary":"144"},"object",{"status":"145","message":"146"},["147","148"],"UnauthorizedError",{"id":"149"},"81f1c113dc194","13139d9d7e73f","1a807302febae","tag1,tag2","default",["150","151","152"],"7ee27c545a482","https",{"items":"153","type":"154"},{"description":"155","type":"97","title":"156"},"31952ae9aa8d5","a58b1a66347ed","DuplicateApiKey",{"message":"136","status":401},"Duplicate API key found","72ef36c846dfa","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","459352ae6e4f9","NoAPIKey",{"message":"157","status":401},"No API key found",{"type":"89"},{"type":"97"},"status","message","470b68e5f0549","type","nullable","examples",{"description":"158","properties":"159","type":"117","title":"160","examples":"161"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","No API key found in request","The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets). So for example an upstream named `service.v1.xyz` for a Service object whose `host` is `service.v1.xyz`. Requests for this Service would be proxied to the targets defined within the upstream. An upstream also includes a [health checker][healthchecks], which is able to enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.",{"algorithm":"162","client_certificate":"163","created_at":"164","hash_fallback":"165","hash_fallback_header":"166","hash_fallback_query_arg":"167","hash_fallback_uri_capture":"168","hash_on":"169","hash_on_cookie":"170","hash_on_cookie_path":"171","hash_on_header":"172","hash_on_query_arg":"173","hash_on_uri_capture":"174","healthchecks":"175","host_header":"176","id":"177","name":"178","slots":"179","tags":"180","updated_at":"181","use_srv_name":"182"},"Upstream",["183"],{"description":"184","type":"185","default":"186","enum":"187"},{"additionalProperties":false,"description":"188","properties":"189","type":"117"},{"description":"190","type":"89"},{"default":"191","description":"192","type":"97"},{"description":"193","type":"97"},{"description":"194","type":"97"},{"description":"195","type":"97"},{"default":"191","description":"196","type":"97"},{"description":"197","type":"97"},{"default":"105","description":"198","type":"97"},{"description":"199","type":"97"},{"description":"200","type":"97"},{"description":"201","type":"97"},{"properties":"202","type":"117"},{"description":"203","type":"97"},{"type":"97"},{"description":"204","type":"97"},{"default":10000,"description":"205","type":"89"},{"description":"206","items":"207","type":"154"},{"description":"208","type":"89"},{"default":false,"description":"209","type":"210"},{"algorithm":"186","hash_fallback":"191","hash_on":"191","hash_on_cookie_path":"105","healthchecks":"211","id":"212","name":"213","slots":10000},"Which load balancing algorithm to use.",["97","214"],"round-robin",["215","216","186","217",null],"If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"218"},"Unix epoch when the resource was created.","none","What to use as hashing input if the primary `hash_on` does not return a hash (eg. header is missing, or no Consumer identified). Not available if `hash_on` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_fallback` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_fallback` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_fallback` is set to `uri_capture`.","What to use as hashing input. Using `none` results in a weighted-round-robin scheme with no hashing.","The cookie name to take the value from as hash input. Only required when `hash_on` or `hash_fallback` is set to `cookie`. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.","The cookie path to set in the response headers. Only required when `hash_on` or `hash_fallback` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_on` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_on` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_on` is set to `uri_capture`.",{"active":"219","passive":"220","threshold":"221"},"The hostname to be used as `Host` header when proxying requests through Kong.","This is a hostname, which must be equal to the `host` of a Service.","The number of slots in the load balancer algorithm. If `algorithm` is set to `round-robin`, this setting determines the maximum number of slots. If `algorithm` is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range `10`-`65536`.","An optional set of strings associated with the Upstream for grouping and filtering.",{"type":"97"},"Unix epoch when the resource was last updated.","If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream `Host`.","boolean",{"active":"222","passive":"223","threshold":0},"6eed5e9c-5398-4026-9a4c-d48f18a2431e","api.example.internal","null","consistent-hashing","least-connections","latency",{"type":"97"},{"properties":"224","type":"117"},{"properties":"225","type":"117"},{"default":0,"type":"226"},{"concurrency":10,"healthy":"227","http_path":"105","https_verify_certificate":true,"timeout":1,"type":"109","unhealthy":"228"},{"healthy":"229","type":"109","unhealthy":"230"},{"concurrency":"231","headers":"232","healthy":"233","http_path":"234","https_sni":"235","https_verify_certificate":"236","timeout":"237","type":"238","unhealthy":"239"},{"healthy":"240","type":"241","unhealthy":"242"},"number",{"http_statuses":"243","interval":0,"successes":0},{"http_failures":0,"http_statuses":"244","interval":0,"tcp_failures":0,"timeouts":0},{"http_statuses":"245","successes":0},{"http_failures":0,"http_statuses":"246","tcp_failures":0,"timeouts":0},{"default":10,"type":"89"},{"type":"117"},{"properties":"247","type":"117"},{"default":"105","type":"97"},{"type":"97"},{"default":true,"type":"210"},{"default":1,"type":"226"},{"default":"109","type":"97"},{"properties":"248","type":"117"},{"properties":"249","type":"117"},{"default":"109","type":"97"},{"properties":"250","type":"117"},[200,302],[429,404,500,501,502,503,504,505],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],{"http_statuses":"251","interval":"252","successes":"253"},{"http_failures":"254","http_statuses":"255","interval":"256","tcp_failures":"257","timeouts":"258"},{"http_statuses":"259","successes":"260"},{"http_failures":"261","http_statuses":"262","tcp_failures":"263","timeouts":"264"},{"default":"265","items":"266","type":"154"},{"default":0,"type":"226"},{"default":0,"type":"89"},{"default":0,"type":"89"},{"default":"267","items":"268","type":"154"},{"default":0,"type":"226"},{"default":0,"type":"89"},{"default":0,"type":"89"},{"default":"269","items":"270","type":"154"},{"default":0,"type":"89"},{"default":0,"type":"89"},{"default":"271","items":"272","type":"154"},{"default":0,"type":"89"},{"default":0,"type":"89"},[200,302],{"type":"89"},[429,404,500,501,502,503,504,505],{"type":"89"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"89"},[429,500,503],{"type":"89"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-upstream",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new Upstream",["17"],"fea77a4af1b75","post","/upstreams",["18"],{},"create-upstream","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Upstreams",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],[],["48"],{"id":"49","url":"50","name":"51","description":"52","variables":"53"},"2a5a4b1190f40","eba942aad4fa9","200",[],["54"],"Successfully created Upstream","43c9448796222","400",[],["55"],"Invalid Upstream","43d94487963f5","401",[],["56"],"Unauthorized","1ca6ba9425ab5",["57"],"The request object for creating a new upstream.",{"id":"58","key":"59","extensions":"60","description":"61","type":"62","name":"63","in":"64"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"65","path":"66","port":"67","protocol":"68"},{"id":"69","mediaType":"70","examples":"71","encodings":"72","schema":"73"},{"id":"74","mediaType":"70","examples":"75","encodings":"76","schema":"77"},{"id":"78","mediaType":"70","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"70","examples":"83","encodings":"84","schema":"85"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"86","description":"87"},{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93","enum":"94"},"5974fb20f55df","application/json",["95"],[],{"description":"96","properties":"97","type":"98","title":"99","examples":"100"},"b1e4839ff1275",[],[],{"type":"98","$schema":"101","x-stoplight":"102"},"61d452b84e1a9",["103","104","105"],[],{"type":"98","properties":"106","required":"107","title":"108","$schema":"101","x-stoplight":"109"},"e12c1e355da7b",["110","111"],[],{"type":"98","x-examples":"112","properties":"113","required":"114","$schema":"101","x-stoplight":"115"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["92","116"],{"id":"117","value":"118","key":"119"},"The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets). So for example an upstream named `service.v1.xyz` for a Service object whose `host` is `service.v1.xyz`. Requests for this Service would be proxied to the targets defined within the upstream. An upstream also includes a [health checker][healthchecks], which is able to enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.",{"algorithm":"120","client_certificate":"121","created_at":"122","hash_fallback":"123","hash_fallback_header":"124","hash_fallback_query_arg":"125","hash_fallback_uri_capture":"126","hash_on":"127","hash_on_cookie":"128","hash_on_cookie_path":"129","hash_on_header":"130","hash_on_query_arg":"131","hash_on_uri_capture":"132","healthchecks":"133","host_header":"134","id":"135","name":"136","slots":"137","tags":"138","updated_at":"139","use_srv_name":"140"},"object","Upstream",["118"],"http://json-schema.org/draft-07/schema#",{"id":"141"},{"id":"142","key":"143","value":"144","summary":"145"},{"id":"146","key":"147","value":"148","summary":"149"},{"id":"150","key":"151","value":"152","summary":"153"},{"status":"154","message":"155"},["156","157"],"UnauthorizedError",{"id":"158"},{"id":"159","key":"99","value":"160"},{"id":"161","key":"162","value":"163"},{"Example 1":"164"},{"name":"165","algorithm":"166","hash_on":"167","hash_fallback":"168","hash_on_header":"169","hash_fallback_header":"170","hash_on_cookie":"171","hash_on_cookie_path":"172","hash_on_query_arg":"173","hash_fallback_query_arg":"174","hash_on_uri_capture":"175","hash_fallback_uri_capture":"176","slots":"177","healthchecks":"178","tags":"179","host_header":"180","client_certificate":"181","use_srv_name":"182"},["183"],{"id":"184"},"https","023e5681ca5df",{"algorithm":"185","hash_fallback":"186","hash_on":"186","hash_on_cookie_path":"88","healthchecks":"187","id":"188","name":"189","slots":10000},"default",{"description":"190","type":"191","default":"185","enum":"192"},{"additionalProperties":false,"description":"193","properties":"194","type":"98"},{"description":"195","type":"196"},{"default":"186","description":"197","type":"198"},{"description":"199","type":"198"},{"description":"200","type":"198"},{"description":"201","type":"198"},{"default":"186","description":"202","type":"198"},{"description":"203","type":"198"},{"default":"88","description":"204","type":"198"},{"description":"205","type":"198"},{"description":"206","type":"198"},{"description":"207","type":"198"},{"properties":"208","type":"98"},{"description":"209","type":"198"},{"type":"198"},{"description":"210","type":"198"},{"default":10000,"description":"211","type":"196"},{"description":"212","items":"213","type":"214"},{"description":"215","type":"196"},{"default":false,"description":"216","type":"217"},"e51757a61796f","86e3d5085f0d3","DuplicateApiKey",{"message":"145","status":401},"Duplicate API key found","eed4b412dd5ed","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","ed0b75c907377","NoAPIKey",{"message":"218","status":401},"No API key found",{"type":"196"},{"type":"198"},"status","message","470b68e5f0549","121ad562b7218",{"name":"219","algorithm":"185","hash_on":"186","hash_fallback":"186","hash_on_cookie_path":"88","slots":10000,"healthchecks":"220","tags":"221","host_header":"222","client_certificate":"223","use_srv_name":false},"efd272a5e7ecc","Example request",{"name":"219","tags":"224","algorithm":"185"},{"id":"225","created_at":1422386534,"name":"219","algorithm":"185","hash_on":"186","hash_fallback":"186","hash_on_cookie_path":"88","slots":10000,"healthchecks":"226","tags":"227","host_header":"222","client_certificate":"228","use_srv_name":false},{"type":"198","description":"229","examples":"230"},{"type":"198","description":"231","enum":"232","default":"185","examples":"233"},{"type":"198","description":"234","default":"186","enum":"235"},{"type":"198","description":"236","default":"186","enum":"237","examples":"238"},{"type":"198","description":"239","examples":"240"},{"type":"198","description":"241","default":"186","examples":"242"},{"type":"198","description":"203","examples":"243"},{"type":"198","description":"204","default":"88","examples":"244"},{"type":"198","description":"206","examples":"245"},{"type":"198","description":"200","examples":"246"},{"type":"198","description":"207","examples":"247"},{"type":"198","description":"201","examples":"248"},{"type":"196","description":"249","minimum":10,"maximum":65536,"default":10000,"examples":"250"},{"type":"98","properties":"251"},{"type":"214","description":"212","items":"252","examples":"253"},{"type":"198","description":"254"},{"type":"98","description":"193","properties":"255"},{"type":"217","description":"256","examples":"257"},"name","1d11995efa499","round-robin","none",{"active":"258","passive":"259","threshold":0},"6eed5e9c-5398-4026-9a4c-d48f18a2431e","api.example.internal","Which load balancing algorithm to use.",["198","260"],["261","262","185","263",null],"If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"264"},"Unix epoch when the resource was created.","integer","What to use as hashing input if the primary `hash_on` does not return a hash (eg. header is missing, or no Consumer identified). Not available if `hash_on` is set to `cookie`.","string","The header name to take the value from as hash input. Only required when `hash_fallback` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_fallback` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_fallback` is set to `uri_capture`.","What to use as hashing input. Using `none` results in a weighted-round-robin scheme with no hashing.","The cookie name to take the value from as hash input. Only required when `hash_on` or `hash_fallback` is set to `cookie`. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.","The cookie path to set in the response headers. Only required when `hash_on` or `hash_fallback` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_on` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_on` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_on` is set to `uri_capture`.",{"active":"265","passive":"266","threshold":"267"},"The hostname to be used as `Host` header when proxying requests through Kong.","This is a hostname, which must be equal to the `host` of a Service.","The number of slots in the load balancer algorithm. If `algorithm` is set to `round-robin`, this setting determines the maximum number of slots. If `algorithm` is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range `10`-`65536`.","An optional set of strings associated with the Upstream for grouping and filtering.",{"type":"198"},"array","Unix epoch when the resource was last updated.","If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream `Host`.","boolean","No API key found in request","my-upstream",{"passive":"268","active":"269","threshold":0},["270","271"],"example.com",{"id":"272"},["270","271"],"58c8ccbb-eafb-4566-991f-2ed4f678fa70",{"passive":"273","active":"274","threshold":0},["270","271"],{"id":"272"},"This is a hostname, which must be equal to the `host` of a service.",["219"],"Which load balancing algorithm to use.\n",["261","262","185","263"],["185"],"What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing",["186","275","276","277","278","279","280"],"What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie.",["186","275","276","277","278","279","280"],["186"],"The header name to take the value from as hash input. Only required when `hash_on` is set to header.",["186"],"The header name to take the value from as hash input. Only required when hash_fallback is set to header.",["186"],["186"],["88"],["281"],["281"],["281"],["281"],"The number of slots in the load balancer algorithm. If the algorithm is set to `round-robin`, this setting determines the maximum number of slots. If the algorithm is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.",[5000],{"passive":"282","active":"283","threshold":"284"},{"type":"198"},["285"],"The hostname to be used as Host header when proxying requests through Kong.",{"id":"286"},"If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.",[false],{"concurrency":10,"healthy":"287","http_path":"88","https_verify_certificate":true,"timeout":1,"type":"92","unhealthy":"288"},{"healthy":"289","type":"92","unhealthy":"290"},"null","consistent-hashing","least-connections","latency",{"type":"198"},{"properties":"291","type":"98"},{"properties":"292","type":"98"},{"default":0,"type":"293"},{"type":"92","healthy":"294","unhealthy":"295"},{"https_verify_certificate":true,"healthy":"296","unhealthy":"297","type":"92","concurrency":10,"headers":"298","timeout":1,"http_path":"88","https_sni":"222"},"user-level","low-priority","ea29aaa3-3b2d-488c-b90c-56df8e0dd8c6",{"type":"92","healthy":"299","unhealthy":"300"},{"https_verify_certificate":true,"healthy":"301","unhealthy":"302","type":"92","concurrency":10,"headers":"303","timeout":1,"http_path":"88","https_sni":"222"},"consumer","ip","cookie","uri_capture","path","query_arg","hash_value",{"type":"98","properties":"304"},{"type":"98","properties":"305"},{"type":"196","description":"306","minimum":0,"maximum":100,"default":0},["270","271"],{"type":"198","examples":"307"},{"http_statuses":"308","interval":0,"successes":0},{"http_failures":0,"http_statuses":"309","interval":0,"tcp_failures":0,"timeouts":0},{"http_statuses":"310","successes":0},{"http_failures":0,"http_statuses":"311","tcp_failures":0,"timeouts":0},{"concurrency":"312","headers":"313","healthy":"314","http_path":"315","https_sni":"316","https_verify_certificate":"317","timeout":"318","type":"319","unhealthy":"320"},{"healthy":"321","type":"322","unhealthy":"323"},"number",{"http_statuses":"324","successes":0},{"http_statuses":"325","timeouts":0,"http_failures":0,"tcp_failures":0},{"http_statuses":"326","successes":0,"interval":0},{"http_failures":0,"http_statuses":"327","timeouts":0,"tcp_failures":0,"interval":0},{"type":"98","properties":"328"},{"http_statuses":"329","successes":0},{"http_statuses":"330","timeouts":0,"http_failures":0,"tcp_failures":0},{"http_statuses":"331","successes":0,"interval":0},{"http_failures":0,"http_statuses":"332","timeouts":0,"tcp_failures":0,"interval":0},["333"],{"type":"334","healthy":"335","unhealthy":"336"},{"https_verify_certificate":"337","healthy":"338","unhealthy":"339","type":"340","concurrency":"341","headers":"342","timeout":"343","http_path":"344","https_sni":"345"},"The minimum percentage of the upstream's targets' weight that must be available for the whole upstream to be considered healthy.",["272"],[200,302],[429,404,500,501,502,503,504,505],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],{"default":10,"type":"196"},{"type":"98"},{"properties":"346","type":"98"},{"default":"88","type":"198"},{"type":"198"},{"default":true,"type":"217"},{"default":1,"type":"293"},{"default":"92","type":"198"},{"properties":"347","type":"98"},{"properties":"348","type":"98"},{"default":"92","type":"198"},{"properties":"349","type":"98"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],[200,302],[429,404,500,501,502,503,504,505],{"x-my-header":"350","x-another-header":"351"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],[200,302],[429,404,500,501,502,503,504,505],{"x-my-header":"352","x-another-header":"353"},{"type":"198","description":"354","default":"92","enum":"355","examples":"356"},{"type":"98","properties":"357"},{"type":"98","properties":"358"},{"type":"217"},{"type":"98","properties":"359"},{"type":"98","properties":"360"},{"type":"198","description":"361","enum":"362","default":"92","examples":"363"},{"type":"196","description":"364","default":10,"examples":"365"},{"type":"98","description":"366","examples":"367"},{"type":"196","description":"368","default":1,"examples":"369"},{"type":"198","description":"370","default":"88"},{"type":"198","description":"371"},{"http_statuses":"372","interval":"373","successes":"374"},{"http_failures":"375","http_statuses":"376","interval":"377","tcp_failures":"378","timeouts":"379"},{"http_statuses":"380","successes":"381"},{"http_failures":"382","http_statuses":"383","tcp_failures":"384","timeouts":"385"},{"type":"214","items":"386","description":"387"},{"type":"214","items":"388","description":"389"},["390","391"],["392"],"Whether to perform passive health checks interpreting HTTP/HTTPS statuses, or just check for TCP connection success. In passive checks, http and https options are equivalent. Accepted values are `tcp`, `http`, `https`, `grpc`, `grpcs`.",["393","92","116","394","395"],["393"],{"http_statuses":"396","successes":"397"},{"http_statuses":"398","timeouts":"399","http_failures":"400","tcp_failures":"401"},{"http_statuses":"402","successes":"403","interval":"404"},{"http_failures":"405","http_statuses":"406","timeouts":"407","tcp_failures":"408","interval":"409"},"Whether to perform active health checks using HTTP or HTTPS, or just attempt a TCP connection.",["393","92","116","394","395"],["116"],"Number of targets to check concurrently in active health checks.",[5],"One or more lists of values indexed by header name to use in GET HTTP request to run as a probe on active health checks. Values must be pre-formatted.",["410"],"Socket timeout for active health checks (in seconds).",[5],"Path to use in GET HTTP request to run as a probe on active health checks.","The hostname to use as an SNI (Server Name Identification) when performing active health checks using HTTPS. This is particularly useful when Targets are configured using IPs, so that the target host's certificate can be verified with the proper SNI.",{"default":"411","items":"412","type":"214"},{"default":0,"type":"293"},{"default":0,"type":"196"},{"default":0,"type":"196"},{"default":"413","items":"414","type":"214"},{"default":0,"type":"293"},{"default":0,"type":"196"},{"default":0,"type":"196"},{"default":"415","items":"416","type":"214"},{"default":0,"type":"196"},{"default":0,"type":"196"},{"default":"417","items":"418","type":"214"},{"default":0,"type":"196"},{"default":0,"type":"196"},{"type":"198"},"The value(s) of the x-my-header header.",{"type":"198"},"The value(s) of the x-another-header header.","foo","bar","bla","tcp","grpc","grpcs",{"type":"214","description":"419","default":"420","items":"421","examples":"422"},{"type":"196","description":"423","default":0,"examples":"424"},{"type":"214","description":"425","default":"426","items":"427","examples":"428"},{"type":"196","description":"429","default":0,"examples":"430"},{"type":"196","description":"431","default":0,"examples":"432"},{"type":"196","description":"433","default":0,"examples":"434"},{"type":"214","description":"435","default":"436","items":"437","examples":"438"},{"type":"196","description":"439","default":0,"examples":"440"},{"type":"196","description":"441","default":0,"examples":"442"},{"type":"196","description":"443","default":0,"examples":"444"},{"type":"214","description":"445","default":"446","items":"447","examples":"448"},{"type":"196","description":"449","default":0,"examples":"450"},{"type":"196","description":"451","default":0,"examples":"452"},{"type":"196","description":"453","default":0,"examples":"454"},{"x-my-header":"455","x-another-header":"456"},[200,302],{"type":"196"},[429,404,500,501,502,503,504,505],{"type":"196"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"196"},[429,500,503],{"type":"196"},"An array of HTTP statuses which represent healthiness when produced by proxied traffic, as observed by passive health checks. With form-encoded, the notation is `http_statuses[]=200&http_statuses[]=201`. With JSON, use an array.",[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"196","enum":"457"},["458"],"Number of successes in proxied traffic (as defined by `healthchecks.passive.healthy.http_statuses`) to consider a target healthy, as observed by passive health checks.",[2],"An array of HTTP statuses which represent unhealthiness when produced by proxied traffic, as observed by passive health checks. With form-encoded, the notation is `http_statuses[]=429&http_statuses[]=500`. With JSON, use an array.",[429,500,503],{"type":"196","enum":"459"},["460"],"Number of timeouts in proxied traffic to consider a target unhealthy, as observed by passive health checks.",[1],"Number of HTTP failures in proxied traffic (as defined by `healthchecks.passive.unhealthy.http_statuses`) to consider a target unhealthy, as observed by passive health checks.",[3],"Number of TCP connection failures to consider a target unhealthy, as observed by passive health checks.",[1],"An array of HTTP statuses to consider a success, indicating healthiness, when returned by a probe in active health checks. With form-encoded, the notation is `http_statuses[]=200&http_statuses[]=302`. With JSON, use an array.",[200,302],{"type":"196"},["461"],"Number of successes in active probes (as defined by `healthchecks.active.healthy.http_statuses`) to consider a target healthy.",[3],"Interval between active health checks for healthy targets (in seconds). A value of zero indicates that active probes for healthy targets should not be performed.",[30],"Number of HTTP failures in active probes (as defined by `healthchecks.active.unhealthy.http_statuses`) to consider a target unhealthy.",[2],"An array of HTTP statuses to consider a failure, indicating unhealthiness, when returned by a probe in active health checks. With form-encoded, the notation is `http_statuses[]=429&http_statuses[]=404`. With JSON, use an array.",[429,404,500,501,502,503,504,505],{"type":"196"},["462"],"Number of timeouts in active probes to consider a target unhealthy.",[2],"Number of TCP failures in active probes to consider a target unhealthy.",[1],"Interval between active health checks for unhealthy targets (in seconds). A value of zero indicates that active probes for unhealthy targets should not be performed.",[10],["390","391"],["392"],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[200,201,202],[429,500,503],[500,503],[200,201],[400,404]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-upstream",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete an Upstream",["17"],"e1c92835dfc18","delete","/upstreams/{upstream_id_or_name}",["18"],{},"delete-upstream","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Upstreams",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38"],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"2a5a4b1190f40","4405e0147ff48","204",[],[],"Successfully deleted Upstream or the resource didn't exist","e415de37af11a","401",[],["45"],"Unauthorized",{"id":"46","name":"47","style":"48","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},{"id":"64","mediaType":"65","examples":"66","encodings":"67","schema":"68"},"2ce1e17f93ee6","upstream_id_or_name","simple",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"69","examples":"70","$schema":"71","x-stoplight":"72"},["73","74","75","76","77","78"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86","enum":"87"},"bf47deceb6876","application/json",["88","89","90"],[],{"type":"91","properties":"92","required":"93","title":"94","$schema":"71","x-stoplight":"95"},"string",["96"],"http://json-schema.org/draft-07/schema#",{"id":"97"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["85","98"],{"id":"99","key":"100","value":"101","summary":"102"},{"id":"103","key":"104","value":"105","summary":"106"},{"id":"107","key":"108","value":"109","summary":"110"},"object",{"status":"111","message":"112"},["113","114"],"UnauthorizedError",{"id":"115"},"7fca84d6-7d37-4a74-a7b0-93e576089a41","a37c0b19c8586","https","5d702ecf65a24","DuplicateApiKey",{"message":"102","status":401},"Duplicate API key found","ca2895697f016","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","45f0460ab3c5f","NoAPIKey",{"message":"116","status":401},"No API key found",{"type":"117"},{"type":"69"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-upstream",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch an Upstream",["18"],"8e17edc030f35","get","/upstreams/{upstream_id_or_name}",["19"],{},"get-upstream","Get an Upstream using ID or name.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Upstreams",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45"],["46"],{"id":"47","url":"48","name":"49","description":"50","variables":"51"},"2a5a4b1190f40","a6c6297671810","200",[],["52"],"Successfully fetched Upstream","e15628cde8eca","401",[],["53"],"Unauthorized","e1a628cde9149","404",[],[],"Resource does not exist",{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},{"id":"77","mediaType":"73","examples":"78","encodings":"79","schema":"80"},"6d88b7628aaa6","upstream_id_or_name","simple",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"81","examples":"82","$schema":"83","x-stoplight":"84"},["85","86","87","88","89","90"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"522511070091e","application/json",["100"],[],{"description":"101","properties":"102","type":"103","title":"104","examples":"105"},"0179491164352",["106","107","108"],[],{"type":"103","properties":"109","required":"110","title":"111","$schema":"83","x-stoplight":"112"},"string",["113"],"http://json-schema.org/draft-07/schema#",{"id":"114"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","115"],{"id":"116","value":"117","key":"118"},"The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets). So for example an upstream named `service.v1.xyz` for a Service object whose `host` is `service.v1.xyz`. Requests for this Service would be proxied to the targets defined within the upstream. An upstream also includes a [health checker][healthchecks], which is able to enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.",{"algorithm":"119","client_certificate":"120","created_at":"121","hash_fallback":"122","hash_fallback_header":"123","hash_fallback_query_arg":"124","hash_fallback_uri_capture":"125","hash_on":"126","hash_on_cookie":"127","hash_on_cookie_path":"128","hash_on_header":"129","hash_on_query_arg":"130","hash_on_uri_capture":"131","healthchecks":"132","host_header":"133","id":"134","name":"135","slots":"136","tags":"137","updated_at":"138","use_srv_name":"139"},"object","Upstream",["117"],{"id":"140","key":"141","value":"142","summary":"143"},{"id":"144","key":"145","value":"146","summary":"147"},{"id":"148","key":"149","value":"150","summary":"151"},{"status":"152","message":"153"},["154","155"],"UnauthorizedError",{"id":"156"},"7fca84d6-7d37-4a74-a7b0-93e576089a41","0ecb26baafcb8","https","903efa7259a03",{"algorithm":"157","hash_fallback":"158","hash_on":"158","hash_on_cookie_path":"93","healthchecks":"159","id":"160","name":"161","slots":10000},"default",{"description":"162","type":"163","default":"157","enum":"164"},{"additionalProperties":false,"description":"165","properties":"166","type":"103"},{"description":"167","type":"168"},{"default":"158","description":"169","type":"81"},{"description":"170","type":"81"},{"description":"171","type":"81"},{"description":"172","type":"81"},{"default":"158","description":"173","type":"81"},{"description":"174","type":"81"},{"default":"93","description":"175","type":"81"},{"description":"176","type":"81"},{"description":"177","type":"81"},{"description":"178","type":"81"},{"properties":"179","type":"103"},{"description":"180","type":"81"},{"type":"81"},{"description":"181","type":"81"},{"default":10000,"description":"182","type":"168"},{"description":"183","items":"184","type":"185"},{"description":"186","type":"168"},{"default":false,"description":"187","type":"188"},"adb035f07a5fe","DuplicateApiKey",{"message":"143","status":401},"Duplicate API key found","61658f2ffd1c1","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","fccfa503d1749","NoAPIKey",{"message":"189","status":401},"No API key found",{"type":"168"},{"type":"81"},"status","message","470b68e5f0549","round-robin","none",{"active":"190","passive":"191","threshold":0},"6eed5e9c-5398-4026-9a4c-d48f18a2431e","api.example.internal","Which load balancing algorithm to use.",["81","192"],["193","194","157","195",null],"If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"196"},"Unix epoch when the resource was created.","integer","What to use as hashing input if the primary `hash_on` does not return a hash (eg. header is missing, or no Consumer identified). Not available if `hash_on` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_fallback` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_fallback` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_fallback` is set to `uri_capture`.","What to use as hashing input. Using `none` results in a weighted-round-robin scheme with no hashing.","The cookie name to take the value from as hash input. Only required when `hash_on` or `hash_fallback` is set to `cookie`. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.","The cookie path to set in the response headers. Only required when `hash_on` or `hash_fallback` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_on` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_on` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_on` is set to `uri_capture`.",{"active":"197","passive":"198","threshold":"199"},"The hostname to be used as `Host` header when proxying requests through Kong.","This is a hostname, which must be equal to the `host` of a Service.","The number of slots in the load balancer algorithm. If `algorithm` is set to `round-robin`, this setting determines the maximum number of slots. If `algorithm` is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range `10`-`65536`.","An optional set of strings associated with the Upstream for grouping and filtering.",{"type":"81"},"array","Unix epoch when the resource was last updated.","If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream `Host`.","boolean","No API key found in request",{"concurrency":10,"healthy":"200","http_path":"93","https_verify_certificate":true,"timeout":1,"type":"97","unhealthy":"201"},{"healthy":"202","type":"97","unhealthy":"203"},"null","consistent-hashing","least-connections","latency",{"type":"81"},{"properties":"204","type":"103"},{"properties":"205","type":"103"},{"default":0,"type":"206"},{"http_statuses":"207","interval":0,"successes":0},{"http_failures":0,"http_statuses":"208","interval":0,"tcp_failures":0,"timeouts":0},{"http_statuses":"209","successes":0},{"http_failures":0,"http_statuses":"210","tcp_failures":0,"timeouts":0},{"concurrency":"211","headers":"212","healthy":"213","http_path":"214","https_sni":"215","https_verify_certificate":"216","timeout":"217","type":"218","unhealthy":"219"},{"healthy":"220","type":"221","unhealthy":"222"},"number",[200,302],[429,404,500,501,502,503,504,505],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],{"default":10,"type":"168"},{"type":"103"},{"properties":"223","type":"103"},{"default":"93","type":"81"},{"type":"81"},{"default":true,"type":"188"},{"default":1,"type":"206"},{"default":"97","type":"81"},{"properties":"224","type":"103"},{"properties":"225","type":"103"},{"default":"97","type":"81"},{"properties":"226","type":"103"},{"http_statuses":"227","interval":"228","successes":"229"},{"http_failures":"230","http_statuses":"231","interval":"232","tcp_failures":"233","timeouts":"234"},{"http_statuses":"235","successes":"236"},{"http_failures":"237","http_statuses":"238","tcp_failures":"239","timeouts":"240"},{"default":"241","items":"242","type":"185"},{"default":0,"type":"206"},{"default":0,"type":"168"},{"default":0,"type":"168"},{"default":"243","items":"244","type":"185"},{"default":0,"type":"206"},{"default":0,"type":"168"},{"default":0,"type":"168"},{"default":"245","items":"246","type":"185"},{"default":0,"type":"168"},{"default":0,"type":"168"},{"default":"247","items":"248","type":"185"},{"default":0,"type":"168"},{"default":0,"type":"168"},[200,302],{"type":"168"},[429,404,500,501,502,503,504,505],{"type":"168"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"168"},[429,500,503],{"type":"168"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-upstream",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update an Upstream",["17"],"3138d90a274db","patch","/upstreams/{upstream_id_or_name}",["18"],{},"update-upstream","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Upstreams",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54"],["55"],{"id":"56","url":"57","name":"58","description":"59","variables":"60"},"2a5a4b1190f40","8586bb74d29fe","200",[],["61"],"Successfully updated Upstream","2d66b998107e6","400",[],["62"],"Invalid Upstream","2d56b998101b5","401",[],["63"],"Unauthorized","2da6b99810e3a","404",[],[],"Resource does not exist","b5ce637678fdb",["64"],"The request object for creating a new upstream.",{"id":"65","name":"66","style":"67","examples":"68","description":"69","required":true,"schema":"70","explicitProperties":"71"},{"id":"72","key":"73","extensions":"74","description":"75","type":"76","name":"77","in":"78"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"79","path":"80","port":"81","protocol":"82"},{"id":"83","mediaType":"84","examples":"85","encodings":"86","schema":"87"},{"id":"88","mediaType":"84","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"84","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"84","examples":"97","encodings":"98","schema":"99"},"b12da9c20bb61","upstream_id_or_name","simple",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"100","examples":"101","$schema":"102","x-stoplight":"103"},["104","105","106","107","108","109"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"110","description":"111"},{"default":"112","description":"113"},{"default":"114","description":"115"},{"default":"116","description":"117","enum":"118"},"475160539dd1f","application/json",["119"],[],{"description":"120","properties":"121","type":"122","title":"123","examples":"124"},"009e2a4b5a5fb",[],[],{"type":"122","$schema":"102","x-stoplight":"125"},"6ae9b06478288",["126","127","128"],[],{"type":"122","properties":"129","required":"130","title":"131","$schema":"102","x-stoplight":"132"},"a3aae82cca968",["133","134"],[],{"type":"122","x-examples":"135","properties":"136","required":"137","$schema":"102","x-stoplight":"138"},"string",["139"],"http://json-schema.org/draft-07/schema#",{"id":"140"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["116","141"],{"id":"142","value":"143","key":"144"},"The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets). So for example an upstream named `service.v1.xyz` for a Service object whose `host` is `service.v1.xyz`. Requests for this Service would be proxied to the targets defined within the upstream. An upstream also includes a [health checker][healthchecks], which is able to enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.",{"algorithm":"145","client_certificate":"146","created_at":"147","hash_fallback":"148","hash_fallback_header":"149","hash_fallback_query_arg":"150","hash_fallback_uri_capture":"151","hash_on":"152","hash_on_cookie":"153","hash_on_cookie_path":"154","hash_on_header":"155","hash_on_query_arg":"156","hash_on_uri_capture":"157","healthchecks":"158","host_header":"159","id":"160","name":"161","slots":"162","tags":"163","updated_at":"164","use_srv_name":"165"},"object","Upstream",["143"],{"id":"166"},{"id":"167","key":"168","value":"169","summary":"170"},{"id":"171","key":"172","value":"173","summary":"174"},{"id":"175","key":"176","value":"177","summary":"178"},{"status":"179","message":"180"},["181","182"],"UnauthorizedError",{"id":"183"},{"id":"184","key":"123","value":"185"},{"id":"186","key":"187","value":"188"},{"Example 1":"189"},{"name":"190","algorithm":"191","hash_on":"192","hash_fallback":"193","hash_on_header":"194","hash_fallback_header":"195","hash_on_cookie":"196","hash_on_cookie_path":"197","hash_on_query_arg":"198","hash_fallback_query_arg":"199","hash_on_uri_capture":"200","hash_fallback_uri_capture":"201","slots":"202","healthchecks":"203","tags":"204","host_header":"205","client_certificate":"206","use_srv_name":"207"},["104"],{"id":"208"},"7fca84d6-7d37-4a74-a7b0-93e576089a41","a07b69cc56923","https","1c51dabc32769",{"algorithm":"209","hash_fallback":"210","hash_on":"210","hash_on_cookie_path":"112","healthchecks":"211","id":"212","name":"213","slots":10000},"default",{"description":"214","type":"215","default":"209","enum":"216"},{"additionalProperties":false,"description":"217","properties":"218","type":"122"},{"description":"219","type":"220"},{"default":"210","description":"221","type":"100"},{"description":"222","type":"100"},{"description":"223","type":"100"},{"description":"224","type":"100"},{"default":"210","description":"225","type":"100"},{"description":"226","type":"100"},{"default":"112","description":"227","type":"100"},{"description":"228","type":"100"},{"description":"229","type":"100"},{"description":"230","type":"100"},{"properties":"231","type":"122"},{"description":"232","type":"100"},{"type":"100"},{"description":"233","type":"100"},{"default":10000,"description":"234","type":"220"},{"description":"235","items":"236","type":"237"},{"description":"238","type":"220"},{"default":false,"description":"239","type":"240"},"4a88486d542dd","758591e411947","DuplicateApiKey",{"message":"170","status":401},"Duplicate API key found","b8798e6d6b12d","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","08b0bb928b283","NoAPIKey",{"message":"241","status":401},"No API key found",{"type":"220"},{"type":"100"},"status","message","470b68e5f0549","ab3816d5da72d",{"name":"242","algorithm":"209","hash_on":"210","hash_fallback":"210","hash_on_cookie_path":"112","slots":10000,"healthchecks":"243","tags":"244","host_header":"245","client_certificate":"246","use_srv_name":false},"80ee5bf45c74e","Example request",{"name":"242","tags":"247","algorithm":"209"},{"id":"248","created_at":1422386534,"name":"242","algorithm":"209","hash_on":"210","hash_fallback":"210","hash_on_cookie_path":"112","slots":10000,"healthchecks":"249","tags":"250","host_header":"245","client_certificate":"251","use_srv_name":false},{"type":"100","description":"252","examples":"253"},{"type":"100","description":"254","enum":"255","default":"209","examples":"256"},{"type":"100","description":"257","default":"210","enum":"258"},{"type":"100","description":"259","default":"210","enum":"260","examples":"261"},{"type":"100","description":"262","examples":"263"},{"type":"100","description":"264","default":"210","examples":"265"},{"type":"100","description":"226","examples":"266"},{"type":"100","description":"227","default":"112","examples":"267"},{"type":"100","description":"229","examples":"268"},{"type":"100","description":"223","examples":"269"},{"type":"100","description":"230","examples":"270"},{"type":"100","description":"224","examples":"271"},{"type":"220","description":"272","minimum":10,"maximum":65536,"default":10000,"examples":"273"},{"type":"122","properties":"274"},{"type":"237","description":"235","items":"275","examples":"276"},{"type":"100","description":"277"},{"type":"122","description":"217","properties":"278"},{"type":"240","description":"279","examples":"280"},"1d11995efa499","round-robin","none",{"active":"281","passive":"282","threshold":0},"6eed5e9c-5398-4026-9a4c-d48f18a2431e","api.example.internal","Which load balancing algorithm to use.",["100","283"],["284","285","209","286",null],"If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"287"},"Unix epoch when the resource was created.","integer","What to use as hashing input if the primary `hash_on` does not return a hash (eg. header is missing, or no Consumer identified). Not available if `hash_on` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_fallback` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_fallback` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_fallback` is set to `uri_capture`.","What to use as hashing input. Using `none` results in a weighted-round-robin scheme with no hashing.","The cookie name to take the value from as hash input. Only required when `hash_on` or `hash_fallback` is set to `cookie`. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.","The cookie path to set in the response headers. Only required when `hash_on` or `hash_fallback` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_on` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_on` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_on` is set to `uri_capture`.",{"active":"288","passive":"289","threshold":"290"},"The hostname to be used as `Host` header when proxying requests through Kong.","This is a hostname, which must be equal to the `host` of a Service.","The number of slots in the load balancer algorithm. If `algorithm` is set to `round-robin`, this setting determines the maximum number of slots. If `algorithm` is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range `10`-`65536`.","An optional set of strings associated with the Upstream for grouping and filtering.",{"type":"100"},"array","Unix epoch when the resource was last updated.","If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream `Host`.","boolean","No API key found in request","my-upstream",{"passive":"291","active":"292","threshold":0},["293","294"],"example.com",{"id":"295"},["293","294"],"58c8ccbb-eafb-4566-991f-2ed4f678fa70",{"passive":"296","active":"297","threshold":0},["293","294"],{"id":"295"},"This is a hostname, which must be equal to the `host` of a service.",["242"],"Which load balancing algorithm to use.\n",["284","285","209","286"],["209"],"What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing",["210","298","299","300","301","302","303"],"What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie.",["210","298","299","300","301","302","303"],["210"],"The header name to take the value from as hash input. Only required when `hash_on` is set to header.",["210"],"The header name to take the value from as hash input. Only required when hash_fallback is set to header.",["210"],["210"],["112"],["304"],["304"],["304"],["304"],"The number of slots in the load balancer algorithm. If the algorithm is set to `round-robin`, this setting determines the maximum number of slots. If the algorithm is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.",[5000],{"passive":"305","active":"306","threshold":"307"},{"type":"100"},["308"],"The hostname to be used as Host header when proxying requests through Kong.",{"id":"309"},"If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.",[false],{"concurrency":10,"healthy":"310","http_path":"112","https_verify_certificate":true,"timeout":1,"type":"116","unhealthy":"311"},{"healthy":"312","type":"116","unhealthy":"313"},"null","consistent-hashing","least-connections","latency",{"type":"100"},{"properties":"314","type":"122"},{"properties":"315","type":"122"},{"default":0,"type":"316"},{"type":"116","healthy":"317","unhealthy":"318"},{"https_verify_certificate":true,"healthy":"319","unhealthy":"320","type":"116","concurrency":10,"headers":"321","timeout":1,"http_path":"112","https_sni":"245"},"user-level","low-priority","ea29aaa3-3b2d-488c-b90c-56df8e0dd8c6",{"type":"116","healthy":"322","unhealthy":"323"},{"https_verify_certificate":true,"healthy":"324","unhealthy":"325","type":"116","concurrency":10,"headers":"326","timeout":1,"http_path":"112","https_sni":"245"},"consumer","ip","cookie","uri_capture","path","query_arg","hash_value",{"type":"122","properties":"327"},{"type":"122","properties":"328"},{"type":"220","description":"329","minimum":0,"maximum":100,"default":0},["293","294"],{"type":"100","examples":"330"},{"http_statuses":"331","interval":0,"successes":0},{"http_failures":0,"http_statuses":"332","interval":0,"tcp_failures":0,"timeouts":0},{"http_statuses":"333","successes":0},{"http_failures":0,"http_statuses":"334","tcp_failures":0,"timeouts":0},{"concurrency":"335","headers":"336","healthy":"337","http_path":"338","https_sni":"339","https_verify_certificate":"340","timeout":"341","type":"342","unhealthy":"343"},{"healthy":"344","type":"345","unhealthy":"346"},"number",{"http_statuses":"347","successes":0},{"http_statuses":"348","timeouts":0,"http_failures":0,"tcp_failures":0},{"http_statuses":"349","successes":0,"interval":0},{"http_failures":0,"http_statuses":"350","timeouts":0,"tcp_failures":0,"interval":0},{"type":"122","properties":"351"},{"http_statuses":"352","successes":0},{"http_statuses":"353","timeouts":0,"http_failures":0,"tcp_failures":0},{"http_statuses":"354","successes":0,"interval":0},{"http_failures":0,"http_statuses":"355","timeouts":0,"tcp_failures":0,"interval":0},["356"],{"type":"357","healthy":"358","unhealthy":"359"},{"https_verify_certificate":"360","healthy":"361","unhealthy":"362","type":"363","concurrency":"364","headers":"365","timeout":"366","http_path":"367","https_sni":"368"},"The minimum percentage of the upstream's targets' weight that must be available for the whole upstream to be considered healthy.",["295"],[200,302],[429,404,500,501,502,503,504,505],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],{"default":10,"type":"220"},{"type":"122"},{"properties":"369","type":"122"},{"default":"112","type":"100"},{"type":"100"},{"default":true,"type":"240"},{"default":1,"type":"316"},{"default":"116","type":"100"},{"properties":"370","type":"122"},{"properties":"371","type":"122"},{"default":"116","type":"100"},{"properties":"372","type":"122"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],[200,302],[429,404,500,501,502,503,504,505],{"x-my-header":"373","x-another-header":"374"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],[200,302],[429,404,500,501,502,503,504,505],{"x-my-header":"375","x-another-header":"376"},{"type":"100","description":"377","default":"116","enum":"378","examples":"379"},{"type":"122","properties":"380"},{"type":"122","properties":"381"},{"type":"240"},{"type":"122","properties":"382"},{"type":"122","properties":"383"},{"type":"100","description":"384","enum":"385","default":"116","examples":"386"},{"type":"220","description":"387","default":10,"examples":"388"},{"type":"122","description":"389","examples":"390"},{"type":"220","description":"391","default":1,"examples":"392"},{"type":"100","description":"393","default":"112"},{"type":"100","description":"394"},{"http_statuses":"395","interval":"396","successes":"397"},{"http_failures":"398","http_statuses":"399","interval":"400","tcp_failures":"401","timeouts":"402"},{"http_statuses":"403","successes":"404"},{"http_failures":"405","http_statuses":"406","tcp_failures":"407","timeouts":"408"},{"type":"237","items":"409","description":"410"},{"type":"237","items":"411","description":"412"},["413","414"],["415"],"Whether to perform passive health checks interpreting HTTP/HTTPS statuses, or just check for TCP connection success. In passive checks, http and https options are equivalent. Accepted values are `tcp`, `http`, `https`, `grpc`, `grpcs`.",["416","116","141","417","418"],["416"],{"http_statuses":"419","successes":"420"},{"http_statuses":"421","timeouts":"422","http_failures":"423","tcp_failures":"424"},{"http_statuses":"425","successes":"426","interval":"427"},{"http_failures":"428","http_statuses":"429","timeouts":"430","tcp_failures":"431","interval":"432"},"Whether to perform active health checks using HTTP or HTTPS, or just attempt a TCP connection.",["416","116","141","417","418"],["141"],"Number of targets to check concurrently in active health checks.",[5],"One or more lists of values indexed by header name to use in GET HTTP request to run as a probe on active health checks. Values must be pre-formatted.",["433"],"Socket timeout for active health checks (in seconds).",[5],"Path to use in GET HTTP request to run as a probe on active health checks.","The hostname to use as an SNI (Server Name Identification) when performing active health checks using HTTPS. This is particularly useful when Targets are configured using IPs, so that the target host's certificate can be verified with the proper SNI.",{"default":"434","items":"435","type":"237"},{"default":0,"type":"316"},{"default":0,"type":"220"},{"default":0,"type":"220"},{"default":"436","items":"437","type":"237"},{"default":0,"type":"316"},{"default":0,"type":"220"},{"default":0,"type":"220"},{"default":"438","items":"439","type":"237"},{"default":0,"type":"220"},{"default":0,"type":"220"},{"default":"440","items":"441","type":"237"},{"default":0,"type":"220"},{"default":0,"type":"220"},{"type":"100"},"The value(s) of the x-my-header header.",{"type":"100"},"The value(s) of the x-another-header header.","foo","bar","bla","tcp","grpc","grpcs",{"type":"237","description":"442","default":"443","items":"444","examples":"445"},{"type":"220","description":"446","default":0,"examples":"447"},{"type":"237","description":"448","default":"449","items":"450","examples":"451"},{"type":"220","description":"452","default":0,"examples":"453"},{"type":"220","description":"454","default":0,"examples":"455"},{"type":"220","description":"456","default":0,"examples":"457"},{"type":"237","description":"458","default":"459","items":"460","examples":"461"},{"type":"220","description":"462","default":0,"examples":"463"},{"type":"220","description":"464","default":0,"examples":"465"},{"type":"220","description":"466","default":0,"examples":"467"},{"type":"237","description":"468","default":"469","items":"470","examples":"471"},{"type":"220","description":"472","default":0,"examples":"473"},{"type":"220","description":"474","default":0,"examples":"475"},{"type":"220","description":"476","default":0,"examples":"477"},{"x-my-header":"478","x-another-header":"479"},[200,302],{"type":"220"},[429,404,500,501,502,503,504,505],{"type":"220"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"220"},[429,500,503],{"type":"220"},"An array of HTTP statuses which represent healthiness when produced by proxied traffic, as observed by passive health checks. With form-encoded, the notation is `http_statuses[]=200&http_statuses[]=201`. With JSON, use an array.",[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"220","enum":"480"},["481"],"Number of successes in proxied traffic (as defined by `healthchecks.passive.healthy.http_statuses`) to consider a target healthy, as observed by passive health checks.",[2],"An array of HTTP statuses which represent unhealthiness when produced by proxied traffic, as observed by passive health checks. With form-encoded, the notation is `http_statuses[]=429&http_statuses[]=500`. With JSON, use an array.",[429,500,503],{"type":"220","enum":"482"},["483"],"Number of timeouts in proxied traffic to consider a target unhealthy, as observed by passive health checks.",[1],"Number of HTTP failures in proxied traffic (as defined by `healthchecks.passive.unhealthy.http_statuses`) to consider a target unhealthy, as observed by passive health checks.",[3],"Number of TCP connection failures to consider a target unhealthy, as observed by passive health checks.",[1],"An array of HTTP statuses to consider a success, indicating healthiness, when returned by a probe in active health checks. With form-encoded, the notation is `http_statuses[]=200&http_statuses[]=302`. With JSON, use an array.",[200,302],{"type":"220"},["484"],"Number of successes in active probes (as defined by `healthchecks.active.healthy.http_statuses`) to consider a target healthy.",[3],"Interval between active health checks for healthy targets (in seconds). A value of zero indicates that active probes for healthy targets should not be performed.",[30],"Number of HTTP failures in active probes (as defined by `healthchecks.active.unhealthy.http_statuses`) to consider a target unhealthy.",[2],"An array of HTTP statuses to consider a failure, indicating unhealthiness, when returned by a probe in active health checks. With form-encoded, the notation is `http_statuses[]=429&http_statuses[]=404`. With JSON, use an array.",[429,404,500,501,502,503,504,505],{"type":"220"},["485"],"Number of timeouts in active probes to consider a target unhealthy.",[2],"Number of TCP failures in active probes to consider a target unhealthy.",[1],"Interval between active health checks for unhealthy targets (in seconds). A value of zero indicates that active probes for unhealthy targets should not be performed.",[10],["413","414"],["415"],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[200,201,202],[429,500,503],[500,503],[200,201],[400,404]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-upstream",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a Upstream",["18"],"5089849a54c3e","put","/upstreams/{upstream_id_or_name}",["19"],{},"upsert-upstream","Create or Update Upstream using ID or name.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Upstreams",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"2a5a4b1190f40","82123670f81de","200",[],["56"],"Successfully upserted Upstream","1772370268e00","400",[],["57"],"Invalid Upstream","17623702689d3","401",[],["58"],"Unauthorized","9f553ff2f7b76",["59"],"The request object for creating a new upstream.",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"79","examples":"84","encodings":"85","schema":"86"},{"id":"87","mediaType":"79","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"79","examples":"92","encodings":"93","schema":"94"},"8ab6dda6828f0","upstream_id_or_name","simple",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110"},{"default":"111","description":"112","enum":"113"},"3611ea20953df","application/json",["114"],[],{"description":"115","properties":"116","type":"117","title":"118","examples":"119"},"8bfc734d06861",[],[],{"type":"117","$schema":"97","x-stoplight":"120"},"31d267c9c7113",["121","122","123"],[],{"type":"117","properties":"124","required":"125","title":"126","$schema":"97","x-stoplight":"127"},"3615afa4f2d49",["128","129"],[],{"type":"117","x-examples":"130","properties":"131","required":"132","$schema":"97","x-stoplight":"133"},"string",["134"],"http://json-schema.org/draft-07/schema#",{"id":"135"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["111","136"],{"id":"137","value":"138","key":"139"},"The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets). So for example an upstream named `service.v1.xyz` for a Service object whose `host` is `service.v1.xyz`. Requests for this Service would be proxied to the targets defined within the upstream. An upstream also includes a [health checker][healthchecks], which is able to enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.",{"algorithm":"140","client_certificate":"141","created_at":"142","hash_fallback":"143","hash_fallback_header":"144","hash_fallback_query_arg":"145","hash_fallback_uri_capture":"146","hash_on":"147","hash_on_cookie":"148","hash_on_cookie_path":"149","hash_on_header":"150","hash_on_query_arg":"151","hash_on_uri_capture":"152","healthchecks":"153","host_header":"154","id":"155","name":"156","slots":"157","tags":"158","updated_at":"159","use_srv_name":"160"},"object","Upstream",["138"],{"id":"161"},{"id":"162","key":"163","value":"164","summary":"165"},{"id":"166","key":"167","value":"168","summary":"169"},{"id":"170","key":"171","value":"172","summary":"173"},{"status":"174","message":"175"},["176","177"],"UnauthorizedError",{"id":"178"},{"id":"179","key":"118","value":"180"},{"id":"181","key":"182","value":"183"},{"Example 1":"184"},{"name":"185","algorithm":"186","hash_on":"187","hash_fallback":"188","hash_on_header":"189","hash_fallback_header":"190","hash_on_cookie":"191","hash_on_cookie_path":"192","hash_on_query_arg":"193","hash_fallback_query_arg":"194","hash_on_uri_capture":"195","hash_fallback_uri_capture":"196","slots":"197","healthchecks":"198","tags":"199","host_header":"200","client_certificate":"201","use_srv_name":"202"},["99"],{"id":"203"},"7fca84d6-7d37-4a74-a7b0-93e576089a41","4f408d573df1f","https","a74bd4422fda4",{"algorithm":"204","hash_fallback":"205","hash_on":"205","hash_on_cookie_path":"107","healthchecks":"206","id":"207","name":"208","slots":10000},"default",{"description":"209","type":"210","default":"204","enum":"211"},{"additionalProperties":false,"description":"212","properties":"213","type":"117"},{"description":"214","type":"215"},{"default":"205","description":"216","type":"95"},{"description":"217","type":"95"},{"description":"218","type":"95"},{"description":"219","type":"95"},{"default":"205","description":"220","type":"95"},{"description":"221","type":"95"},{"default":"107","description":"222","type":"95"},{"description":"223","type":"95"},{"description":"224","type":"95"},{"description":"225","type":"95"},{"properties":"226","type":"117"},{"description":"227","type":"95"},{"type":"95"},{"description":"228","type":"95"},{"default":10000,"description":"229","type":"215"},{"description":"230","items":"231","type":"232"},{"description":"233","type":"215"},{"default":false,"description":"234","type":"235"},"ec11fc86fa910","9e2a88bbb843e","DuplicateApiKey",{"message":"165","status":401},"Duplicate API key found","b21ed54ea4b58","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","70e4d58c4bd39","NoAPIKey",{"message":"236","status":401},"No API key found",{"type":"215"},{"type":"95"},"status","message","470b68e5f0549","8d99c1acfc029",{"name":"237","algorithm":"204","hash_on":"205","hash_fallback":"205","hash_on_cookie_path":"107","slots":10000,"healthchecks":"238","tags":"239","host_header":"240","client_certificate":"241","use_srv_name":false},"efbe7d76a408f","Example request",{"name":"237","tags":"242","algorithm":"204"},{"id":"243","created_at":1422386534,"name":"237","algorithm":"204","hash_on":"205","hash_fallback":"205","hash_on_cookie_path":"107","slots":10000,"healthchecks":"244","tags":"245","host_header":"240","client_certificate":"246","use_srv_name":false},{"type":"95","description":"247","examples":"248"},{"type":"95","description":"249","enum":"250","default":"204","examples":"251"},{"type":"95","description":"252","default":"205","enum":"253"},{"type":"95","description":"254","default":"205","enum":"255","examples":"256"},{"type":"95","description":"257","examples":"258"},{"type":"95","description":"259","default":"205","examples":"260"},{"type":"95","description":"221","examples":"261"},{"type":"95","description":"222","default":"107","examples":"262"},{"type":"95","description":"224","examples":"263"},{"type":"95","description":"218","examples":"264"},{"type":"95","description":"225","examples":"265"},{"type":"95","description":"219","examples":"266"},{"type":"215","description":"267","minimum":10,"maximum":65536,"default":10000,"examples":"268"},{"type":"117","properties":"269"},{"type":"232","description":"230","items":"270","examples":"271"},{"type":"95","description":"272"},{"type":"117","description":"212","properties":"273"},{"type":"235","description":"274","examples":"275"},"1d11995efa499","round-robin","none",{"active":"276","passive":"277","threshold":0},"6eed5e9c-5398-4026-9a4c-d48f18a2431e","api.example.internal","Which load balancing algorithm to use.",["95","278"],["279","280","204","281",null],"If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"282"},"Unix epoch when the resource was created.","integer","What to use as hashing input if the primary `hash_on` does not return a hash (eg. header is missing, or no Consumer identified). Not available if `hash_on` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_fallback` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_fallback` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_fallback` is set to `uri_capture`.","What to use as hashing input. Using `none` results in a weighted-round-robin scheme with no hashing.","The cookie name to take the value from as hash input. Only required when `hash_on` or `hash_fallback` is set to `cookie`. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.","The cookie path to set in the response headers. Only required when `hash_on` or `hash_fallback` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_on` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_on` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_on` is set to `uri_capture`.",{"active":"283","passive":"284","threshold":"285"},"The hostname to be used as `Host` header when proxying requests through Kong.","This is a hostname, which must be equal to the `host` of a Service.","The number of slots in the load balancer algorithm. If `algorithm` is set to `round-robin`, this setting determines the maximum number of slots. If `algorithm` is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range `10`-`65536`.","An optional set of strings associated with the Upstream for grouping and filtering.",{"type":"95"},"array","Unix epoch when the resource was last updated.","If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream `Host`.","boolean","No API key found in request","my-upstream",{"passive":"286","active":"287","threshold":0},["288","289"],"example.com",{"id":"290"},["288","289"],"58c8ccbb-eafb-4566-991f-2ed4f678fa70",{"passive":"291","active":"292","threshold":0},["288","289"],{"id":"290"},"This is a hostname, which must be equal to the `host` of a service.",["237"],"Which load balancing algorithm to use.\n",["279","280","204","281"],["204"],"What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing",["205","293","294","295","296","297","298"],"What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie.",["205","293","294","295","296","297","298"],["205"],"The header name to take the value from as hash input. Only required when `hash_on` is set to header.",["205"],"The header name to take the value from as hash input. Only required when hash_fallback is set to header.",["205"],["205"],["107"],["299"],["299"],["299"],["299"],"The number of slots in the load balancer algorithm. If the algorithm is set to `round-robin`, this setting determines the maximum number of slots. If the algorithm is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.",[5000],{"passive":"300","active":"301","threshold":"302"},{"type":"95"},["303"],"The hostname to be used as Host header when proxying requests through Kong.",{"id":"304"},"If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.",[false],{"concurrency":10,"healthy":"305","http_path":"107","https_verify_certificate":true,"timeout":1,"type":"111","unhealthy":"306"},{"healthy":"307","type":"111","unhealthy":"308"},"null","consistent-hashing","least-connections","latency",{"type":"95"},{"properties":"309","type":"117"},{"properties":"310","type":"117"},{"default":0,"type":"311"},{"type":"111","healthy":"312","unhealthy":"313"},{"https_verify_certificate":true,"healthy":"314","unhealthy":"315","type":"111","concurrency":10,"headers":"316","timeout":1,"http_path":"107","https_sni":"240"},"user-level","low-priority","ea29aaa3-3b2d-488c-b90c-56df8e0dd8c6",{"type":"111","healthy":"317","unhealthy":"318"},{"https_verify_certificate":true,"healthy":"319","unhealthy":"320","type":"111","concurrency":10,"headers":"321","timeout":1,"http_path":"107","https_sni":"240"},"consumer","ip","cookie","uri_capture","path","query_arg","hash_value",{"type":"117","properties":"322"},{"type":"117","properties":"323"},{"type":"215","description":"324","minimum":0,"maximum":100,"default":0},["288","289"],{"type":"95","examples":"325"},{"http_statuses":"326","interval":0,"successes":0},{"http_failures":0,"http_statuses":"327","interval":0,"tcp_failures":0,"timeouts":0},{"http_statuses":"328","successes":0},{"http_failures":0,"http_statuses":"329","tcp_failures":0,"timeouts":0},{"concurrency":"330","headers":"331","healthy":"332","http_path":"333","https_sni":"334","https_verify_certificate":"335","timeout":"336","type":"337","unhealthy":"338"},{"healthy":"339","type":"340","unhealthy":"341"},"number",{"http_statuses":"342","successes":0},{"http_statuses":"343","timeouts":0,"http_failures":0,"tcp_failures":0},{"http_statuses":"344","successes":0,"interval":0},{"http_failures":0,"http_statuses":"345","timeouts":0,"tcp_failures":0,"interval":0},{"type":"117","properties":"346"},{"http_statuses":"347","successes":0},{"http_statuses":"348","timeouts":0,"http_failures":0,"tcp_failures":0},{"http_statuses":"349","successes":0,"interval":0},{"http_failures":0,"http_statuses":"350","timeouts":0,"tcp_failures":0,"interval":0},["351"],{"type":"352","healthy":"353","unhealthy":"354"},{"https_verify_certificate":"355","healthy":"356","unhealthy":"357","type":"358","concurrency":"359","headers":"360","timeout":"361","http_path":"362","https_sni":"363"},"The minimum percentage of the upstream's targets' weight that must be available for the whole upstream to be considered healthy.",["290"],[200,302],[429,404,500,501,502,503,504,505],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],{"default":10,"type":"215"},{"type":"117"},{"properties":"364","type":"117"},{"default":"107","type":"95"},{"type":"95"},{"default":true,"type":"235"},{"default":1,"type":"311"},{"default":"111","type":"95"},{"properties":"365","type":"117"},{"properties":"366","type":"117"},{"default":"111","type":"95"},{"properties":"367","type":"117"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],[200,302],[429,404,500,501,502,503,504,505],{"x-my-header":"368","x-another-header":"369"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],[200,302],[429,404,500,501,502,503,504,505],{"x-my-header":"370","x-another-header":"371"},{"type":"95","description":"372","default":"111","enum":"373","examples":"374"},{"type":"117","properties":"375"},{"type":"117","properties":"376"},{"type":"235"},{"type":"117","properties":"377"},{"type":"117","properties":"378"},{"type":"95","description":"379","enum":"380","default":"111","examples":"381"},{"type":"215","description":"382","default":10,"examples":"383"},{"type":"117","description":"384","examples":"385"},{"type":"215","description":"386","default":1,"examples":"387"},{"type":"95","description":"388","default":"107"},{"type":"95","description":"389"},{"http_statuses":"390","interval":"391","successes":"392"},{"http_failures":"393","http_statuses":"394","interval":"395","tcp_failures":"396","timeouts":"397"},{"http_statuses":"398","successes":"399"},{"http_failures":"400","http_statuses":"401","tcp_failures":"402","timeouts":"403"},{"type":"232","items":"404","description":"405"},{"type":"232","items":"406","description":"407"},["408","409"],["410"],"Whether to perform passive health checks interpreting HTTP/HTTPS statuses, or just check for TCP connection success. In passive checks, http and https options are equivalent. Accepted values are `tcp`, `http`, `https`, `grpc`, `grpcs`.",["411","111","136","412","413"],["411"],{"http_statuses":"414","successes":"415"},{"http_statuses":"416","timeouts":"417","http_failures":"418","tcp_failures":"419"},{"http_statuses":"420","successes":"421","interval":"422"},{"http_failures":"423","http_statuses":"424","timeouts":"425","tcp_failures":"426","interval":"427"},"Whether to perform active health checks using HTTP or HTTPS, or just attempt a TCP connection.",["411","111","136","412","413"],["136"],"Number of targets to check concurrently in active health checks.",[5],"One or more lists of values indexed by header name to use in GET HTTP request to run as a probe on active health checks. Values must be pre-formatted.",["428"],"Socket timeout for active health checks (in seconds).",[5],"Path to use in GET HTTP request to run as a probe on active health checks.","The hostname to use as an SNI (Server Name Identification) when performing active health checks using HTTPS. This is particularly useful when Targets are configured using IPs, so that the target host's certificate can be verified with the proper SNI.",{"default":"429","items":"430","type":"232"},{"default":0,"type":"311"},{"default":0,"type":"215"},{"default":0,"type":"215"},{"default":"431","items":"432","type":"232"},{"default":0,"type":"311"},{"default":0,"type":"215"},{"default":0,"type":"215"},{"default":"433","items":"434","type":"232"},{"default":0,"type":"215"},{"default":0,"type":"215"},{"default":"435","items":"436","type":"232"},{"default":0,"type":"215"},{"default":0,"type":"215"},{"type":"95"},"The value(s) of the x-my-header header.",{"type":"95"},"The value(s) of the x-another-header header.","foo","bar","bla","tcp","grpc","grpcs",{"type":"232","description":"437","default":"438","items":"439","examples":"440"},{"type":"215","description":"441","default":0,"examples":"442"},{"type":"232","description":"443","default":"444","items":"445","examples":"446"},{"type":"215","description":"447","default":0,"examples":"448"},{"type":"215","description":"449","default":0,"examples":"450"},{"type":"215","description":"451","default":0,"examples":"452"},{"type":"232","description":"453","default":"454","items":"455","examples":"456"},{"type":"215","description":"457","default":0,"examples":"458"},{"type":"215","description":"459","default":0,"examples":"460"},{"type":"215","description":"461","default":0,"examples":"462"},{"type":"232","description":"463","default":"464","items":"465","examples":"466"},{"type":"215","description":"467","default":0,"examples":"468"},{"type":"215","description":"469","default":0,"examples":"470"},{"type":"215","description":"471","default":0,"examples":"472"},{"x-my-header":"473","x-another-header":"474"},[200,302],{"type":"215"},[429,404,500,501,502,503,504,505],{"type":"215"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"215"},[429,500,503],{"type":"215"},"An array of HTTP statuses which represent healthiness when produced by proxied traffic, as observed by passive health checks. With form-encoded, the notation is `http_statuses[]=200&http_statuses[]=201`. With JSON, use an array.",[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"215","enum":"475"},["476"],"Number of successes in proxied traffic (as defined by `healthchecks.passive.healthy.http_statuses`) to consider a target healthy, as observed by passive health checks.",[2],"An array of HTTP statuses which represent unhealthiness when produced by proxied traffic, as observed by passive health checks. With form-encoded, the notation is `http_statuses[]=429&http_statuses[]=500`. With JSON, use an array.",[429,500,503],{"type":"215","enum":"477"},["478"],"Number of timeouts in proxied traffic to consider a target unhealthy, as observed by passive health checks.",[1],"Number of HTTP failures in proxied traffic (as defined by `healthchecks.passive.unhealthy.http_statuses`) to consider a target unhealthy, as observed by passive health checks.",[3],"Number of TCP connection failures to consider a target unhealthy, as observed by passive health checks.",[1],"An array of HTTP statuses to consider a success, indicating healthiness, when returned by a probe in active health checks. With form-encoded, the notation is `http_statuses[]=200&http_statuses[]=302`. With JSON, use an array.",[200,302],{"type":"215"},["479"],"Number of successes in active probes (as defined by `healthchecks.active.healthy.http_statuses`) to consider a target healthy.",[3],"Interval between active health checks for healthy targets (in seconds). A value of zero indicates that active probes for healthy targets should not be performed.",[30],"Number of HTTP failures in active probes (as defined by `healthchecks.active.unhealthy.http_statuses`) to consider a target unhealthy.",[2],"An array of HTTP statuses to consider a failure, indicating unhealthiness, when returned by a probe in active health checks. With form-encoded, the notation is `http_statuses[]=429&http_statuses[]=404`. With JSON, use an array.",[429,404,500,501,502,503,504,505],{"type":"215"},["480"],"Number of timeouts in active probes to consider a target unhealthy.",[2],"Number of TCP failures in active probes to consider a target unhealthy.",[1],"Interval between active health checks for unhealthy targets (in seconds). A value of zero indicates that active probes for unhealthy targets should not be performed.",[10],["408","409"],["410"],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[200,201,202],[429,500,503],[500,503],[200,201],[400,404]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-upstream-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all Upstreams in a workspace",["17"],"b4d382807eca4","get","/{workspace}/upstreams",["18"],{},"list-upstream-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Upstreams",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],["41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"2a5a4b1190f40","8eab2c268fe50","200",[],["48"],"A successful response listing Upstreams","c15b2b7df8630","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"71","examples":"72","description":"73","required":true,"schema":"74","explicitProperties":"75"},{"id":"76","key":"77","extensions":"78","description":"79","type":"80","name":"81","in":"82"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"83","path":"84","port":"85","protocol":"86"},{"id":"87","mediaType":"88","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"88","examples":"93","encodings":"94","schema":"95"},"64c4f80582079","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103"],"c7a97e013ea23","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"104","$schema":"97","x-stoplight":"105"},["99","100","101","102","103"],"2ce4485fd6c19","tags",["106"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"104","examples":"107","x-stoplight":"108","$schema":"97"},["99","109","100","101","102","103"],"02e6cafb853a6","workspace","simple",[],"Name or ID of workspace",{"type":"104","examples":"110","$schema":"97","x-stoplight":"111"},["101","100","112","102","99","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"f9e3d376290ac","application/json",[],[],{"properties":"122","$schema":"97","x-stoplight":"123"},"238acba433599",["124","125","126"],[],{"type":"127","properties":"128","required":"129","title":"130","$schema":"97","x-stoplight":"131"},"integer","http://json-schema.org/draft-07/schema#",{"id":"132"},"description","in","name","schema","title","string",{"id":"133"},{"id":"134","value":"135","key":"136"},["135"],{"explicitProperties":"137","id":"138"},"example",["139"],{"id":"140"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","141"],{"data":"142","offset":"143"},{"id":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},"object",{"status":"157","message":"158"},["159","160"],"UnauthorizedError",{"id":"161"},"7d2b22c569493","28b4c85b442a2","a077170ead4d3","tag1,tag2","default",["162","163","164"],"8cddbccd0af2a","team-a","15db2ceee39a9","https",{"items":"165","type":"166"},{"description":"167","type":"104","title":"168"},"0116efa6162c6","38d87442d8340","DuplicateApiKey",{"message":"148","status":401},"Duplicate API key found","78f96a2a2791f","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","629d016184a7b","NoAPIKey",{"message":"169","status":401},"No API key found",{"type":"96"},{"type":"104"},"status","message","470b68e5f0549","type","nullable","examples",{"description":"170","properties":"171","type":"127","title":"172","examples":"173"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","No API key found in request","The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets). So for example an upstream named `service.v1.xyz` for a Service object whose `host` is `service.v1.xyz`. Requests for this Service would be proxied to the targets defined within the upstream. An upstream also includes a [health checker][healthchecks], which is able to enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.",{"algorithm":"174","client_certificate":"175","created_at":"176","hash_fallback":"177","hash_fallback_header":"178","hash_fallback_query_arg":"179","hash_fallback_uri_capture":"180","hash_on":"181","hash_on_cookie":"182","hash_on_cookie_path":"183","hash_on_header":"184","hash_on_query_arg":"185","hash_on_uri_capture":"186","healthchecks":"187","host_header":"188","id":"189","name":"190","slots":"191","tags":"192","updated_at":"193","use_srv_name":"194"},"Upstream",["195"],{"description":"196","type":"197","default":"198","enum":"199"},{"additionalProperties":false,"description":"200","properties":"201","type":"127"},{"description":"202","type":"96"},{"default":"203","description":"204","type":"104"},{"description":"205","type":"104"},{"description":"206","type":"104"},{"description":"207","type":"104"},{"default":"203","description":"208","type":"104"},{"description":"209","type":"104"},{"default":"115","description":"210","type":"104"},{"description":"211","type":"104"},{"description":"212","type":"104"},{"description":"213","type":"104"},{"properties":"214","type":"127"},{"description":"215","type":"104"},{"type":"104"},{"description":"216","type":"104"},{"default":10000,"description":"217","type":"96"},{"description":"218","items":"219","type":"166"},{"description":"220","type":"96"},{"default":false,"description":"221","type":"222"},{"algorithm":"198","hash_fallback":"203","hash_on":"203","hash_on_cookie_path":"115","healthchecks":"223","id":"224","name":"225","slots":10000},"Which load balancing algorithm to use.",["104","226"],"round-robin",["227","228","198","229",null],"If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"230"},"Unix epoch when the resource was created.","none","What to use as hashing input if the primary `hash_on` does not return a hash (eg. header is missing, or no Consumer identified). Not available if `hash_on` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_fallback` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_fallback` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_fallback` is set to `uri_capture`.","What to use as hashing input. Using `none` results in a weighted-round-robin scheme with no hashing.","The cookie name to take the value from as hash input. Only required when `hash_on` or `hash_fallback` is set to `cookie`. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.","The cookie path to set in the response headers. Only required when `hash_on` or `hash_fallback` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_on` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_on` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_on` is set to `uri_capture`.",{"active":"231","passive":"232","threshold":"233"},"The hostname to be used as `Host` header when proxying requests through Kong.","This is a hostname, which must be equal to the `host` of a Service.","The number of slots in the load balancer algorithm. If `algorithm` is set to `round-robin`, this setting determines the maximum number of slots. If `algorithm` is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range `10`-`65536`.","An optional set of strings associated with the Upstream for grouping and filtering.",{"type":"104"},"Unix epoch when the resource was last updated.","If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream `Host`.","boolean",{"active":"234","passive":"235","threshold":0},"6eed5e9c-5398-4026-9a4c-d48f18a2431e","api.example.internal","null","consistent-hashing","least-connections","latency",{"type":"104"},{"properties":"236","type":"127"},{"properties":"237","type":"127"},{"default":0,"type":"238"},{"concurrency":10,"healthy":"239","http_path":"115","https_verify_certificate":true,"timeout":1,"type":"119","unhealthy":"240"},{"healthy":"241","type":"119","unhealthy":"242"},{"concurrency":"243","headers":"244","healthy":"245","http_path":"246","https_sni":"247","https_verify_certificate":"248","timeout":"249","type":"250","unhealthy":"251"},{"healthy":"252","type":"253","unhealthy":"254"},"number",{"http_statuses":"255","interval":0,"successes":0},{"http_failures":0,"http_statuses":"256","interval":0,"tcp_failures":0,"timeouts":0},{"http_statuses":"257","successes":0},{"http_failures":0,"http_statuses":"258","tcp_failures":0,"timeouts":0},{"default":10,"type":"96"},{"type":"127"},{"properties":"259","type":"127"},{"default":"115","type":"104"},{"type":"104"},{"default":true,"type":"222"},{"default":1,"type":"238"},{"default":"119","type":"104"},{"properties":"260","type":"127"},{"properties":"261","type":"127"},{"default":"119","type":"104"},{"properties":"262","type":"127"},[200,302],[429,404,500,501,502,503,504,505],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],{"http_statuses":"263","interval":"264","successes":"265"},{"http_failures":"266","http_statuses":"267","interval":"268","tcp_failures":"269","timeouts":"270"},{"http_statuses":"271","successes":"272"},{"http_failures":"273","http_statuses":"274","tcp_failures":"275","timeouts":"276"},{"default":"277","items":"278","type":"166"},{"default":0,"type":"238"},{"default":0,"type":"96"},{"default":0,"type":"96"},{"default":"279","items":"280","type":"166"},{"default":0,"type":"238"},{"default":0,"type":"96"},{"default":0,"type":"96"},{"default":"281","items":"282","type":"166"},{"default":0,"type":"96"},{"default":0,"type":"96"},{"default":"283","items":"284","type":"166"},{"default":0,"type":"96"},{"default":0,"type":"96"},[200,302],{"type":"96"},[429,404,500,501,502,503,504,505],{"type":"96"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"96"},[429,500,503],{"type":"96"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-upstream-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new Upstream in a workspace",["17"],"ed554154e755b","post","/{workspace}/upstreams",["18"],{},"create-upstream-in-workspace","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Upstreams",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48"],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"2a5a4b1190f40","a9c27991fc8ab","200",[],["55"],"Successfully created Upstream","d1e27b57a5bd4","400",[],["56"],"Invalid Upstream","d1f27b57a59a3","401",[],["57"],"Unauthorized","26fa59228678c",["58"],"The request object for creating a new upstream.",{"id":"59","name":"60","style":"61","examples":"62","description":"63","required":true,"schema":"64","explicitProperties":"65"},{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},{"id":"86","mediaType":"78","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"78","examples":"91","encodings":"92","schema":"93"},"9a07152275bd1","workspace","simple",[],"Name or ID of workspace",{"type":"94","examples":"95","$schema":"96","x-stoplight":"97"},["98","99","100","101","102","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111","enum":"112"},"19bb4e920d1c0","application/json",["113"],[],{"description":"114","properties":"115","type":"116","title":"117","examples":"118"},"ca58763aa9cc0",[],[],{"type":"116","$schema":"96","x-stoplight":"119"},"4e1864d513df5",["120","121","122"],[],{"type":"116","properties":"123","required":"124","title":"125","$schema":"96","x-stoplight":"126"},"3dac805220496",["127","128"],[],{"type":"116","x-examples":"129","properties":"130","required":"131","$schema":"96","x-stoplight":"132"},"string",["133"],"http://json-schema.org/draft-07/schema#",{"id":"134"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["110","135"],{"id":"136","value":"137","key":"138"},"The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets). So for example an upstream named `service.v1.xyz` for a Service object whose `host` is `service.v1.xyz`. Requests for this Service would be proxied to the targets defined within the upstream. An upstream also includes a [health checker][healthchecks], which is able to enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.",{"algorithm":"139","client_certificate":"140","created_at":"141","hash_fallback":"142","hash_fallback_header":"143","hash_fallback_query_arg":"144","hash_fallback_uri_capture":"145","hash_on":"146","hash_on_cookie":"147","hash_on_cookie_path":"148","hash_on_header":"149","hash_on_query_arg":"150","hash_on_uri_capture":"151","healthchecks":"152","host_header":"153","id":"154","name":"155","slots":"156","tags":"157","updated_at":"158","use_srv_name":"159"},"object","Upstream",["137"],{"id":"160"},{"id":"161","key":"162","value":"163","summary":"164"},{"id":"165","key":"166","value":"167","summary":"168"},{"id":"169","key":"170","value":"171","summary":"172"},{"status":"173","message":"174"},["175","176"],"UnauthorizedError",{"id":"177"},{"id":"178","key":"117","value":"179"},{"id":"180","key":"181","value":"182"},{"Example 1":"183"},{"name":"184","algorithm":"185","hash_on":"186","hash_fallback":"187","hash_on_header":"188","hash_fallback_header":"189","hash_on_cookie":"190","hash_on_cookie_path":"191","hash_on_query_arg":"192","hash_fallback_query_arg":"193","hash_on_uri_capture":"194","hash_fallback_uri_capture":"195","slots":"196","healthchecks":"197","tags":"198","host_header":"199","client_certificate":"200","use_srv_name":"201"},["98"],{"id":"202"},"team-a","512f99ee08ceb","https","ba369cebd2747",{"algorithm":"203","hash_fallback":"204","hash_on":"204","hash_on_cookie_path":"106","healthchecks":"205","id":"206","name":"207","slots":10000},"default",{"description":"208","type":"209","default":"203","enum":"210"},{"additionalProperties":false,"description":"211","properties":"212","type":"116"},{"description":"213","type":"214"},{"default":"204","description":"215","type":"94"},{"description":"216","type":"94"},{"description":"217","type":"94"},{"description":"218","type":"94"},{"default":"204","description":"219","type":"94"},{"description":"220","type":"94"},{"default":"106","description":"221","type":"94"},{"description":"222","type":"94"},{"description":"223","type":"94"},{"description":"224","type":"94"},{"properties":"225","type":"116"},{"description":"226","type":"94"},{"type":"94"},{"description":"227","type":"94"},{"default":10000,"description":"228","type":"214"},{"description":"229","items":"230","type":"231"},{"description":"232","type":"214"},{"default":false,"description":"233","type":"234"},"b72e553484963","3787d44f559a6","DuplicateApiKey",{"message":"164","status":401},"Duplicate API key found","68ab60779e11a","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","088a5e15381a5","NoAPIKey",{"message":"235","status":401},"No API key found",{"type":"214"},{"type":"94"},"status","message","470b68e5f0549","0f356591ee7f0",{"name":"236","algorithm":"203","hash_on":"204","hash_fallback":"204","hash_on_cookie_path":"106","slots":10000,"healthchecks":"237","tags":"238","host_header":"239","client_certificate":"240","use_srv_name":false},"3f86340f0d8cb","Example request",{"name":"236","tags":"241","algorithm":"203"},{"id":"242","created_at":1422386534,"name":"236","algorithm":"203","hash_on":"204","hash_fallback":"204","hash_on_cookie_path":"106","slots":10000,"healthchecks":"243","tags":"244","host_header":"239","client_certificate":"245","use_srv_name":false},{"type":"94","description":"246","examples":"247"},{"type":"94","description":"248","enum":"249","default":"203","examples":"250"},{"type":"94","description":"251","default":"204","enum":"252"},{"type":"94","description":"253","default":"204","enum":"254","examples":"255"},{"type":"94","description":"256","examples":"257"},{"type":"94","description":"258","default":"204","examples":"259"},{"type":"94","description":"220","examples":"260"},{"type":"94","description":"221","default":"106","examples":"261"},{"type":"94","description":"223","examples":"262"},{"type":"94","description":"217","examples":"263"},{"type":"94","description":"224","examples":"264"},{"type":"94","description":"218","examples":"265"},{"type":"214","description":"266","minimum":10,"maximum":65536,"default":10000,"examples":"267"},{"type":"116","properties":"268"},{"type":"231","description":"229","items":"269","examples":"270"},{"type":"94","description":"271"},{"type":"116","description":"211","properties":"272"},{"type":"234","description":"273","examples":"274"},"1d11995efa499","round-robin","none",{"active":"275","passive":"276","threshold":0},"6eed5e9c-5398-4026-9a4c-d48f18a2431e","api.example.internal","Which load balancing algorithm to use.",["94","277"],["278","279","203","280",null],"If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"281"},"Unix epoch when the resource was created.","integer","What to use as hashing input if the primary `hash_on` does not return a hash (eg. header is missing, or no Consumer identified). Not available if `hash_on` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_fallback` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_fallback` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_fallback` is set to `uri_capture`.","What to use as hashing input. Using `none` results in a weighted-round-robin scheme with no hashing.","The cookie name to take the value from as hash input. Only required when `hash_on` or `hash_fallback` is set to `cookie`. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.","The cookie path to set in the response headers. Only required when `hash_on` or `hash_fallback` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_on` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_on` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_on` is set to `uri_capture`.",{"active":"282","passive":"283","threshold":"284"},"The hostname to be used as `Host` header when proxying requests through Kong.","This is a hostname, which must be equal to the `host` of a Service.","The number of slots in the load balancer algorithm. If `algorithm` is set to `round-robin`, this setting determines the maximum number of slots. If `algorithm` is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range `10`-`65536`.","An optional set of strings associated with the Upstream for grouping and filtering.",{"type":"94"},"array","Unix epoch when the resource was last updated.","If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream `Host`.","boolean","No API key found in request","my-upstream",{"passive":"285","active":"286","threshold":0},["287","288"],"example.com",{"id":"289"},["287","288"],"58c8ccbb-eafb-4566-991f-2ed4f678fa70",{"passive":"290","active":"291","threshold":0},["287","288"],{"id":"289"},"This is a hostname, which must be equal to the `host` of a service.",["236"],"Which load balancing algorithm to use.\n",["278","279","203","280"],["203"],"What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing",["204","292","293","294","295","296","297"],"What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie.",["204","292","293","294","295","296","297"],["204"],"The header name to take the value from as hash input. Only required when `hash_on` is set to header.",["204"],"The header name to take the value from as hash input. Only required when hash_fallback is set to header.",["204"],["204"],["106"],["298"],["298"],["298"],["298"],"The number of slots in the load balancer algorithm. If the algorithm is set to `round-robin`, this setting determines the maximum number of slots. If the algorithm is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.",[5000],{"passive":"299","active":"300","threshold":"301"},{"type":"94"},["302"],"The hostname to be used as Host header when proxying requests through Kong.",{"id":"303"},"If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.",[false],{"concurrency":10,"healthy":"304","http_path":"106","https_verify_certificate":true,"timeout":1,"type":"110","unhealthy":"305"},{"healthy":"306","type":"110","unhealthy":"307"},"null","consistent-hashing","least-connections","latency",{"type":"94"},{"properties":"308","type":"116"},{"properties":"309","type":"116"},{"default":0,"type":"310"},{"type":"110","healthy":"311","unhealthy":"312"},{"https_verify_certificate":true,"healthy":"313","unhealthy":"314","type":"110","concurrency":10,"headers":"315","timeout":1,"http_path":"106","https_sni":"239"},"user-level","low-priority","ea29aaa3-3b2d-488c-b90c-56df8e0dd8c6",{"type":"110","healthy":"316","unhealthy":"317"},{"https_verify_certificate":true,"healthy":"318","unhealthy":"319","type":"110","concurrency":10,"headers":"320","timeout":1,"http_path":"106","https_sni":"239"},"consumer","ip","cookie","uri_capture","path","query_arg","hash_value",{"type":"116","properties":"321"},{"type":"116","properties":"322"},{"type":"214","description":"323","minimum":0,"maximum":100,"default":0},["287","288"],{"type":"94","examples":"324"},{"http_statuses":"325","interval":0,"successes":0},{"http_failures":0,"http_statuses":"326","interval":0,"tcp_failures":0,"timeouts":0},{"http_statuses":"327","successes":0},{"http_failures":0,"http_statuses":"328","tcp_failures":0,"timeouts":0},{"concurrency":"329","headers":"330","healthy":"331","http_path":"332","https_sni":"333","https_verify_certificate":"334","timeout":"335","type":"336","unhealthy":"337"},{"healthy":"338","type":"339","unhealthy":"340"},"number",{"http_statuses":"341","successes":0},{"http_statuses":"342","timeouts":0,"http_failures":0,"tcp_failures":0},{"http_statuses":"343","successes":0,"interval":0},{"http_failures":0,"http_statuses":"344","timeouts":0,"tcp_failures":0,"interval":0},{"type":"116","properties":"345"},{"http_statuses":"346","successes":0},{"http_statuses":"347","timeouts":0,"http_failures":0,"tcp_failures":0},{"http_statuses":"348","successes":0,"interval":0},{"http_failures":0,"http_statuses":"349","timeouts":0,"tcp_failures":0,"interval":0},["350"],{"type":"351","healthy":"352","unhealthy":"353"},{"https_verify_certificate":"354","healthy":"355","unhealthy":"356","type":"357","concurrency":"358","headers":"359","timeout":"360","http_path":"361","https_sni":"362"},"The minimum percentage of the upstream's targets' weight that must be available for the whole upstream to be considered healthy.",["289"],[200,302],[429,404,500,501,502,503,504,505],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],{"default":10,"type":"214"},{"type":"116"},{"properties":"363","type":"116"},{"default":"106","type":"94"},{"type":"94"},{"default":true,"type":"234"},{"default":1,"type":"310"},{"default":"110","type":"94"},{"properties":"364","type":"116"},{"properties":"365","type":"116"},{"default":"110","type":"94"},{"properties":"366","type":"116"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],[200,302],[429,404,500,501,502,503,504,505],{"x-my-header":"367","x-another-header":"368"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],[200,302],[429,404,500,501,502,503,504,505],{"x-my-header":"369","x-another-header":"370"},{"type":"94","description":"371","default":"110","enum":"372","examples":"373"},{"type":"116","properties":"374"},{"type":"116","properties":"375"},{"type":"234"},{"type":"116","properties":"376"},{"type":"116","properties":"377"},{"type":"94","description":"378","enum":"379","default":"110","examples":"380"},{"type":"214","description":"381","default":10,"examples":"382"},{"type":"116","description":"383","examples":"384"},{"type":"214","description":"385","default":1,"examples":"386"},{"type":"94","description":"387","default":"106"},{"type":"94","description":"388"},{"http_statuses":"389","interval":"390","successes":"391"},{"http_failures":"392","http_statuses":"393","interval":"394","tcp_failures":"395","timeouts":"396"},{"http_statuses":"397","successes":"398"},{"http_failures":"399","http_statuses":"400","tcp_failures":"401","timeouts":"402"},{"type":"231","items":"403","description":"404"},{"type":"231","items":"405","description":"406"},["407","408"],["409"],"Whether to perform passive health checks interpreting HTTP/HTTPS statuses, or just check for TCP connection success. In passive checks, http and https options are equivalent. Accepted values are `tcp`, `http`, `https`, `grpc`, `grpcs`.",["410","110","135","411","412"],["410"],{"http_statuses":"413","successes":"414"},{"http_statuses":"415","timeouts":"416","http_failures":"417","tcp_failures":"418"},{"http_statuses":"419","successes":"420","interval":"421"},{"http_failures":"422","http_statuses":"423","timeouts":"424","tcp_failures":"425","interval":"426"},"Whether to perform active health checks using HTTP or HTTPS, or just attempt a TCP connection.",["410","110","135","411","412"],["135"],"Number of targets to check concurrently in active health checks.",[5],"One or more lists of values indexed by header name to use in GET HTTP request to run as a probe on active health checks. Values must be pre-formatted.",["427"],"Socket timeout for active health checks (in seconds).",[5],"Path to use in GET HTTP request to run as a probe on active health checks.","The hostname to use as an SNI (Server Name Identification) when performing active health checks using HTTPS. This is particularly useful when Targets are configured using IPs, so that the target host's certificate can be verified with the proper SNI.",{"default":"428","items":"429","type":"231"},{"default":0,"type":"310"},{"default":0,"type":"214"},{"default":0,"type":"214"},{"default":"430","items":"431","type":"231"},{"default":0,"type":"310"},{"default":0,"type":"214"},{"default":0,"type":"214"},{"default":"432","items":"433","type":"231"},{"default":0,"type":"214"},{"default":0,"type":"214"},{"default":"434","items":"435","type":"231"},{"default":0,"type":"214"},{"default":0,"type":"214"},{"type":"94"},"The value(s) of the x-my-header header.",{"type":"94"},"The value(s) of the x-another-header header.","foo","bar","bla","tcp","grpc","grpcs",{"type":"231","description":"436","default":"437","items":"438","examples":"439"},{"type":"214","description":"440","default":0,"examples":"441"},{"type":"231","description":"442","default":"443","items":"444","examples":"445"},{"type":"214","description":"446","default":0,"examples":"447"},{"type":"214","description":"448","default":0,"examples":"449"},{"type":"214","description":"450","default":0,"examples":"451"},{"type":"231","description":"452","default":"453","items":"454","examples":"455"},{"type":"214","description":"456","default":0,"examples":"457"},{"type":"214","description":"458","default":0,"examples":"459"},{"type":"214","description":"460","default":0,"examples":"461"},{"type":"231","description":"462","default":"463","items":"464","examples":"465"},{"type":"214","description":"466","default":0,"examples":"467"},{"type":"214","description":"468","default":0,"examples":"469"},{"type":"214","description":"470","default":0,"examples":"471"},{"x-my-header":"472","x-another-header":"473"},[200,302],{"type":"214"},[429,404,500,501,502,503,504,505],{"type":"214"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"214"},[429,500,503],{"type":"214"},"An array of HTTP statuses which represent healthiness when produced by proxied traffic, as observed by passive health checks. With form-encoded, the notation is `http_statuses[]=200&http_statuses[]=201`. With JSON, use an array.",[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"214","enum":"474"},["475"],"Number of successes in proxied traffic (as defined by `healthchecks.passive.healthy.http_statuses`) to consider a target healthy, as observed by passive health checks.",[2],"An array of HTTP statuses which represent unhealthiness when produced by proxied traffic, as observed by passive health checks. With form-encoded, the notation is `http_statuses[]=429&http_statuses[]=500`. With JSON, use an array.",[429,500,503],{"type":"214","enum":"476"},["477"],"Number of timeouts in proxied traffic to consider a target unhealthy, as observed by passive health checks.",[1],"Number of HTTP failures in proxied traffic (as defined by `healthchecks.passive.unhealthy.http_statuses`) to consider a target unhealthy, as observed by passive health checks.",[3],"Number of TCP connection failures to consider a target unhealthy, as observed by passive health checks.",[1],"An array of HTTP statuses to consider a success, indicating healthiness, when returned by a probe in active health checks. With form-encoded, the notation is `http_statuses[]=200&http_statuses[]=302`. With JSON, use an array.",[200,302],{"type":"214"},["478"],"Number of successes in active probes (as defined by `healthchecks.active.healthy.http_statuses`) to consider a target healthy.",[3],"Interval between active health checks for healthy targets (in seconds). A value of zero indicates that active probes for healthy targets should not be performed.",[30],"Number of HTTP failures in active probes (as defined by `healthchecks.active.unhealthy.http_statuses`) to consider a target unhealthy.",[2],"An array of HTTP statuses to consider a failure, indicating unhealthiness, when returned by a probe in active health checks. With form-encoded, the notation is `http_statuses[]=429&http_statuses[]=404`. With JSON, use an array.",[429,404,500,501,502,503,504,505],{"type":"214"},["479"],"Number of timeouts in active probes to consider a target unhealthy.",[2],"Number of TCP failures in active probes to consider a target unhealthy.",[1],"Interval between active health checks for unhealthy targets (in seconds). A value of zero indicates that active probes for unhealthy targets should not be performed.",[10],["407","408"],["409"],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[200,201,202],[429,500,503],[500,503],[200,201],[400,404]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-upstream-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete an Upstream in a workspace",["17"],"32bb64ce3642d","delete","/{workspace}/upstreams/{upstream_id_or_name}",["18"],{},"delete-upstream-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Upstreams",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38","39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"2a5a4b1190f40","58bd46a760b01","204",[],[],"Successfully deleted Upstream or the resource didn't exist","b08d488422a06","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","name":"55","style":"49","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","key":"61","extensions":"62","description":"63","type":"64","name":"65","in":"66"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"67","path":"68","port":"69","protocol":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},"38ef98dae7dea","workspace","simple",[],"Name or ID of workspace",{"type":"76","examples":"77","$schema":"78","x-stoplight":"79"},["80","81","82","83","84","85"],"2b24cea591224","upstream_id_or_name",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"76","examples":"86","$schema":"78","x-stoplight":"87"},["80","81","82","83","84","85"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95","enum":"96"},"23dea961b2a68","application/json",["97","98","99"],[],{"type":"100","properties":"101","required":"102","title":"103","$schema":"78","x-stoplight":"104"},"string",["105"],"http://json-schema.org/draft-07/schema#",{"id":"106"},"name","in","required","schema","description","title",["107"],{"id":"108"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["94","109"],{"id":"110","key":"111","value":"112","summary":"113"},{"id":"114","key":"115","value":"116","summary":"117"},{"id":"118","key":"119","value":"120","summary":"121"},"object",{"status":"122","message":"123"},["124","125"],"UnauthorizedError",{"id":"126"},"team-a","acdd254cc512a","7fca84d6-7d37-4a74-a7b0-93e576089a41","bf655842d32e0","https","15b22af78c0f8","DuplicateApiKey",{"message":"113","status":401},"Duplicate API key found","4941c71544015","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","ae6d6dd58505f","NoAPIKey",{"message":"127","status":401},"No API key found",{"type":"128"},{"type":"76"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-upstream-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch an Upstream in a workspace",["18"],"410dee4eb3e82","get","/{workspace}/upstreams/{upstream_id_or_name}",["19"],{},"get-upstream-in-workspace","Get an Upstream using ID or name in a workspace.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Upstreams",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46"],["47"],{"id":"48","url":"49","name":"50","description":"51","variables":"52"},"2a5a4b1190f40","e5e7afb9a0264","200",[],["53"],"Successfully fetched Upstream","7b37b04b0fc69","401",[],["54"],"Unauthorized","7b07b04b0f986","404",[],[],"Resource does not exist",{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"57","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"810d889db251a","workspace","simple",[],"Name or ID of workspace",{"type":"88","examples":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96","97"],"2d2da515b1539","upstream_id_or_name",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"88","examples":"98","$schema":"90","x-stoplight":"99"},["92","93","94","95","96","97"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107","enum":"108"},"dd10680984f05","application/json",["109"],[],{"description":"110","properties":"111","type":"112","title":"113","examples":"114"},"767aaa891bf78",["115","116","117"],[],{"type":"112","properties":"118","required":"119","title":"120","$schema":"90","x-stoplight":"121"},"string",["122"],"http://json-schema.org/draft-07/schema#",{"id":"123"},"name","in","required","schema","description","title",["124"],{"id":"125"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["106","126"],{"id":"127","value":"128","key":"129"},"The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets). So for example an upstream named `service.v1.xyz` for a Service object whose `host` is `service.v1.xyz`. Requests for this Service would be proxied to the targets defined within the upstream. An upstream also includes a [health checker][healthchecks], which is able to enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.",{"algorithm":"130","client_certificate":"131","created_at":"132","hash_fallback":"133","hash_fallback_header":"134","hash_fallback_query_arg":"135","hash_fallback_uri_capture":"136","hash_on":"137","hash_on_cookie":"138","hash_on_cookie_path":"139","hash_on_header":"140","hash_on_query_arg":"141","hash_on_uri_capture":"142","healthchecks":"143","host_header":"144","id":"145","name":"146","slots":"147","tags":"148","updated_at":"149","use_srv_name":"150"},"object","Upstream",["128"],{"id":"151","key":"152","value":"153","summary":"154"},{"id":"155","key":"156","value":"157","summary":"158"},{"id":"159","key":"160","value":"161","summary":"162"},{"status":"163","message":"164"},["165","166"],"UnauthorizedError",{"id":"167"},"team-a","4a87b43728f3d","7fca84d6-7d37-4a74-a7b0-93e576089a41","ee05475b88564","https","71848a85c3ac2",{"algorithm":"168","hash_fallback":"169","hash_on":"169","hash_on_cookie_path":"102","healthchecks":"170","id":"171","name":"172","slots":10000},"default",{"description":"173","type":"174","default":"168","enum":"175"},{"additionalProperties":false,"description":"176","properties":"177","type":"112"},{"description":"178","type":"179"},{"default":"169","description":"180","type":"88"},{"description":"181","type":"88"},{"description":"182","type":"88"},{"description":"183","type":"88"},{"default":"169","description":"184","type":"88"},{"description":"185","type":"88"},{"default":"102","description":"186","type":"88"},{"description":"187","type":"88"},{"description":"188","type":"88"},{"description":"189","type":"88"},{"properties":"190","type":"112"},{"description":"191","type":"88"},{"type":"88"},{"description":"192","type":"88"},{"default":10000,"description":"193","type":"179"},{"description":"194","items":"195","type":"196"},{"description":"197","type":"179"},{"default":false,"description":"198","type":"199"},"7470b6a030387","DuplicateApiKey",{"message":"154","status":401},"Duplicate API key found","9b8fc88681bf4","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","9c8f219fbfe40","NoAPIKey",{"message":"200","status":401},"No API key found",{"type":"179"},{"type":"88"},"status","message","470b68e5f0549","round-robin","none",{"active":"201","passive":"202","threshold":0},"6eed5e9c-5398-4026-9a4c-d48f18a2431e","api.example.internal","Which load balancing algorithm to use.",["88","203"],["204","205","168","206",null],"If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"207"},"Unix epoch when the resource was created.","integer","What to use as hashing input if the primary `hash_on` does not return a hash (eg. header is missing, or no Consumer identified). Not available if `hash_on` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_fallback` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_fallback` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_fallback` is set to `uri_capture`.","What to use as hashing input. Using `none` results in a weighted-round-robin scheme with no hashing.","The cookie name to take the value from as hash input. Only required when `hash_on` or `hash_fallback` is set to `cookie`. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.","The cookie path to set in the response headers. Only required when `hash_on` or `hash_fallback` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_on` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_on` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_on` is set to `uri_capture`.",{"active":"208","passive":"209","threshold":"210"},"The hostname to be used as `Host` header when proxying requests through Kong.","This is a hostname, which must be equal to the `host` of a Service.","The number of slots in the load balancer algorithm. If `algorithm` is set to `round-robin`, this setting determines the maximum number of slots. If `algorithm` is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range `10`-`65536`.","An optional set of strings associated with the Upstream for grouping and filtering.",{"type":"88"},"array","Unix epoch when the resource was last updated.","If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream `Host`.","boolean","No API key found in request",{"concurrency":10,"healthy":"211","http_path":"102","https_verify_certificate":true,"timeout":1,"type":"106","unhealthy":"212"},{"healthy":"213","type":"106","unhealthy":"214"},"null","consistent-hashing","least-connections","latency",{"type":"88"},{"properties":"215","type":"112"},{"properties":"216","type":"112"},{"default":0,"type":"217"},{"http_statuses":"218","interval":0,"successes":0},{"http_failures":0,"http_statuses":"219","interval":0,"tcp_failures":0,"timeouts":0},{"http_statuses":"220","successes":0},{"http_failures":0,"http_statuses":"221","tcp_failures":0,"timeouts":0},{"concurrency":"222","headers":"223","healthy":"224","http_path":"225","https_sni":"226","https_verify_certificate":"227","timeout":"228","type":"229","unhealthy":"230"},{"healthy":"231","type":"232","unhealthy":"233"},"number",[200,302],[429,404,500,501,502,503,504,505],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],{"default":10,"type":"179"},{"type":"112"},{"properties":"234","type":"112"},{"default":"102","type":"88"},{"type":"88"},{"default":true,"type":"199"},{"default":1,"type":"217"},{"default":"106","type":"88"},{"properties":"235","type":"112"},{"properties":"236","type":"112"},{"default":"106","type":"88"},{"properties":"237","type":"112"},{"http_statuses":"238","interval":"239","successes":"240"},{"http_failures":"241","http_statuses":"242","interval":"243","tcp_failures":"244","timeouts":"245"},{"http_statuses":"246","successes":"247"},{"http_failures":"248","http_statuses":"249","tcp_failures":"250","timeouts":"251"},{"default":"252","items":"253","type":"196"},{"default":0,"type":"217"},{"default":0,"type":"179"},{"default":0,"type":"179"},{"default":"254","items":"255","type":"196"},{"default":0,"type":"217"},{"default":0,"type":"179"},{"default":0,"type":"179"},{"default":"256","items":"257","type":"196"},{"default":0,"type":"179"},{"default":0,"type":"179"},{"default":"258","items":"259","type":"196"},{"default":0,"type":"179"},{"default":0,"type":"179"},[200,302],{"type":"179"},[429,404,500,501,502,503,504,505],{"type":"179"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"179"},[429,500,503],{"type":"179"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-upstream-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update an Upstream in a workspace",["17"],"c2a0ac6377280","patch","/{workspace}/upstreams/{upstream_id_or_name}",["18"],{},"update-upstream-in-workspace","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Upstreams",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54","55"],["56"],{"id":"57","url":"58","name":"59","description":"60","variables":"61"},"2a5a4b1190f40","f64b6595206c3","200",[],["62"],"Successfully updated Upstream","8bab662690a91","400",[],["63"],"Invalid Upstream","8bbb662690862","401",[],["64"],"Unauthorized","8b6b66268f1dd","404",[],[],"Resource does not exist","60802b631b3c2",["65"],"The request object for creating a new upstream.",{"id":"66","name":"67","style":"68","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","name":"74","style":"68","examples":"75","description":"76","required":true,"schema":"77","explicitProperties":"78"},{"id":"79","key":"80","extensions":"81","description":"82","type":"83","name":"84","in":"85"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"86","path":"87","port":"88","protocol":"89"},{"id":"90","mediaType":"91","examples":"92","encodings":"93","schema":"94"},{"id":"95","mediaType":"91","examples":"96","encodings":"97","schema":"98"},{"id":"99","mediaType":"91","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"91","examples":"104","encodings":"105","schema":"106"},"e7e85ee9d8ee8","workspace","simple",[],"Name or ID of workspace",{"type":"107","examples":"108","$schema":"109","x-stoplight":"110"},["111","112","113","114","115","116"],"d2b58326d16f3","upstream_id_or_name",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"107","examples":"117","$schema":"109","x-stoplight":"118"},["111","112","113","114","115","116"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"119","description":"120"},{"default":"121","description":"122"},{"default":"123","description":"124"},{"default":"125","description":"126","enum":"127"},"c4dfbdead9d99","application/json",["128"],[],{"description":"129","properties":"130","type":"131","title":"132","examples":"133"},"2834886d9af2b",[],[],{"type":"131","$schema":"109","x-stoplight":"134"},"aa65d1940b091",["135","136","137"],[],{"type":"131","properties":"138","required":"139","title":"140","$schema":"109","x-stoplight":"141"},"19106b37d47cf",["142","143"],[],{"type":"131","x-examples":"144","properties":"145","required":"146","$schema":"109","x-stoplight":"147"},"string",["148"],"http://json-schema.org/draft-07/schema#",{"id":"149"},"name","in","required","schema","description","title",["150"],{"id":"151"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["125","152"],{"id":"153","value":"154","key":"155"},"The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets). So for example an upstream named `service.v1.xyz` for a Service object whose `host` is `service.v1.xyz`. Requests for this Service would be proxied to the targets defined within the upstream. An upstream also includes a [health checker][healthchecks], which is able to enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.",{"algorithm":"156","client_certificate":"157","created_at":"158","hash_fallback":"159","hash_fallback_header":"160","hash_fallback_query_arg":"161","hash_fallback_uri_capture":"162","hash_on":"163","hash_on_cookie":"164","hash_on_cookie_path":"165","hash_on_header":"166","hash_on_query_arg":"167","hash_on_uri_capture":"168","healthchecks":"169","host_header":"170","id":"171","name":"172","slots":"173","tags":"174","updated_at":"175","use_srv_name":"176"},"object","Upstream",["154"],{"id":"177"},{"id":"178","key":"179","value":"180","summary":"181"},{"id":"182","key":"183","value":"184","summary":"185"},{"id":"186","key":"187","value":"188","summary":"189"},{"status":"190","message":"191"},["192","193"],"UnauthorizedError",{"id":"194"},{"id":"195","key":"132","value":"196"},{"id":"197","key":"198","value":"199"},{"Example 1":"200"},{"name":"201","algorithm":"202","hash_on":"203","hash_fallback":"204","hash_on_header":"205","hash_fallback_header":"206","hash_on_cookie":"207","hash_on_cookie_path":"208","hash_on_query_arg":"209","hash_fallback_query_arg":"210","hash_on_uri_capture":"211","hash_fallback_uri_capture":"212","slots":"213","healthchecks":"214","tags":"215","host_header":"216","client_certificate":"217","use_srv_name":"218"},["111"],{"id":"219"},"team-a","9910d7d7a98f3","7fca84d6-7d37-4a74-a7b0-93e576089a41","493a91b498823","https","fca9b309d481f",{"algorithm":"220","hash_fallback":"221","hash_on":"221","hash_on_cookie_path":"121","healthchecks":"222","id":"223","name":"224","slots":10000},"default",{"description":"225","type":"226","default":"220","enum":"227"},{"additionalProperties":false,"description":"228","properties":"229","type":"131"},{"description":"230","type":"231"},{"default":"221","description":"232","type":"107"},{"description":"233","type":"107"},{"description":"234","type":"107"},{"description":"235","type":"107"},{"default":"221","description":"236","type":"107"},{"description":"237","type":"107"},{"default":"121","description":"238","type":"107"},{"description":"239","type":"107"},{"description":"240","type":"107"},{"description":"241","type":"107"},{"properties":"242","type":"131"},{"description":"243","type":"107"},{"type":"107"},{"description":"244","type":"107"},{"default":10000,"description":"245","type":"231"},{"description":"246","items":"247","type":"248"},{"description":"249","type":"231"},{"default":false,"description":"250","type":"251"},"08889aa8613df","bae21f60b9eea","DuplicateApiKey",{"message":"181","status":401},"Duplicate API key found","3b8642926da3e","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","c35094c044766","NoAPIKey",{"message":"252","status":401},"No API key found",{"type":"231"},{"type":"107"},"status","message","470b68e5f0549","64774566b2fac",{"name":"253","algorithm":"220","hash_on":"221","hash_fallback":"221","hash_on_cookie_path":"121","slots":10000,"healthchecks":"254","tags":"255","host_header":"256","client_certificate":"257","use_srv_name":false},"d9c3a3c7b98db","Example request",{"name":"253","tags":"258","algorithm":"220"},{"id":"259","created_at":1422386534,"name":"253","algorithm":"220","hash_on":"221","hash_fallback":"221","hash_on_cookie_path":"121","slots":10000,"healthchecks":"260","tags":"261","host_header":"256","client_certificate":"262","use_srv_name":false},{"type":"107","description":"263","examples":"264"},{"type":"107","description":"265","enum":"266","default":"220","examples":"267"},{"type":"107","description":"268","default":"221","enum":"269"},{"type":"107","description":"270","default":"221","enum":"271","examples":"272"},{"type":"107","description":"273","examples":"274"},{"type":"107","description":"275","default":"221","examples":"276"},{"type":"107","description":"237","examples":"277"},{"type":"107","description":"238","default":"121","examples":"278"},{"type":"107","description":"240","examples":"279"},{"type":"107","description":"234","examples":"280"},{"type":"107","description":"241","examples":"281"},{"type":"107","description":"235","examples":"282"},{"type":"231","description":"283","minimum":10,"maximum":65536,"default":10000,"examples":"284"},{"type":"131","properties":"285"},{"type":"248","description":"246","items":"286","examples":"287"},{"type":"107","description":"288"},{"type":"131","description":"228","properties":"289"},{"type":"251","description":"290","examples":"291"},"1d11995efa499","round-robin","none",{"active":"292","passive":"293","threshold":0},"6eed5e9c-5398-4026-9a4c-d48f18a2431e","api.example.internal","Which load balancing algorithm to use.",["107","294"],["295","296","220","297",null],"If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"298"},"Unix epoch when the resource was created.","integer","What to use as hashing input if the primary `hash_on` does not return a hash (eg. header is missing, or no Consumer identified). Not available if `hash_on` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_fallback` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_fallback` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_fallback` is set to `uri_capture`.","What to use as hashing input. Using `none` results in a weighted-round-robin scheme with no hashing.","The cookie name to take the value from as hash input. Only required when `hash_on` or `hash_fallback` is set to `cookie`. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.","The cookie path to set in the response headers. Only required when `hash_on` or `hash_fallback` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_on` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_on` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_on` is set to `uri_capture`.",{"active":"299","passive":"300","threshold":"301"},"The hostname to be used as `Host` header when proxying requests through Kong.","This is a hostname, which must be equal to the `host` of a Service.","The number of slots in the load balancer algorithm. If `algorithm` is set to `round-robin`, this setting determines the maximum number of slots. If `algorithm` is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range `10`-`65536`.","An optional set of strings associated with the Upstream for grouping and filtering.",{"type":"107"},"array","Unix epoch when the resource was last updated.","If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream `Host`.","boolean","No API key found in request","my-upstream",{"passive":"302","active":"303","threshold":0},["304","305"],"example.com",{"id":"306"},["304","305"],"58c8ccbb-eafb-4566-991f-2ed4f678fa70",{"passive":"307","active":"308","threshold":0},["304","305"],{"id":"306"},"This is a hostname, which must be equal to the `host` of a service.",["253"],"Which load balancing algorithm to use.\n",["295","296","220","297"],["220"],"What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing",["221","309","310","311","312","313","314"],"What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie.",["221","309","310","311","312","313","314"],["221"],"The header name to take the value from as hash input. Only required when `hash_on` is set to header.",["221"],"The header name to take the value from as hash input. Only required when hash_fallback is set to header.",["221"],["221"],["121"],["315"],["315"],["315"],["315"],"The number of slots in the load balancer algorithm. If the algorithm is set to `round-robin`, this setting determines the maximum number of slots. If the algorithm is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.",[5000],{"passive":"316","active":"317","threshold":"318"},{"type":"107"},["319"],"The hostname to be used as Host header when proxying requests through Kong.",{"id":"320"},"If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.",[false],{"concurrency":10,"healthy":"321","http_path":"121","https_verify_certificate":true,"timeout":1,"type":"125","unhealthy":"322"},{"healthy":"323","type":"125","unhealthy":"324"},"null","consistent-hashing","least-connections","latency",{"type":"107"},{"properties":"325","type":"131"},{"properties":"326","type":"131"},{"default":0,"type":"327"},{"type":"125","healthy":"328","unhealthy":"329"},{"https_verify_certificate":true,"healthy":"330","unhealthy":"331","type":"125","concurrency":10,"headers":"332","timeout":1,"http_path":"121","https_sni":"256"},"user-level","low-priority","ea29aaa3-3b2d-488c-b90c-56df8e0dd8c6",{"type":"125","healthy":"333","unhealthy":"334"},{"https_verify_certificate":true,"healthy":"335","unhealthy":"336","type":"125","concurrency":10,"headers":"337","timeout":1,"http_path":"121","https_sni":"256"},"consumer","ip","cookie","uri_capture","path","query_arg","hash_value",{"type":"131","properties":"338"},{"type":"131","properties":"339"},{"type":"231","description":"340","minimum":0,"maximum":100,"default":0},["304","305"],{"type":"107","examples":"341"},{"http_statuses":"342","interval":0,"successes":0},{"http_failures":0,"http_statuses":"343","interval":0,"tcp_failures":0,"timeouts":0},{"http_statuses":"344","successes":0},{"http_failures":0,"http_statuses":"345","tcp_failures":0,"timeouts":0},{"concurrency":"346","headers":"347","healthy":"348","http_path":"349","https_sni":"350","https_verify_certificate":"351","timeout":"352","type":"353","unhealthy":"354"},{"healthy":"355","type":"356","unhealthy":"357"},"number",{"http_statuses":"358","successes":0},{"http_statuses":"359","timeouts":0,"http_failures":0,"tcp_failures":0},{"http_statuses":"360","successes":0,"interval":0},{"http_failures":0,"http_statuses":"361","timeouts":0,"tcp_failures":0,"interval":0},{"type":"131","properties":"362"},{"http_statuses":"363","successes":0},{"http_statuses":"364","timeouts":0,"http_failures":0,"tcp_failures":0},{"http_statuses":"365","successes":0,"interval":0},{"http_failures":0,"http_statuses":"366","timeouts":0,"tcp_failures":0,"interval":0},["367"],{"type":"368","healthy":"369","unhealthy":"370"},{"https_verify_certificate":"371","healthy":"372","unhealthy":"373","type":"374","concurrency":"375","headers":"376","timeout":"377","http_path":"378","https_sni":"379"},"The minimum percentage of the upstream's targets' weight that must be available for the whole upstream to be considered healthy.",["306"],[200,302],[429,404,500,501,502,503,504,505],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],{"default":10,"type":"231"},{"type":"131"},{"properties":"380","type":"131"},{"default":"121","type":"107"},{"type":"107"},{"default":true,"type":"251"},{"default":1,"type":"327"},{"default":"125","type":"107"},{"properties":"381","type":"131"},{"properties":"382","type":"131"},{"default":"125","type":"107"},{"properties":"383","type":"131"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],[200,302],[429,404,500,501,502,503,504,505],{"x-my-header":"384","x-another-header":"385"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],[200,302],[429,404,500,501,502,503,504,505],{"x-my-header":"386","x-another-header":"387"},{"type":"107","description":"388","default":"125","enum":"389","examples":"390"},{"type":"131","properties":"391"},{"type":"131","properties":"392"},{"type":"251"},{"type":"131","properties":"393"},{"type":"131","properties":"394"},{"type":"107","description":"395","enum":"396","default":"125","examples":"397"},{"type":"231","description":"398","default":10,"examples":"399"},{"type":"131","description":"400","examples":"401"},{"type":"231","description":"402","default":1,"examples":"403"},{"type":"107","description":"404","default":"121"},{"type":"107","description":"405"},{"http_statuses":"406","interval":"407","successes":"408"},{"http_failures":"409","http_statuses":"410","interval":"411","tcp_failures":"412","timeouts":"413"},{"http_statuses":"414","successes":"415"},{"http_failures":"416","http_statuses":"417","tcp_failures":"418","timeouts":"419"},{"type":"248","items":"420","description":"421"},{"type":"248","items":"422","description":"423"},["424","425"],["426"],"Whether to perform passive health checks interpreting HTTP/HTTPS statuses, or just check for TCP connection success. In passive checks, http and https options are equivalent. Accepted values are `tcp`, `http`, `https`, `grpc`, `grpcs`.",["427","125","152","428","429"],["427"],{"http_statuses":"430","successes":"431"},{"http_statuses":"432","timeouts":"433","http_failures":"434","tcp_failures":"435"},{"http_statuses":"436","successes":"437","interval":"438"},{"http_failures":"439","http_statuses":"440","timeouts":"441","tcp_failures":"442","interval":"443"},"Whether to perform active health checks using HTTP or HTTPS, or just attempt a TCP connection.",["427","125","152","428","429"],["152"],"Number of targets to check concurrently in active health checks.",[5],"One or more lists of values indexed by header name to use in GET HTTP request to run as a probe on active health checks. Values must be pre-formatted.",["444"],"Socket timeout for active health checks (in seconds).",[5],"Path to use in GET HTTP request to run as a probe on active health checks.","The hostname to use as an SNI (Server Name Identification) when performing active health checks using HTTPS. This is particularly useful when Targets are configured using IPs, so that the target host's certificate can be verified with the proper SNI.",{"default":"445","items":"446","type":"248"},{"default":0,"type":"327"},{"default":0,"type":"231"},{"default":0,"type":"231"},{"default":"447","items":"448","type":"248"},{"default":0,"type":"327"},{"default":0,"type":"231"},{"default":0,"type":"231"},{"default":"449","items":"450","type":"248"},{"default":0,"type":"231"},{"default":0,"type":"231"},{"default":"451","items":"452","type":"248"},{"default":0,"type":"231"},{"default":0,"type":"231"},{"type":"107"},"The value(s) of the x-my-header header.",{"type":"107"},"The value(s) of the x-another-header header.","foo","bar","bla","tcp","grpc","grpcs",{"type":"248","description":"453","default":"454","items":"455","examples":"456"},{"type":"231","description":"457","default":0,"examples":"458"},{"type":"248","description":"459","default":"460","items":"461","examples":"462"},{"type":"231","description":"463","default":0,"examples":"464"},{"type":"231","description":"465","default":0,"examples":"466"},{"type":"231","description":"467","default":0,"examples":"468"},{"type":"248","description":"469","default":"470","items":"471","examples":"472"},{"type":"231","description":"473","default":0,"examples":"474"},{"type":"231","description":"475","default":0,"examples":"476"},{"type":"231","description":"477","default":0,"examples":"478"},{"type":"248","description":"479","default":"480","items":"481","examples":"482"},{"type":"231","description":"483","default":0,"examples":"484"},{"type":"231","description":"485","default":0,"examples":"486"},{"type":"231","description":"487","default":0,"examples":"488"},{"x-my-header":"489","x-another-header":"490"},[200,302],{"type":"231"},[429,404,500,501,502,503,504,505],{"type":"231"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"231"},[429,500,503],{"type":"231"},"An array of HTTP statuses which represent healthiness when produced by proxied traffic, as observed by passive health checks. With form-encoded, the notation is `http_statuses[]=200&http_statuses[]=201`. With JSON, use an array.",[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"231","enum":"491"},["492"],"Number of successes in proxied traffic (as defined by `healthchecks.passive.healthy.http_statuses`) to consider a target healthy, as observed by passive health checks.",[2],"An array of HTTP statuses which represent unhealthiness when produced by proxied traffic, as observed by passive health checks. With form-encoded, the notation is `http_statuses[]=429&http_statuses[]=500`. With JSON, use an array.",[429,500,503],{"type":"231","enum":"493"},["494"],"Number of timeouts in proxied traffic to consider a target unhealthy, as observed by passive health checks.",[1],"Number of HTTP failures in proxied traffic (as defined by `healthchecks.passive.unhealthy.http_statuses`) to consider a target unhealthy, as observed by passive health checks.",[3],"Number of TCP connection failures to consider a target unhealthy, as observed by passive health checks.",[1],"An array of HTTP statuses to consider a success, indicating healthiness, when returned by a probe in active health checks. With form-encoded, the notation is `http_statuses[]=200&http_statuses[]=302`. With JSON, use an array.",[200,302],{"type":"231"},["495"],"Number of successes in active probes (as defined by `healthchecks.active.healthy.http_statuses`) to consider a target healthy.",[3],"Interval between active health checks for healthy targets (in seconds). A value of zero indicates that active probes for healthy targets should not be performed.",[30],"Number of HTTP failures in active probes (as defined by `healthchecks.active.unhealthy.http_statuses`) to consider a target unhealthy.",[2],"An array of HTTP statuses to consider a failure, indicating unhealthiness, when returned by a probe in active health checks. With form-encoded, the notation is `http_statuses[]=429&http_statuses[]=404`. With JSON, use an array.",[429,404,500,501,502,503,504,505],{"type":"231"},["496"],"Number of timeouts in active probes to consider a target unhealthy.",[2],"Number of TCP failures in active probes to consider a target unhealthy.",[1],"Interval between active health checks for unhealthy targets (in seconds). A value of zero indicates that active probes for unhealthy targets should not be performed.",[10],["424","425"],["426"],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[200,201,202],[429,500,503],[500,503],[200,201],[400,404]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-upstream-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a Upstream in a workspace",["18"],"ef92e882e3902","put","/{workspace}/upstreams/{upstream_id_or_name}",["19"],{},"upsert-upstream-in-workspace","Create or Update Upstream using ID or name in a workspace.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Upstreams",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"2a5a4b1190f40","23d682f068592","200",[],["57"],"Successfully upserted Upstream","7bf684cd2ba12","400",[],["58"],"Invalid Upstream","7be684cd2bdc5","401",[],["59"],"Unauthorized","bee8f4da9b125",["60"],"The request object for creating a new upstream.",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"101"},"2b3e6d10e8a27","workspace","simple",[],"Name or ID of workspace",{"type":"102","examples":"103","$schema":"104","x-stoplight":"105"},["106","107","108","109","110","111"],"63c96fdb27f7b","upstream_id_or_name",[],"The unique identifier or the name of the Upstream associated to the Certificate to be retrieved.",{"type":"102","examples":"112","$schema":"104","x-stoplight":"113"},["106","107","108","109","110","111"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121","enum":"122"},"13ecefa6986a2","application/json",["123"],[],{"description":"124","properties":"125","type":"126","title":"127","examples":"128"},"0688efc3fd036",[],[],{"type":"126","$schema":"104","x-stoplight":"129"},"eea910957007f",["130","131","132"],[],{"type":"126","properties":"133","required":"134","title":"135","$schema":"104","x-stoplight":"136"},"df2081179bcf0",["137","138"],[],{"type":"126","x-examples":"139","properties":"140","required":"141","$schema":"104","x-stoplight":"142"},"string",["143"],"http://json-schema.org/draft-07/schema#",{"id":"144"},"name","in","required","schema","description","title",["145"],{"id":"146"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["120","147"],{"id":"148","value":"149","key":"150"},"The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets). So for example an upstream named `service.v1.xyz` for a Service object whose `host` is `service.v1.xyz`. Requests for this Service would be proxied to the targets defined within the upstream. An upstream also includes a [health checker][healthchecks], which is able to enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.",{"algorithm":"151","client_certificate":"152","created_at":"153","hash_fallback":"154","hash_fallback_header":"155","hash_fallback_query_arg":"156","hash_fallback_uri_capture":"157","hash_on":"158","hash_on_cookie":"159","hash_on_cookie_path":"160","hash_on_header":"161","hash_on_query_arg":"162","hash_on_uri_capture":"163","healthchecks":"164","host_header":"165","id":"166","name":"167","slots":"168","tags":"169","updated_at":"170","use_srv_name":"171"},"object","Upstream",["149"],{"id":"172"},{"id":"173","key":"174","value":"175","summary":"176"},{"id":"177","key":"178","value":"179","summary":"180"},{"id":"181","key":"182","value":"183","summary":"184"},{"status":"185","message":"186"},["187","188"],"UnauthorizedError",{"id":"189"},{"id":"190","key":"127","value":"191"},{"id":"192","key":"193","value":"194"},{"Example 1":"195"},{"name":"196","algorithm":"197","hash_on":"198","hash_fallback":"199","hash_on_header":"200","hash_fallback_header":"201","hash_on_cookie":"202","hash_on_cookie_path":"203","hash_on_query_arg":"204","hash_fallback_query_arg":"205","hash_on_uri_capture":"206","hash_fallback_uri_capture":"207","slots":"208","healthchecks":"209","tags":"210","host_header":"211","client_certificate":"212","use_srv_name":"213"},["106"],{"id":"214"},"team-a","f18fb01c9ee23","7fca84d6-7d37-4a74-a7b0-93e576089a41","e3389efc56f57","https","33cbdbe250c87",{"algorithm":"215","hash_fallback":"216","hash_on":"216","hash_on_cookie_path":"116","healthchecks":"217","id":"218","name":"219","slots":10000},"default",{"description":"220","type":"221","default":"215","enum":"222"},{"additionalProperties":false,"description":"223","properties":"224","type":"126"},{"description":"225","type":"226"},{"default":"216","description":"227","type":"102"},{"description":"228","type":"102"},{"description":"229","type":"102"},{"description":"230","type":"102"},{"default":"216","description":"231","type":"102"},{"description":"232","type":"102"},{"default":"116","description":"233","type":"102"},{"description":"234","type":"102"},{"description":"235","type":"102"},{"description":"236","type":"102"},{"properties":"237","type":"126"},{"description":"238","type":"102"},{"type":"102"},{"description":"239","type":"102"},{"default":10000,"description":"240","type":"226"},{"description":"241","items":"242","type":"243"},{"description":"244","type":"226"},{"default":false,"description":"245","type":"246"},"ebb63076af187","a09fed07a99f4","DuplicateApiKey",{"message":"176","status":401},"Duplicate API key found","5549f7986f3ef","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","34ad13af0e0dd","NoAPIKey",{"message":"247","status":401},"No API key found",{"type":"226"},{"type":"102"},"status","message","470b68e5f0549","8ef27c7c9db20",{"name":"248","algorithm":"215","hash_on":"216","hash_fallback":"216","hash_on_cookie_path":"116","slots":10000,"healthchecks":"249","tags":"250","host_header":"251","client_certificate":"252","use_srv_name":false},"ff1a7f9c58421","Example request",{"name":"248","tags":"253","algorithm":"215"},{"id":"254","created_at":1422386534,"name":"248","algorithm":"215","hash_on":"216","hash_fallback":"216","hash_on_cookie_path":"116","slots":10000,"healthchecks":"255","tags":"256","host_header":"251","client_certificate":"257","use_srv_name":false},{"type":"102","description":"258","examples":"259"},{"type":"102","description":"260","enum":"261","default":"215","examples":"262"},{"type":"102","description":"263","default":"216","enum":"264"},{"type":"102","description":"265","default":"216","enum":"266","examples":"267"},{"type":"102","description":"268","examples":"269"},{"type":"102","description":"270","default":"216","examples":"271"},{"type":"102","description":"232","examples":"272"},{"type":"102","description":"233","default":"116","examples":"273"},{"type":"102","description":"235","examples":"274"},{"type":"102","description":"229","examples":"275"},{"type":"102","description":"236","examples":"276"},{"type":"102","description":"230","examples":"277"},{"type":"226","description":"278","minimum":10,"maximum":65536,"default":10000,"examples":"279"},{"type":"126","properties":"280"},{"type":"243","description":"241","items":"281","examples":"282"},{"type":"102","description":"283"},{"type":"126","description":"223","properties":"284"},{"type":"246","description":"285","examples":"286"},"1d11995efa499","round-robin","none",{"active":"287","passive":"288","threshold":0},"6eed5e9c-5398-4026-9a4c-d48f18a2431e","api.example.internal","Which load balancing algorithm to use.",["102","289"],["290","291","215","292",null],"If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"293"},"Unix epoch when the resource was created.","integer","What to use as hashing input if the primary `hash_on` does not return a hash (eg. header is missing, or no Consumer identified). Not available if `hash_on` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_fallback` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_fallback` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_fallback` is set to `uri_capture`.","What to use as hashing input. Using `none` results in a weighted-round-robin scheme with no hashing.","The cookie name to take the value from as hash input. Only required when `hash_on` or `hash_fallback` is set to `cookie`. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.","The cookie path to set in the response headers. Only required when `hash_on` or `hash_fallback` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_on` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_on` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_on` is set to `uri_capture`.",{"active":"294","passive":"295","threshold":"296"},"The hostname to be used as `Host` header when proxying requests through Kong.","This is a hostname, which must be equal to the `host` of a Service.","The number of slots in the load balancer algorithm. If `algorithm` is set to `round-robin`, this setting determines the maximum number of slots. If `algorithm` is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range `10`-`65536`.","An optional set of strings associated with the Upstream for grouping and filtering.",{"type":"102"},"array","Unix epoch when the resource was last updated.","If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream `Host`.","boolean","No API key found in request","my-upstream",{"passive":"297","active":"298","threshold":0},["299","300"],"example.com",{"id":"301"},["299","300"],"58c8ccbb-eafb-4566-991f-2ed4f678fa70",{"passive":"302","active":"303","threshold":0},["299","300"],{"id":"301"},"This is a hostname, which must be equal to the `host` of a service.",["248"],"Which load balancing algorithm to use.\n",["290","291","215","292"],["215"],"What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing",["216","304","305","306","307","308","309"],"What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie.",["216","304","305","306","307","308","309"],["216"],"The header name to take the value from as hash input. Only required when `hash_on` is set to header.",["216"],"The header name to take the value from as hash input. Only required when hash_fallback is set to header.",["216"],["216"],["116"],["310"],["310"],["310"],["310"],"The number of slots in the load balancer algorithm. If the algorithm is set to `round-robin`, this setting determines the maximum number of slots. If the algorithm is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.",[5000],{"passive":"311","active":"312","threshold":"313"},{"type":"102"},["314"],"The hostname to be used as Host header when proxying requests through Kong.",{"id":"315"},"If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.",[false],{"concurrency":10,"healthy":"316","http_path":"116","https_verify_certificate":true,"timeout":1,"type":"120","unhealthy":"317"},{"healthy":"318","type":"120","unhealthy":"319"},"null","consistent-hashing","least-connections","latency",{"type":"102"},{"properties":"320","type":"126"},{"properties":"321","type":"126"},{"default":0,"type":"322"},{"type":"120","healthy":"323","unhealthy":"324"},{"https_verify_certificate":true,"healthy":"325","unhealthy":"326","type":"120","concurrency":10,"headers":"327","timeout":1,"http_path":"116","https_sni":"251"},"user-level","low-priority","ea29aaa3-3b2d-488c-b90c-56df8e0dd8c6",{"type":"120","healthy":"328","unhealthy":"329"},{"https_verify_certificate":true,"healthy":"330","unhealthy":"331","type":"120","concurrency":10,"headers":"332","timeout":1,"http_path":"116","https_sni":"251"},"consumer","ip","cookie","uri_capture","path","query_arg","hash_value",{"type":"126","properties":"333"},{"type":"126","properties":"334"},{"type":"226","description":"335","minimum":0,"maximum":100,"default":0},["299","300"],{"type":"102","examples":"336"},{"http_statuses":"337","interval":0,"successes":0},{"http_failures":0,"http_statuses":"338","interval":0,"tcp_failures":0,"timeouts":0},{"http_statuses":"339","successes":0},{"http_failures":0,"http_statuses":"340","tcp_failures":0,"timeouts":0},{"concurrency":"341","headers":"342","healthy":"343","http_path":"344","https_sni":"345","https_verify_certificate":"346","timeout":"347","type":"348","unhealthy":"349"},{"healthy":"350","type":"351","unhealthy":"352"},"number",{"http_statuses":"353","successes":0},{"http_statuses":"354","timeouts":0,"http_failures":0,"tcp_failures":0},{"http_statuses":"355","successes":0,"interval":0},{"http_failures":0,"http_statuses":"356","timeouts":0,"tcp_failures":0,"interval":0},{"type":"126","properties":"357"},{"http_statuses":"358","successes":0},{"http_statuses":"359","timeouts":0,"http_failures":0,"tcp_failures":0},{"http_statuses":"360","successes":0,"interval":0},{"http_failures":0,"http_statuses":"361","timeouts":0,"tcp_failures":0,"interval":0},["362"],{"type":"363","healthy":"364","unhealthy":"365"},{"https_verify_certificate":"366","healthy":"367","unhealthy":"368","type":"369","concurrency":"370","headers":"371","timeout":"372","http_path":"373","https_sni":"374"},"The minimum percentage of the upstream's targets' weight that must be available for the whole upstream to be considered healthy.",["301"],[200,302],[429,404,500,501,502,503,504,505],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],{"default":10,"type":"226"},{"type":"126"},{"properties":"375","type":"126"},{"default":"116","type":"102"},{"type":"102"},{"default":true,"type":"246"},{"default":1,"type":"322"},{"default":"120","type":"102"},{"properties":"376","type":"126"},{"properties":"377","type":"126"},{"default":"120","type":"102"},{"properties":"378","type":"126"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],[200,302],[429,404,500,501,502,503,504,505],{"x-my-header":"379","x-another-header":"380"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],[200,302],[429,404,500,501,502,503,504,505],{"x-my-header":"381","x-another-header":"382"},{"type":"102","description":"383","default":"120","enum":"384","examples":"385"},{"type":"126","properties":"386"},{"type":"126","properties":"387"},{"type":"246"},{"type":"126","properties":"388"},{"type":"126","properties":"389"},{"type":"102","description":"390","enum":"391","default":"120","examples":"392"},{"type":"226","description":"393","default":10,"examples":"394"},{"type":"126","description":"395","examples":"396"},{"type":"226","description":"397","default":1,"examples":"398"},{"type":"102","description":"399","default":"116"},{"type":"102","description":"400"},{"http_statuses":"401","interval":"402","successes":"403"},{"http_failures":"404","http_statuses":"405","interval":"406","tcp_failures":"407","timeouts":"408"},{"http_statuses":"409","successes":"410"},{"http_failures":"411","http_statuses":"412","tcp_failures":"413","timeouts":"414"},{"type":"243","items":"415","description":"416"},{"type":"243","items":"417","description":"418"},["419","420"],["421"],"Whether to perform passive health checks interpreting HTTP/HTTPS statuses, or just check for TCP connection success. In passive checks, http and https options are equivalent. Accepted values are `tcp`, `http`, `https`, `grpc`, `grpcs`.",["422","120","147","423","424"],["422"],{"http_statuses":"425","successes":"426"},{"http_statuses":"427","timeouts":"428","http_failures":"429","tcp_failures":"430"},{"http_statuses":"431","successes":"432","interval":"433"},{"http_failures":"434","http_statuses":"435","timeouts":"436","tcp_failures":"437","interval":"438"},"Whether to perform active health checks using HTTP or HTTPS, or just attempt a TCP connection.",["422","120","147","423","424"],["147"],"Number of targets to check concurrently in active health checks.",[5],"One or more lists of values indexed by header name to use in GET HTTP request to run as a probe on active health checks. Values must be pre-formatted.",["439"],"Socket timeout for active health checks (in seconds).",[5],"Path to use in GET HTTP request to run as a probe on active health checks.","The hostname to use as an SNI (Server Name Identification) when performing active health checks using HTTPS. This is particularly useful when Targets are configured using IPs, so that the target host's certificate can be verified with the proper SNI.",{"default":"440","items":"441","type":"243"},{"default":0,"type":"322"},{"default":0,"type":"226"},{"default":0,"type":"226"},{"default":"442","items":"443","type":"243"},{"default":0,"type":"322"},{"default":0,"type":"226"},{"default":0,"type":"226"},{"default":"444","items":"445","type":"243"},{"default":0,"type":"226"},{"default":0,"type":"226"},{"default":"446","items":"447","type":"243"},{"default":0,"type":"226"},{"default":0,"type":"226"},{"type":"102"},"The value(s) of the x-my-header header.",{"type":"102"},"The value(s) of the x-another-header header.","foo","bar","bla","tcp","grpc","grpcs",{"type":"243","description":"448","default":"449","items":"450","examples":"451"},{"type":"226","description":"452","default":0,"examples":"453"},{"type":"243","description":"454","default":"455","items":"456","examples":"457"},{"type":"226","description":"458","default":0,"examples":"459"},{"type":"226","description":"460","default":0,"examples":"461"},{"type":"226","description":"462","default":0,"examples":"463"},{"type":"243","description":"464","default":"465","items":"466","examples":"467"},{"type":"226","description":"468","default":0,"examples":"469"},{"type":"226","description":"470","default":0,"examples":"471"},{"type":"226","description":"472","default":0,"examples":"473"},{"type":"243","description":"474","default":"475","items":"476","examples":"477"},{"type":"226","description":"478","default":0,"examples":"479"},{"type":"226","description":"480","default":0,"examples":"481"},{"type":"226","description":"482","default":0,"examples":"483"},{"x-my-header":"484","x-another-header":"485"},[200,302],{"type":"226"},[429,404,500,501,502,503,504,505],{"type":"226"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"226"},[429,500,503],{"type":"226"},"An array of HTTP statuses which represent healthiness when produced by proxied traffic, as observed by passive health checks. With form-encoded, the notation is `http_statuses[]=200&http_statuses[]=201`. With JSON, use an array.",[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"226","enum":"486"},["487"],"Number of successes in proxied traffic (as defined by `healthchecks.passive.healthy.http_statuses`) to consider a target healthy, as observed by passive health checks.",[2],"An array of HTTP statuses which represent unhealthiness when produced by proxied traffic, as observed by passive health checks. With form-encoded, the notation is `http_statuses[]=429&http_statuses[]=500`. With JSON, use an array.",[429,500,503],{"type":"226","enum":"488"},["489"],"Number of timeouts in proxied traffic to consider a target unhealthy, as observed by passive health checks.",[1],"Number of HTTP failures in proxied traffic (as defined by `healthchecks.passive.unhealthy.http_statuses`) to consider a target unhealthy, as observed by passive health checks.",[3],"Number of TCP connection failures to consider a target unhealthy, as observed by passive health checks.",[1],"An array of HTTP statuses to consider a success, indicating healthiness, when returned by a probe in active health checks. With form-encoded, the notation is `http_statuses[]=200&http_statuses[]=302`. With JSON, use an array.",[200,302],{"type":"226"},["490"],"Number of successes in active probes (as defined by `healthchecks.active.healthy.http_statuses`) to consider a target healthy.",[3],"Interval between active health checks for healthy targets (in seconds). A value of zero indicates that active probes for healthy targets should not be performed.",[30],"Number of HTTP failures in active probes (as defined by `healthchecks.active.unhealthy.http_statuses`) to consider a target unhealthy.",[2],"An array of HTTP statuses to consider a failure, indicating unhealthiness, when returned by a probe in active health checks. With form-encoded, the notation is `http_statuses[]=429&http_statuses[]=404`. With JSON, use an array.",[429,404,500,501,502,503,504,505],{"type":"226"},["491"],"Number of timeouts in active probes to consider a target unhealthy.",[2],"Number of TCP failures in active probes to consider a target unhealthy.",[1],"Interval between active health checks for unhealthy targets (in seconds). A value of zero indicates that active probes for unhealthy targets should not be performed.",[10],["419","420"],["421"],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[200,201,202],[429,500,503],[500,503],[200,201],[400,404]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-vault",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all Vaults",["17"],"22e3fd3e3ca63","get","/vaults",["18"],{},"list-vault","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Vaults",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],[],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"d44d5f4adf206","64fcaaeaa4e78","200",[],["47"],"A successful response listing Vaults","cf8caa59348e9","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"51","examples":"64","description":"65","schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"88bf5114092a4","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"88","$schema":"89","x-stoplight":"90"},["91","92","93","94","95"],"11009b4d3a4c6","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"96","$schema":"89","x-stoplight":"97"},["91","92","93","94","95"],"fd9dd2b153fb7","tags",["98"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"96","examples":"99","x-stoplight":"100","$schema":"89"},["91","101","92","93","94","95"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109","enum":"110"},"600965b1902a1","application/json",[],[],{"properties":"111","$schema":"89","x-stoplight":"112"},"5c7780fddcd3d",["113","114","115"],[],{"type":"116","properties":"117","required":"118","title":"119","$schema":"89","x-stoplight":"120"},"integer","http://json-schema.org/draft-07/schema#",{"id":"121"},"description","in","name","schema","title","string",{"id":"122"},{"id":"123","value":"124","key":"125"},["124"],{"explicitProperties":"126","id":"127"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["108","128"],{"data":"129","offset":"130"},{"id":"131"},{"id":"132","key":"133","value":"134","summary":"135"},{"id":"136","key":"137","value":"138","summary":"139"},{"id":"140","key":"141","value":"142","summary":"143"},"object",{"status":"144","message":"145"},["146","147"],"UnauthorizedError",{"id":"148"},"c071537bcbd76","8cbade348355f","29a38047fb98d","tag1,tag2","default",["149","150","151"],"b49a7db3591ff","https",{"items":"152","type":"153"},{"description":"154","type":"96","title":"155"},"1b79d9ec87099","d2ff3ec4ca941","DuplicateApiKey",{"message":"135","status":401},"Duplicate API key found","a091440273f1e","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","a79087bb26115","NoAPIKey",{"message":"156","status":401},"No API key found",{"type":"88"},{"type":"96"},"status","message","470b68e5f0549","type","nullable","examples",{"description":"157","type":"116","properties":"158","additionalProperties":false,"required":"159","title":"160","examples":"161"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","No API key found in request","Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, HashiCorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.",{"config":"162","created_at":"163","description":"164","id":"165","name":"166","prefix":"167","tags":"168","updated_at":"169"},["93","170","171"],"Vault",["172"],{"description":"173","type":"116","additionalProperties":true},{"description":"174","type":"88","readOnly":true},{"description":"175","type":"176"},{"type":"177"},{"description":"178","type":"96"},{"description":"179","type":"96"},{"description":"180","type":"153","items":"181"},{"description":"182","type":"88","readOnly":true},"prefix","config",{"config":"183","description":"184","id":"185","name":"186","prefix":"186","tags":"187"},"The configuration properties for the Vault which can be found on the vaults' documentation page.","Unix epoch when the resource was created.","The description of the Vault entity.",["96","188"],["96","188"],"The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.","The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.","An optional set of strings associated with the Vault for grouping and filtering.",{"type":"96"},"Unix epoch when the resource was last updated.",{"prefix":"189"},"environment variable based vault","2747d1e5-8246-4f65-a939-b392f1ee17f8","env",["190","191"],"null","ENV_PREFIX","foo","bar"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-vault",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new Vault",["17"],"02e65dc4923a1","post","/vaults",["18"],{},"create-vault","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Vaults",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],[],["48"],{"id":"49","url":"50","name":"51","description":"52","variables":"53"},"d44d5f4adf206","1b0c8dfafc5f6","200",[],["54"],"Successfully created Vault","432c8fc0a5463","400",[],["55"],"Invalid Vault","433c8fc0a5214","401",[],["56"],"Unauthorized","a70ff3b988a5b",["57"],"The request object for creating a new vault object.",{"id":"58","key":"59","extensions":"60","description":"61","type":"62","name":"63","in":"64"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"65","path":"66","port":"67","protocol":"68"},{"id":"69","mediaType":"70","examples":"71","encodings":"72","schema":"73"},{"id":"74","mediaType":"70","examples":"75","encodings":"76","schema":"77"},{"id":"78","mediaType":"70","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"70","examples":"83","encodings":"84","schema":"85"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"86","description":"87"},{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93","enum":"94"},"f3b0f7927babf","application/json",["95"],[],{"description":"96","type":"97","properties":"98","additionalProperties":false,"required":"99","title":"100","examples":"101"},"fabdca35b7ac5",[],[],{"type":"97","$schema":"102","x-stoplight":"103"},"d5f5fc7fd5b57",["104","105","106"],[],{"type":"97","properties":"107","required":"108","title":"109","$schema":"102","x-stoplight":"110"},"ed49a0f6e23e3",["111"],[],{"type":"97","x-examples":"112","properties":"113","$schema":"102","x-stoplight":"114"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["92","115"],{"id":"116","value":"117","key":"118"},"Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, HashiCorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.","object",{"config":"119","created_at":"120","description":"121","id":"122","name":"123","prefix":"124","tags":"125","updated_at":"126"},["127","128","129"],"Vault",["117"],"http://json-schema.org/draft-07/schema#",{"id":"130"},{"id":"131","key":"132","value":"133","summary":"134"},{"id":"135","key":"136","value":"137","summary":"138"},{"id":"139","key":"140","value":"141","summary":"142"},{"status":"143","message":"144"},["145","146"],"UnauthorizedError",{"id":"147"},{"id":"148","key":"149","value":"150"},{"Example 1":"151"},{"prefix":"152","name":"153","description":"154","config":"155","tags":"156"},{"id":"157"},"https","be56e82a1e425",{"config":"158","description":"159","id":"160","name":"161","prefix":"161","tags":"162"},"default",{"description":"163","type":"97","additionalProperties":true},{"description":"164","type":"165","readOnly":true},{"description":"166","type":"167"},{"type":"168"},{"description":"169","type":"170"},{"description":"171","type":"170"},{"description":"172","type":"173","items":"174"},{"description":"175","type":"165","readOnly":true},"name","prefix","config","a151f2473da1c","fc32add24a5b2","DuplicateApiKey",{"message":"134","status":401},"Duplicate API key found","edec62ac854dc","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","027a276ce8abb","NoAPIKey",{"message":"176","status":401},"No API key found",{"type":"165"},{"type":"170"},"status","message","470b68e5f0549","d114fac246fa9","Example 1",{"prefix":"161","name":"161","description":"177","config":"178","tags":"179"},{"prefix":"161","name":"161","description":"177","config":"180","tags":"181"},{"type":"170","description":"182","examples":"183"},{"type":"170","description":"184","examples":"185"},{"type":"170","description":"186","examples":"187"},{"type":"97","description":"188","properties":"189"},{"type":"173","description":"190","items":"191"},"9b5af3c8f80ac",{"prefix":"192"},"environment variable based vault","2747d1e5-8246-4f65-a939-b392f1ee17f8","env",["193","194"],"The configuration properties for the Vault which can be found on the vaults' documentation page.","Unix epoch when the resource was created.","integer","The description of the Vault entity.",["170","195"],["170","195"],"The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.","string","The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.","An optional set of strings associated with the Vault for grouping and filtering.","array",{"type":"170"},"Unix epoch when the resource was last updated.","No API key found in request","This vault is used to retrieve Redis database access credentials.",{"prefix":"196"},["197","198"],{"prefix":"196"},["197","198"],"The unique prefix (or identifier) for this vault configuration. Use this prefix to load the right vault configuration and implementation when referencing secrets with the other entities.\n",["161"],"The name of the vault that's being added. The vault implementation must be installed in every Kong instance.\n",["161"],"The description of the vault object.\n",["177"],"The configuration properties for the vault, which can be found on the vaults' documentation page.\n",{"prefix":"199"},"An optional set of strings associated with the vault, used for grouping and filtering.\n",{"type":"170"},"ENV_PREFIX","foo","bar","null","SSL_","database-credentials","data-plane",{"type":"170","examples":"200"},["196"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-vault",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a Vault",["17"],"cab9f691c16bb","delete","/vaults/{vault_id_or_prefix}",["18"],{},"delete-vault","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Vaults",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38"],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"d44d5f4adf206","ec6fb369bc054","204",[],[],"Successfully deleted Vault or the resource didn't exist","ef5fb2c6f31f1","401",[],["45"],"Unauthorized",{"id":"46","name":"47","style":"48","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},{"id":"64","mediaType":"65","examples":"66","encodings":"67","schema":"68"},"ce1b4341a0f9c","vault_id_or_prefix","simple",[],"The unique identifier or the prefix of the Vault to retrieve.",{"type":"69","examples":"70","$schema":"71","x-stoplight":"72"},["73","74","75","76","77","78"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86","enum":"87"},"aac94386c8404","application/json",["88","89","90"],[],{"type":"91","properties":"92","required":"93","title":"94","$schema":"71","x-stoplight":"95"},"string",["96"],"http://json-schema.org/draft-07/schema#",{"id":"97"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["85","98"],{"id":"99","key":"100","value":"101","summary":"102"},{"id":"103","key":"104","value":"105","summary":"106"},{"id":"107","key":"108","value":"109","summary":"110"},"object",{"status":"111","message":"112"},["113","114"],"UnauthorizedError",{"id":"115"},"env","fa11aee906952","https","7a4b7577931d8","DuplicateApiKey",{"message":"102","status":401},"Duplicate API key found","2711e821069d6","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","ba89be5bc8aae","NoAPIKey",{"message":"116","status":401},"No API key found",{"type":"117"},{"type":"69"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-vault",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a Vault",["18"],"488ad971e910f","get","/vaults/{vault_id_or_prefix}",["19"],{},"get-vault","Fetch a Vault using ID or prefix.\n\nVault entities are used to configure different Vault connectors.\n","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Vaults",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45"],["46"],{"id":"47","url":"48","name":"49","description":"50","variables":"51"},"d44d5f4adf206","044554219d5db","200",[],["52"],"Successfully fetched Vault","6ef553902e9e6","401",[],["53"],"Unauthorized","6f2553902ee8d","404",[],[],"Resource does not exist",{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},{"id":"77","mediaType":"73","examples":"78","encodings":"79","schema":"80"},"efdffce5259d0","vault_id_or_prefix","simple",[],"The unique identifier or the prefix of the Vault to retrieve.",{"type":"81","examples":"82","$schema":"83","x-stoplight":"84"},["85","86","87","88","89","90"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"a2a30fc9abbf3","application/json",["100"],[],{"description":"101","type":"102","properties":"103","additionalProperties":false,"required":"104","title":"105","examples":"106"},"17a553e816c11",["107","108","109"],[],{"type":"102","properties":"110","required":"111","title":"112","$schema":"83","x-stoplight":"113"},"string",["114"],"http://json-schema.org/draft-07/schema#",{"id":"115"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","116"],{"id":"117","value":"118","key":"119"},"Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, HashiCorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.","object",{"config":"120","created_at":"121","description":"122","id":"123","name":"124","prefix":"125","tags":"126","updated_at":"127"},["85","128","129"],"Vault",["118"],{"id":"130","key":"131","value":"132","summary":"133"},{"id":"134","key":"135","value":"136","summary":"137"},{"id":"138","key":"139","value":"140","summary":"141"},{"status":"142","message":"143"},["144","145"],"UnauthorizedError",{"id":"146"},"env","530a0fbff7663","https","179a4d92cf7c2",{"config":"147","description":"148","id":"149","name":"114","prefix":"114","tags":"150"},"default",{"description":"151","type":"102","additionalProperties":true},{"description":"152","type":"153","readOnly":true},{"description":"154","type":"155"},{"type":"156"},{"description":"157","type":"81"},{"description":"158","type":"81"},{"description":"159","type":"160","items":"161"},{"description":"162","type":"153","readOnly":true},"prefix","config","f971ce97d8d04","DuplicateApiKey",{"message":"133","status":401},"Duplicate API key found","eb2b837213d6a","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","d9389286bd900","NoAPIKey",{"message":"163","status":401},"No API key found",{"type":"153"},{"type":"81"},"status","message","470b68e5f0549",{"prefix":"164"},"environment variable based vault","2747d1e5-8246-4f65-a939-b392f1ee17f8",["165","166"],"The configuration properties for the Vault which can be found on the vaults' documentation page.","Unix epoch when the resource was created.","integer","The description of the Vault entity.",["81","167"],["81","167"],"The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.","The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.","An optional set of strings associated with the Vault for grouping and filtering.","array",{"type":"81"},"Unix epoch when the resource was last updated.","No API key found in request","ENV_PREFIX","foo","bar","null"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-vault",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update a Vault",["17"],"ee212e48df70a","patch","/vaults/{vault_id_or_prefix}",["18"],{},"update-vault","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Vaults",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54"],["55"],{"id":"56","url":"57","name":"58","description":"59","variables":"60"},"d44d5f4adf206","9da87980ee035","200",[],["61"],"Successfully updated Vault","458877a42b4a9","400",[],["62"],"Invalid Vault","457877a42b6fa","401",[],["63"],"Unauthorized","45c877a42cf65","404",[],[],"Resource does not exist","9a57e7444fa07",["64"],"The request object for creating a new vault object.",{"id":"65","name":"66","style":"67","examples":"68","description":"69","required":true,"schema":"70","explicitProperties":"71"},{"id":"72","key":"73","extensions":"74","description":"75","type":"76","name":"77","in":"78"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"79","path":"80","port":"81","protocol":"82"},{"id":"83","mediaType":"84","examples":"85","encodings":"86","schema":"87"},{"id":"88","mediaType":"84","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"84","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"84","examples":"97","encodings":"98","schema":"99"},"b8970d364ef3b","vault_id_or_prefix","simple",[],"The unique identifier or the prefix of the Vault to retrieve.",{"type":"100","examples":"101","$schema":"102","x-stoplight":"103"},["104","105","106","107","108","109"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"110","description":"111"},{"default":"112","description":"113"},{"default":"114","description":"115"},{"default":"116","description":"117","enum":"118"},"299a09700cc21","application/json",["119"],[],{"description":"120","type":"121","properties":"122","additionalProperties":false,"required":"123","title":"124","examples":"125"},"6f08576fdab61",[],[],{"type":"121","$schema":"102","x-stoplight":"126"},"87dc0bb1e87bd",["127","128","129"],[],{"type":"121","properties":"130","required":"131","title":"132","$schema":"102","x-stoplight":"133"},"7355d330613b2",["134"],[],{"type":"121","x-examples":"135","properties":"136","$schema":"102","x-stoplight":"137"},"string",["138"],"http://json-schema.org/draft-07/schema#",{"id":"139"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["116","140"],{"id":"141","value":"142","key":"143"},"Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, HashiCorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.","object",{"config":"144","created_at":"145","description":"146","id":"147","name":"148","prefix":"149","tags":"150","updated_at":"151"},["104","152","153"],"Vault",["142"],{"id":"154"},{"id":"155","key":"156","value":"157","summary":"158"},{"id":"159","key":"160","value":"161","summary":"162"},{"id":"163","key":"164","value":"165","summary":"166"},{"status":"167","message":"168"},["169","170"],"UnauthorizedError",{"id":"171"},{"id":"172","key":"173","value":"174"},{"Example 1":"175"},{"prefix":"176","name":"177","description":"178","config":"179","tags":"180"},{"id":"181"},"env","16587d47e857f","https","becb657e76dd4",{"config":"182","description":"183","id":"184","name":"138","prefix":"138","tags":"185"},"default",{"description":"186","type":"121","additionalProperties":true},{"description":"187","type":"188","readOnly":true},{"description":"189","type":"190"},{"type":"191"},{"description":"192","type":"100"},{"description":"193","type":"100"},{"description":"194","type":"195","items":"196"},{"description":"197","type":"188","readOnly":true},"prefix","config","1e905a360d3b2","6af98614f19b9","DuplicateApiKey",{"message":"158","status":401},"Duplicate API key found","80c816f10ffa0","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","f228b842a4390","NoAPIKey",{"message":"198","status":401},"No API key found",{"type":"188"},{"type":"100"},"status","message","470b68e5f0549","704fa3ae92d24","Example 1",{"prefix":"138","name":"138","description":"199","config":"200","tags":"201"},{"prefix":"138","name":"138","description":"199","config":"202","tags":"203"},{"type":"100","description":"204","examples":"205"},{"type":"100","description":"206","examples":"207"},{"type":"100","description":"208","examples":"209"},{"type":"121","description":"210","properties":"211"},{"type":"195","description":"212","items":"213"},"9b5af3c8f80ac",{"prefix":"214"},"environment variable based vault","2747d1e5-8246-4f65-a939-b392f1ee17f8",["215","216"],"The configuration properties for the Vault which can be found on the vaults' documentation page.","Unix epoch when the resource was created.","integer","The description of the Vault entity.",["100","217"],["100","217"],"The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.","The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.","An optional set of strings associated with the Vault for grouping and filtering.","array",{"type":"100"},"Unix epoch when the resource was last updated.","No API key found in request","This vault is used to retrieve Redis database access credentials.",{"prefix":"218"},["219","220"],{"prefix":"218"},["219","220"],"The unique prefix (or identifier) for this vault configuration. Use this prefix to load the right vault configuration and implementation when referencing secrets with the other entities.\n",["138"],"The name of the vault that's being added. The vault implementation must be installed in every Kong instance.\n",["138"],"The description of the vault object.\n",["199"],"The configuration properties for the vault, which can be found on the vaults' documentation page.\n",{"prefix":"221"},"An optional set of strings associated with the vault, used for grouping and filtering.\n",{"type":"100"},"ENV_PREFIX","foo","bar","null","SSL_","database-credentials","data-plane",{"type":"100","examples":"222"},["218"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-vault",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a Vault",["18"],"4dae85555dd0b","put","/vaults/{vault_id_or_prefix}",["19"],{},"upsert-vault","Create or Update Vault using ID or prefix.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Vaults",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"d44d5f4adf206","51e60aec58c43","200",[],["56"],"Successfully upserted Vault","84860a43c1e30","400",[],["57"],"Invalid Vault","84760a43c18ff","401",[],["58"],"Unauthorized","8d7364194b956",["59"],"The request object for creating a new vault object.",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"79","examples":"84","encodings":"85","schema":"86"},{"id":"87","mediaType":"79","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"79","examples":"92","encodings":"93","schema":"94"},"3904a47c34441","vault_id_or_prefix","simple",[],"The unique identifier or the prefix of the Vault to retrieve.",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110"},{"default":"111","description":"112","enum":"113"},"9486cc8bdcee5","application/json",["114"],[],{"description":"115","type":"116","properties":"117","additionalProperties":false,"required":"118","title":"119","examples":"120"},"280c6cd67c447",[],[],{"type":"116","$schema":"97","x-stoplight":"121"},"8e89ed35d34bf",["122","123","124"],[],{"type":"116","properties":"125","required":"126","title":"127","$schema":"97","x-stoplight":"128"},"9ca73079cf79c",["129"],[],{"type":"116","x-examples":"130","properties":"131","$schema":"97","x-stoplight":"132"},"string",["133"],"http://json-schema.org/draft-07/schema#",{"id":"134"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["111","135"],{"id":"136","value":"137","key":"138"},"Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, HashiCorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.","object",{"config":"139","created_at":"140","description":"141","id":"142","name":"143","prefix":"144","tags":"145","updated_at":"146"},["99","147","148"],"Vault",["137"],{"id":"149"},{"id":"150","key":"151","value":"152","summary":"153"},{"id":"154","key":"155","value":"156","summary":"157"},{"id":"158","key":"159","value":"160","summary":"161"},{"status":"162","message":"163"},["164","165"],"UnauthorizedError",{"id":"166"},{"id":"167","key":"168","value":"169"},{"Example 1":"170"},{"prefix":"171","name":"172","description":"173","config":"174","tags":"175"},{"id":"176"},"env","f97c419ad3f88","https","f9edce72a86a8",{"config":"177","description":"178","id":"179","name":"133","prefix":"133","tags":"180"},"default",{"description":"181","type":"116","additionalProperties":true},{"description":"182","type":"183","readOnly":true},{"description":"184","type":"185"},{"type":"186"},{"description":"187","type":"95"},{"description":"188","type":"95"},{"description":"189","type":"190","items":"191"},{"description":"192","type":"183","readOnly":true},"prefix","config","655cb422a9544","3e3b91d329940","DuplicateApiKey",{"message":"153","status":401},"Duplicate API key found","71cb2df0e196d","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","9c5c68af0e69a","NoAPIKey",{"message":"193","status":401},"No API key found",{"type":"183"},{"type":"95"},"status","message","470b68e5f0549","8219dac961f3c","Example 1",{"prefix":"133","name":"133","description":"194","config":"195","tags":"196"},{"prefix":"133","name":"133","description":"194","config":"197","tags":"198"},{"type":"95","description":"199","examples":"200"},{"type":"95","description":"201","examples":"202"},{"type":"95","description":"203","examples":"204"},{"type":"116","description":"205","properties":"206"},{"type":"190","description":"207","items":"208"},"9b5af3c8f80ac",{"prefix":"209"},"environment variable based vault","2747d1e5-8246-4f65-a939-b392f1ee17f8",["210","211"],"The configuration properties for the Vault which can be found on the vaults' documentation page.","Unix epoch when the resource was created.","integer","The description of the Vault entity.",["95","212"],["95","212"],"The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.","The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.","An optional set of strings associated with the Vault for grouping and filtering.","array",{"type":"95"},"Unix epoch when the resource was last updated.","No API key found in request","This vault is used to retrieve Redis database access credentials.",{"prefix":"213"},["214","215"],{"prefix":"213"},["214","215"],"The unique prefix (or identifier) for this vault configuration. Use this prefix to load the right vault configuration and implementation when referencing secrets with the other entities.\n",["133"],"The name of the vault that's being added. The vault implementation must be installed in every Kong instance.\n",["133"],"The description of the vault object.\n",["194"],"The configuration properties for the vault, which can be found on the vaults' documentation page.\n",{"prefix":"216"},"An optional set of strings associated with the vault, used for grouping and filtering.\n",{"type":"95"},"ENV_PREFIX","foo","bar","null","SSL_","database-credentials","data-plane",{"type":"95","examples":"217"},["213"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-vault-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all Vaults in a workspace",["17"],"d8e0f138442a1","get","/{workspace}/vaults",["18"],{},"list-vault-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Vaults",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],["41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"d44d5f4adf206","84514ee9446b5","200",[],["48"],"A successful response listing Vaults","51c14f91db139","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"71","examples":"72","description":"73","required":true,"schema":"74","explicitProperties":"75"},{"id":"76","key":"77","extensions":"78","description":"79","type":"80","name":"81","in":"82"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"83","path":"84","port":"85","protocol":"86"},{"id":"87","mediaType":"88","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"88","examples":"93","encodings":"94","schema":"95"},"a006077353405","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103"],"7fb4b020c3c75","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"104","$schema":"97","x-stoplight":"105"},["99","100","101","102","103"],"13636e683107c","tags",["106"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"104","examples":"107","x-stoplight":"108","$schema":"97"},["99","109","100","101","102","103"],"5b00b57682777","workspace","simple",[],"Name or ID of workspace",{"type":"104","examples":"110","$schema":"97","x-stoplight":"111"},["101","100","112","102","99","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"5a348c14c6093","application/json",[],[],{"properties":"122","$schema":"97","x-stoplight":"123"},"5a3ce9e35ea7b",["124","125","126"],[],{"type":"127","properties":"128","required":"129","title":"130","$schema":"97","x-stoplight":"131"},"integer","http://json-schema.org/draft-07/schema#",{"id":"132"},"description","in","name","schema","title","string",{"id":"133"},{"id":"134","value":"135","key":"136"},["135"],{"explicitProperties":"137","id":"138"},"example",["139"],{"id":"140"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","141"],{"data":"142","offset":"143"},{"id":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},"object",{"status":"157","message":"158"},["159","160"],"UnauthorizedError",{"id":"161"},"ec15ab58295b5","beaab30715bec","fbd727e4c3966","tag1,tag2","default",["162","163","164"],"920fecb19cfeb","team-a","d83f9cd73149f","https",{"items":"165","type":"166"},{"description":"167","type":"104","title":"168"},"53059f6864c67","e721f4823b8f6","DuplicateApiKey",{"message":"148","status":401},"Duplicate API key found","65d40d75b3ae8","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","3bc872da213bb","NoAPIKey",{"message":"169","status":401},"No API key found",{"type":"96"},{"type":"104"},"status","message","470b68e5f0549","type","nullable","examples",{"description":"170","type":"127","properties":"171","additionalProperties":false,"required":"172","title":"173","examples":"174"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","No API key found in request","Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, HashiCorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.",{"config":"175","created_at":"176","description":"177","id":"178","name":"179","prefix":"180","tags":"181","updated_at":"182"},["101","183","184"],"Vault",["185"],{"description":"186","type":"127","additionalProperties":true},{"description":"187","type":"96","readOnly":true},{"description":"188","type":"189"},{"type":"190"},{"description":"191","type":"104"},{"description":"192","type":"104"},{"description":"193","type":"166","items":"194"},{"description":"195","type":"96","readOnly":true},"prefix","config",{"config":"196","description":"197","id":"198","name":"199","prefix":"199","tags":"200"},"The configuration properties for the Vault which can be found on the vaults' documentation page.","Unix epoch when the resource was created.","The description of the Vault entity.",["104","201"],["104","201"],"The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.","The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.","An optional set of strings associated with the Vault for grouping and filtering.",{"type":"104"},"Unix epoch when the resource was last updated.",{"prefix":"202"},"environment variable based vault","2747d1e5-8246-4f65-a939-b392f1ee17f8","env",["203","204"],"null","ENV_PREFIX","foo","bar"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-vault-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new Vault in a workspace",["17"],"d1e5cec7ff358","post","/{workspace}/vaults",["18"],{},"create-vault-in-workspace","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Vaults",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48"],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"d44d5f4adf206","013e78016c099","200",[],["55"],"Successfully created Vault","a91e7624a9704","400",[],["56"],"Invalid Vault","a92e7624a96f7","401",[],["57"],"Unauthorized","7d0cb2d069937",["58"],"The request object for creating a new vault object.",{"id":"59","name":"60","style":"61","examples":"62","description":"63","required":true,"schema":"64","explicitProperties":"65"},{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},{"id":"86","mediaType":"78","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"78","examples":"91","encodings":"92","schema":"93"},"053633c2aa134","workspace","simple",[],"Name or ID of workspace",{"type":"94","examples":"95","$schema":"96","x-stoplight":"97"},["98","99","100","101","102","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111","enum":"112"},"9d1e5118df4d1","application/json",["113"],[],{"description":"114","type":"115","properties":"116","additionalProperties":false,"required":"117","title":"118","examples":"119"},"545e05215427b",[],[],{"type":"115","$schema":"96","x-stoplight":"120"},"e28b573cc9fbd",["121","122","123"],[],{"type":"115","properties":"124","required":"125","title":"126","$schema":"96","x-stoplight":"127"},"90f3fb305d810",["128"],[],{"type":"115","x-examples":"129","properties":"130","$schema":"96","x-stoplight":"131"},"string",["132"],"http://json-schema.org/draft-07/schema#",{"id":"133"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["110","134"],{"id":"135","value":"136","key":"137"},"Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, HashiCorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.","object",{"config":"138","created_at":"139","description":"140","id":"141","name":"142","prefix":"143","tags":"144","updated_at":"145"},["98","146","147"],"Vault",["136"],{"id":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},{"id":"157","key":"158","value":"159","summary":"160"},{"status":"161","message":"162"},["163","164"],"UnauthorizedError",{"id":"165"},{"id":"166","key":"167","value":"168"},{"Example 1":"169"},{"prefix":"170","name":"171","description":"172","config":"173","tags":"174"},{"id":"175"},"team-a","d98062ef11633","https","6a574dd7b428b",{"config":"176","description":"177","id":"178","name":"179","prefix":"179","tags":"180"},"default",{"description":"181","type":"115","additionalProperties":true},{"description":"182","type":"183","readOnly":true},{"description":"184","type":"185"},{"type":"186"},{"description":"187","type":"94"},{"description":"188","type":"94"},{"description":"189","type":"190","items":"191"},{"description":"192","type":"183","readOnly":true},"prefix","config","32e651c346c40","a018cd5a629e3","DuplicateApiKey",{"message":"152","status":401},"Duplicate API key found","d0b19bc21f64d","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","624b6d4931dd0","NoAPIKey",{"message":"193","status":401},"No API key found",{"type":"183"},{"type":"94"},"status","message","470b68e5f0549","e9cb37b633b93","Example 1",{"prefix":"179","name":"179","description":"194","config":"195","tags":"196"},{"prefix":"179","name":"179","description":"194","config":"197","tags":"198"},{"type":"94","description":"199","examples":"200"},{"type":"94","description":"201","examples":"202"},{"type":"94","description":"203","examples":"204"},{"type":"115","description":"205","properties":"206"},{"type":"190","description":"207","items":"208"},"9b5af3c8f80ac",{"prefix":"209"},"environment variable based vault","2747d1e5-8246-4f65-a939-b392f1ee17f8","env",["210","211"],"The configuration properties for the Vault which can be found on the vaults' documentation page.","Unix epoch when the resource was created.","integer","The description of the Vault entity.",["94","212"],["94","212"],"The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.","The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.","An optional set of strings associated with the Vault for grouping and filtering.","array",{"type":"94"},"Unix epoch when the resource was last updated.","No API key found in request","This vault is used to retrieve Redis database access credentials.",{"prefix":"213"},["214","215"],{"prefix":"213"},["214","215"],"The unique prefix (or identifier) for this vault configuration. Use this prefix to load the right vault configuration and implementation when referencing secrets with the other entities.\n",["179"],"The name of the vault that's being added. The vault implementation must be installed in every Kong instance.\n",["179"],"The description of the vault object.\n",["194"],"The configuration properties for the vault, which can be found on the vaults' documentation page.\n",{"prefix":"216"},"An optional set of strings associated with the vault, used for grouping and filtering.\n",{"type":"94"},"ENV_PREFIX","foo","bar","null","SSL_","database-credentials","data-plane",{"type":"94","examples":"217"},["213"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-vault-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a Vault in a workspace",["17"],"694e07cafcf49","delete","/{workspace}/vaults/{vault_id_or_prefix}",["18"],{},"delete-vault-in-workspace","inheritedFromService",["19"],{"headers":"20","query":"21","cookie":"22","path":"23"},["24"],["25"],"Vaults",{"id":"26","name":"17"},{"id":"27","code":"28","headers":"29","contents":"30","description":"31"},[],[],[],["32","33"],["34"],{"id":"35","url":"36","name":"37","description":"38","variables":"39"},"d44d5f4adf206","b1af3411c859b","204",[],[],"Successfully deleted Vault or the resource didn't exist",{"id":"40","name":"41","style":"42","examples":"43","description":"44","required":true,"schema":"45","explicitProperties":"46"},{"id":"47","name":"48","style":"42","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},"98d8855d842a5","workspace","simple",[],"Name or ID of workspace",{"type":"64","examples":"65","$schema":"66","x-stoplight":"67"},["68","69","70","71","72","73"],"b0f26e0310d42","vault_id_or_prefix",[],"The unique identifier or the prefix of the Vault to retrieve.",{"type":"64","examples":"74","$schema":"66","x-stoplight":"75"},["68","69","70","71","72","73"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"76","description":"77"},{"default":"78","description":"79"},{"default":"80","description":"81"},{"default":"82","description":"83","enum":"84"},"string",["85"],"http://json-schema.org/draft-07/schema#",{"id":"86"},"name","in","required","schema","description","title",["87"],{"id":"88"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["82","89"],"team-a","2b1a79c1c8726","env","e667c5437f66f","https"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-vault-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a Vault in a workspace",["18"],"6b604bfc23b82","get","/{workspace}/vaults/{vault_id_or_prefix}",["19"],{},"get-vault-in-workspace","Get a Vault using ID or prefix in a workspace.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Vaults",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46"],["47"],{"id":"48","url":"49","name":"50","description":"51","variables":"52"},"d44d5f4adf206","f049c553a28df","200",[],["53"],"Successfully fetched Vault","2ad9c4ab19a88","401",[],["54"],"Unauthorized","2b29c4ab1a10b","404",[],[],"Resource does not exist",{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"57","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"91e6df760f421","workspace","simple",[],"Name or ID of workspace",{"type":"88","examples":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96","97"],"ac27ee1b4a21c","vault_id_or_prefix",[],"The unique identifier or the prefix of the Vault to retrieve.",{"type":"88","examples":"98","$schema":"90","x-stoplight":"99"},["92","93","94","95","96","97"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107","enum":"108"},"50c18c4fa514d","application/json",["109"],[],{"description":"110","type":"111","properties":"112","additionalProperties":false,"required":"113","title":"114","examples":"115"},"6dea1bfb89aa9",["116","117","118"],[],{"type":"111","properties":"119","required":"120","title":"121","$schema":"90","x-stoplight":"122"},"string",["123"],"http://json-schema.org/draft-07/schema#",{"id":"124"},"name","in","required","schema","description","title",["125"],{"id":"126"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["106","127"],{"id":"128","value":"129","key":"130"},"Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, HashiCorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.","object",{"config":"131","created_at":"132","description":"133","id":"134","name":"135","prefix":"136","tags":"137","updated_at":"138"},["92","139","140"],"Vault",["129"],{"id":"141","key":"142","value":"143","summary":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"status":"153","message":"154"},["155","156"],"UnauthorizedError",{"id":"157"},"team-a","1752bd6eebd65","env","d66a89be7f0ba","https","f2e7d2872cc59",{"config":"158","description":"159","id":"160","name":"125","prefix":"125","tags":"161"},"default",{"description":"162","type":"111","additionalProperties":true},{"description":"163","type":"164","readOnly":true},{"description":"165","type":"166"},{"type":"167"},{"description":"168","type":"88"},{"description":"169","type":"88"},{"description":"170","type":"171","items":"172"},{"description":"173","type":"164","readOnly":true},"prefix","config","0fea7ba3bc1c5","DuplicateApiKey",{"message":"144","status":401},"Duplicate API key found","ca68078d8c5a6","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","c37629a64c978","NoAPIKey",{"message":"174","status":401},"No API key found",{"type":"164"},{"type":"88"},"status","message","470b68e5f0549",{"prefix":"175"},"environment variable based vault","2747d1e5-8246-4f65-a939-b392f1ee17f8",["176","177"],"The configuration properties for the Vault which can be found on the vaults' documentation page.","Unix epoch when the resource was created.","integer","The description of the Vault entity.",["88","178"],["88","178"],"The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.","The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.","An optional set of strings associated with the Vault for grouping and filtering.","array",{"type":"88"},"Unix epoch when the resource was last updated.","No API key found in request","ENV_PREFIX","foo","bar","null"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-vault-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update a Vault in a workspace",["17"],"c346631aab74e","patch","/{workspace}/vaults/{vault_id_or_prefix}",["18"],{},"update-vault-in-workspace","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Vaults",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54","55"],["56"],{"id":"57","url":"58","name":"59","description":"60","variables":"61"},"d44d5f4adf206","f6bbe7549cfef","200",[],["62"],"Successfully updated Vault","615be6c32c900","400",[],["63"],"Invalid Vault","614be6c32cf5f","401",[],["64"],"Unauthorized","619be6c32c0dc","404",[],[],"Resource does not exist","6d2b68b26bad7",["65"],"The request object for creating a new vault object.",{"id":"66","name":"67","style":"68","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","name":"74","style":"68","examples":"75","description":"76","required":true,"schema":"77","explicitProperties":"78"},{"id":"79","key":"80","extensions":"81","description":"82","type":"83","name":"84","in":"85"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"86","path":"87","port":"88","protocol":"89"},{"id":"90","mediaType":"91","examples":"92","encodings":"93","schema":"94"},{"id":"95","mediaType":"91","examples":"96","encodings":"97","schema":"98"},{"id":"99","mediaType":"91","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"91","examples":"104","encodings":"105","schema":"106"},"3b4d3f8689247","workspace","simple",[],"Name or ID of workspace",{"type":"107","examples":"108","$schema":"109","x-stoplight":"110"},["111","112","113","114","115","116"],"b7e293208051a","vault_id_or_prefix",[],"The unique identifier or the prefix of the Vault to retrieve.",{"type":"107","examples":"117","$schema":"109","x-stoplight":"118"},["111","112","113","114","115","116"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"119","description":"120"},{"default":"121","description":"122"},{"default":"123","description":"124"},{"default":"125","description":"126","enum":"127"},"8819452672830","application/json",["128"],[],{"description":"129","type":"130","properties":"131","additionalProperties":false,"required":"132","title":"133","examples":"134"},"30f856951cfbc",[],[],{"type":"130","$schema":"109","x-stoplight":"135"},"450a56e2ffe10",["136","137","138"],[],{"type":"130","properties":"139","required":"140","title":"141","$schema":"109","x-stoplight":"142"},"9e28a1af8c867",["143"],[],{"type":"130","x-examples":"144","properties":"145","$schema":"109","x-stoplight":"146"},"string",["147"],"http://json-schema.org/draft-07/schema#",{"id":"148"},"name","in","required","schema","description","title",["149"],{"id":"150"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["125","151"],{"id":"152","value":"153","key":"154"},"Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, HashiCorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.","object",{"config":"155","created_at":"156","description":"157","id":"158","name":"159","prefix":"160","tags":"161","updated_at":"162"},["111","163","164"],"Vault",["153"],{"id":"165"},{"id":"166","key":"167","value":"168","summary":"169"},{"id":"170","key":"171","value":"172","summary":"173"},{"id":"174","key":"175","value":"176","summary":"177"},{"status":"178","message":"179"},["180","181"],"UnauthorizedError",{"id":"182"},{"id":"183","key":"184","value":"185"},{"Example 1":"186"},{"prefix":"187","name":"188","description":"189","config":"190","tags":"191"},{"id":"192"},"team-a","27f37c1c60265","env","a44807ff11044","https","006155476c1e7",{"config":"193","description":"194","id":"195","name":"149","prefix":"149","tags":"196"},"default",{"description":"197","type":"130","additionalProperties":true},{"description":"198","type":"199","readOnly":true},{"description":"200","type":"201"},{"type":"202"},{"description":"203","type":"107"},{"description":"204","type":"107"},{"description":"205","type":"206","items":"207"},{"description":"208","type":"199","readOnly":true},"prefix","config","71fbd9b39fa97","b8cf7ac23545c","DuplicateApiKey",{"message":"169","status":401},"Duplicate API key found","6024b093cc933","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","c98fa03808782","NoAPIKey",{"message":"209","status":401},"No API key found",{"type":"199"},{"type":"107"},"status","message","470b68e5f0549","d3f2ba546b506","Example 1",{"prefix":"149","name":"149","description":"210","config":"211","tags":"212"},{"prefix":"149","name":"149","description":"210","config":"213","tags":"214"},{"type":"107","description":"215","examples":"216"},{"type":"107","description":"217","examples":"218"},{"type":"107","description":"219","examples":"220"},{"type":"130","description":"221","properties":"222"},{"type":"206","description":"223","items":"224"},"9b5af3c8f80ac",{"prefix":"225"},"environment variable based vault","2747d1e5-8246-4f65-a939-b392f1ee17f8",["226","227"],"The configuration properties for the Vault which can be found on the vaults' documentation page.","Unix epoch when the resource was created.","integer","The description of the Vault entity.",["107","228"],["107","228"],"The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.","The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.","An optional set of strings associated with the Vault for grouping and filtering.","array",{"type":"107"},"Unix epoch when the resource was last updated.","No API key found in request","This vault is used to retrieve Redis database access credentials.",{"prefix":"229"},["230","231"],{"prefix":"229"},["230","231"],"The unique prefix (or identifier) for this vault configuration. Use this prefix to load the right vault configuration and implementation when referencing secrets with the other entities.\n",["149"],"The name of the vault that's being added. The vault implementation must be installed in every Kong instance.\n",["149"],"The description of the vault object.\n",["210"],"The configuration properties for the vault, which can be found on the vaults' documentation page.\n",{"prefix":"232"},"An optional set of strings associated with the vault, used for grouping and filtering.\n",{"type":"107"},"ENV_PREFIX","foo","bar","null","SSL_","database-credentials","data-plane",{"type":"107","examples":"233"},["229"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-vault-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a Vault in a workspace",["18"],"79becad402d07","put","/{workspace}/vaults/{vault_id_or_prefix}",["19"],{},"upsert-vault-in-workspace","Create or Update Vault using ID or prefix in a workspace.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Vaults",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"d44d5f4adf206","bd2a29208aa3d","200",[],["57"],"Successfully upserted Vault","154a2afd4cab0","400",[],["58"],"Invalid Vault","153a2afd4c847","401",[],["59"],"Unauthorized","4b4233dc0e328",["60"],"The request object for creating a new vault object.",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"101"},"679ab187dc0fe","workspace","simple",[],"Name or ID of workspace",{"type":"102","examples":"103","$schema":"104","x-stoplight":"105"},["106","107","108","109","110","111"],"bc596c3ba506e","vault_id_or_prefix",[],"The unique identifier or the prefix of the Vault to retrieve.",{"type":"102","examples":"112","$schema":"104","x-stoplight":"113"},["106","107","108","109","110","111"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121","enum":"122"},"ef346a9a77379","application/json",["123"],[],{"description":"124","type":"125","properties":"126","additionalProperties":false,"required":"127","title":"128","examples":"129"},"3315a360d1d99",[],[],{"type":"125","$schema":"104","x-stoplight":"130"},"95a64ac16e739",["131","132","133"],[],{"type":"125","properties":"134","required":"135","title":"136","$schema":"104","x-stoplight":"137"},"e17f86ec8abb7",["138"],[],{"type":"125","x-examples":"139","properties":"140","$schema":"104","x-stoplight":"141"},"string",["142"],"http://json-schema.org/draft-07/schema#",{"id":"143"},"name","in","required","schema","description","title",["144"],{"id":"145"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["120","146"],{"id":"147","value":"148","key":"149"},"Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, HashiCorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.","object",{"config":"150","created_at":"151","description":"152","id":"153","name":"154","prefix":"155","tags":"156","updated_at":"157"},["106","158","159"],"Vault",["148"],{"id":"160"},{"id":"161","key":"162","value":"163","summary":"164"},{"id":"165","key":"166","value":"167","summary":"168"},{"id":"169","key":"170","value":"171","summary":"172"},{"status":"173","message":"174"},["175","176"],"UnauthorizedError",{"id":"177"},{"id":"178","key":"179","value":"180"},{"Example 1":"181"},{"prefix":"182","name":"183","description":"184","config":"185","tags":"186"},{"id":"187"},"team-a","a7b6e6b71d39f","env","e9ff58bd6a03e","https","4d845f53a1226",{"config":"188","description":"189","id":"190","name":"144","prefix":"144","tags":"191"},"default",{"description":"192","type":"125","additionalProperties":true},{"description":"193","type":"194","readOnly":true},{"description":"195","type":"196"},{"type":"197"},{"description":"198","type":"102"},{"description":"199","type":"102"},{"description":"200","type":"201","items":"202"},{"description":"203","type":"194","readOnly":true},"prefix","config","754a6caa99fdb","9b81b492c70af","DuplicateApiKey",{"message":"164","status":401},"Duplicate API key found","6913b9d06f488","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","08deefcea5f71","NoAPIKey",{"message":"204","status":401},"No API key found",{"type":"194"},{"type":"102"},"status","message","470b68e5f0549","eccba8f8b8a30","Example 1",{"prefix":"144","name":"144","description":"205","config":"206","tags":"207"},{"prefix":"144","name":"144","description":"205","config":"208","tags":"209"},{"type":"102","description":"210","examples":"211"},{"type":"102","description":"212","examples":"213"},{"type":"102","description":"214","examples":"215"},{"type":"125","description":"216","properties":"217"},{"type":"201","description":"218","items":"219"},"9b5af3c8f80ac",{"prefix":"220"},"environment variable based vault","2747d1e5-8246-4f65-a939-b392f1ee17f8",["221","222"],"The configuration properties for the Vault which can be found on the vaults' documentation page.","Unix epoch when the resource was created.","integer","The description of the Vault entity.",["102","223"],["102","223"],"The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.","The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.","An optional set of strings associated with the Vault for grouping and filtering.","array",{"type":"102"},"Unix epoch when the resource was last updated.","No API key found in request","This vault is used to retrieve Redis database access credentials.",{"prefix":"224"},["225","226"],{"prefix":"224"},["225","226"],"The unique prefix (or identifier) for this vault configuration. Use this prefix to load the right vault configuration and implementation when referencing secrets with the other entities.\n",["144"],"The name of the vault that's being added. The vault implementation must be installed in every Kong instance.\n",["144"],"The description of the vault object.\n",["205"],"The configuration properties for the vault, which can be found on the vaults' documentation page.\n",{"prefix":"227"},"An optional set of strings associated with the vault, used for grouping and filtering.\n",{"type":"102"},"ENV_PREFIX","foo","bar","null","SSL_","database-credentials","data-plane",{"type":"102","examples":"228"},["224"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-key",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all Keys",["17"],"1fd9d60b5a9d8","get","/keys",["18"],{},"list-key","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Keys",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],[],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"4602f2db096a2","81cdefbae8e6f","200",[],["47"],"A successful response listing Keys","21bdedde19d24","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"51","examples":"64","description":"65","schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"820711b024ab0","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"88","$schema":"89","x-stoplight":"90"},["91","92","93","94","95"],"fd6b58a64c8a3","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"96","$schema":"89","x-stoplight":"97"},["91","92","93","94","95"],"2764789f38e08","tags",["98"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"96","examples":"99","x-stoplight":"100","$schema":"89"},["91","101","92","93","94","95"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109","enum":"110"},"69bd39eb3d511","application/json",[],[],{"properties":"111","$schema":"89","x-stoplight":"112"},"5b3fce506d903",["113","114","115"],[],{"type":"116","properties":"117","required":"118","title":"119","$schema":"89","x-stoplight":"120"},"integer","http://json-schema.org/draft-07/schema#",{"id":"121"},"description","in","name","schema","title","string",{"id":"122"},{"id":"123","value":"124","key":"125"},["124"],{"explicitProperties":"126","id":"127"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["108","128"],{"data":"129","offset":"130"},{"id":"131"},{"id":"132","key":"133","value":"134","summary":"135"},{"id":"136","key":"137","value":"138","summary":"139"},{"id":"140","key":"141","value":"142","summary":"143"},"object",{"status":"144","message":"145"},["146","147"],"UnauthorizedError",{"id":"148"},"02439322228f2","f91871c8c90eb","6fc0462aa82f5","tag1,tag2","default",["149","150","151"],"cac272d135242","https",{"items":"152","type":"153"},{"description":"154","type":"96","title":"155"},"b766d14c19905","76e8351ddf0bc","DuplicateApiKey",{"message":"135","status":401},"Duplicate API key found","452b9e8e12e91","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","d81bce05f1da2","NoAPIKey",{"message":"156","status":401},"No API key found",{"type":"88"},{"type":"96"},"status","message","470b68e5f0549","type","nullable","examples",{"description":"157","properties":"158","type":"116","title":"159","examples":"160"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","No API key found in request","A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.",{"created_at":"161","id":"162","jwk":"163","kid":"164","name":"165","pem":"166","set":"167","tags":"168","updated_at":"169"},"Key",["170"],{"description":"171","type":"88"},{"type":"96"},{"description":"172","type":"96"},{"description":"173","type":"96"},{"description":"174","type":"96"},{"description":"175","properties":"176","type":"116"},{"additionalProperties":false,"description":"177","properties":"178","type":"116"},{"description":"179","items":"180","type":"153"},{"description":"181","type":"88"},{"id":"182","jwk":"183","kid":"184","name":"185","pem":"186","set":"187"},"Unix epoch when the resource was created.","A JSON Web Key represented as a string.","A unique identifier for a key.","The name to associate with the given keys.","A keypair in PEM format.",{"private_key":"188","public_key":"189"},"The id (an UUID) of the key-set with which to associate the key.",{"id":"190"},"An optional set of strings associated with the Key for grouping and filtering.",{"type":"96"},"Unix epoch when the resource was last updated.","d958f66b-8e99-44d2-b0b4-edd5bbf24658","{\"alg\":\"RSA\", \"kid\": \"42\", ...}","42","a-key",{"private_key":"191","public_key":"191"},{"id":"192"},{"type":"96"},{"type":"96"},{"type":"96"},"-----BEGIN","b86b331c-dcd0-4b3e-97ce-47c5a9543031"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-key",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create a new Key",["18"],"2ed183892c75c","post","/keys",["19"],{},"create-key","This API endpoint allows you to create a new key. When the request is successful, the API will respond with a 200 status code and a JSON object that represents the newly created key. If the request is invalid, the API will respond with a 400 status code and an error message in the response body.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Keys",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],[],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"4602f2db096a2","5eb9e2d6cfc25","200",[],["55"],"Successfully created Key","bed9e4b39ff39","400",[],["56"],"Invalid Key","bec9e4b39f8ee","401",[],["57"],"Unauthorized","652fe7597cbee",["58"],"The request body for creating a new key entity.",{"id":"59","key":"60","extensions":"61","description":"62","type":"63","name":"64","in":"65"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"66","path":"67","port":"68","protocol":"69"},{"id":"70","mediaType":"71","examples":"72","encodings":"73","schema":"74"},{"id":"75","mediaType":"71","examples":"76","encodings":"77","schema":"78"},{"id":"79","mediaType":"71","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"71","examples":"84","encodings":"85","schema":"86"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"87","description":"88"},{"default":"89","description":"90"},{"default":"91","description":"92"},{"default":"93","description":"94","enum":"95"},"f1c5d6a2eef26","application/json",["96"],[],{"description":"97","properties":"98","type":"99","title":"100","examples":"101"},"9990ab79b1d8e",[],[],{"type":"99","$schema":"102","x-stoplight":"103"},"9b0a4f3dda2e6",["104","105","106"],[],{"type":"99","properties":"107","required":"108","title":"109","$schema":"102","x-stoplight":"110"},"612f0b4c956a9",[],[],{"type":"99","x-examples":"111","properties":"112","required":"113","$schema":"102","x-stoplight":"114"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["93","115"],{"id":"116","value":"117","key":"118"},"A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.",{"created_at":"119","id":"120","jwk":"121","kid":"122","name":"123","pem":"124","set":"125","tags":"126","updated_at":"127"},"object","Key",["117"],"http://json-schema.org/draft-07/schema#",{"id":"128"},{"id":"129","key":"130","value":"131","summary":"132"},{"id":"133","key":"134","value":"135","summary":"136"},{"id":"137","key":"138","value":"139","summary":"140"},{"status":"141","message":"142"},["143","144"],"UnauthorizedError",{"id":"145"},{"Example 1":"146"},{"set":"147","name":"148","kid":"149","jwk":"150","pem":"151","tags":"152"},["153"],{"id":"154"},"https","5d16c027efc0c",{"id":"155","jwk":"156","kid":"157","name":"158","pem":"159","set":"160"},"default",{"description":"161","type":"162"},{"type":"163"},{"description":"164","type":"163"},{"description":"165","type":"163"},{"description":"166","type":"163"},{"description":"167","properties":"168","type":"99"},{"additionalProperties":false,"description":"169","properties":"170","type":"99"},{"description":"171","items":"172","type":"173"},{"description":"174","type":"162"},"b91f398c0773d","7122441af24bd","DuplicateApiKey",{"message":"132","status":401},"Duplicate API key found","4b0f470df4767","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","32ad5a7a52ab6","NoAPIKey",{"message":"175","status":401},"No API key found",{"type":"162"},{"type":"163"},"status","message","470b68e5f0549",{"set":"176","name":"177","kid":"157","jwk":"156","pem":"178","tags":"179"},{"type":"99","description":"180","properties":"181"},{"type":"163","description":"182","examples":"183"},{"type":"163","description":"184","examples":"185"},{"type":"163","description":"164","examples":"186"},{"type":"99","description":"187","properties":"188"},{"type":"173","description":"189","items":"190"},"kid","06145762ea39d","d958f66b-8e99-44d2-b0b4-edd5bbf24658","{\"alg\":\"RSA\", \"kid\": \"42\", ...}","42","a-key",{"private_key":"191","public_key":"191"},{"id":"192"},"Unix epoch when the resource was created.","integer","string","A JSON Web Key represented as a string.","A unique identifier for a key.","The name to associate with the given keys.","A keypair in PEM format.",{"private_key":"193","public_key":"194"},"The id (an UUID) of the key-set with which to associate the key.",{"id":"195"},"An optional set of strings associated with the Key for grouping and filtering.",{"type":"163"},"array","Unix epoch when the resource was last updated.","No API key found in request",{"id":"196"},"my-key",{"private_key":"191","public_key":"191"},["197","198"],"The id (an UUID) of the key-set with which to associate the key .With form-encoded, the notation is `set.id=<set id>` or `set.name=<set name>`. With JSON, use `\"set\":{\"id\":\"<set id>\"}` or `\"set\":{\"name\":\"<set name>\"}.`",{"id":"199"},"The name to associate with the given keys.\n",["177"],"A unique identifier for a key.\n",["157"],["200"],"A keypair in PEM format.\n",{"private_key":"201","public_key":"202"},"An optional set of strings associated with the Key for grouping and filtering.\n",{"type":"163"},"-----BEGIN","b86b331c-dcd0-4b3e-97ce-47c5a9543031",{"type":"163"},{"type":"163"},{"type":"163"},"46CA83EE-671C-11ED-BFAB-2FE47512C77A","application-a","public-key-xyz",{"type":"163","description":"196"},"{\\\"alg\\\":\\\"RSA\\\", \\\"kid\\\": \\\"42\\\", ...}",{"type":"163","examples":"203"},{"type":"163","examples":"204"},["205"],["206"],"private_key\": \"-----BEGIN","public_key\": \"-----BEGIN"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-key",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a Key",["17"],"f0b347a3f4f72","delete","/keys/{key_id_or_name}",["18"],{},"delete-key","inheritedFromService",["19"],{"headers":"20","query":"21","cookie":"22","path":"23"},["24"],["25"],"Keys",{"id":"26","name":"17"},{"id":"27","code":"28","headers":"29","contents":"30","description":"31"},[],[],[],["32"],["33"],{"id":"34","url":"35","name":"36","description":"37","variables":"38"},"4602f2db096a2","c3c1af25ad81d","204",[],[],"Successfully deleted Key or the resource didn't exist",{"id":"39","name":"40","style":"41","examples":"42","description":"43","required":true,"schema":"44","explicitProperties":"45"},{"id":"46","key":"47","extensions":"48","description":"49","type":"50","name":"51","in":"52"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"53","path":"54","port":"55","protocol":"56"},"cd5820a637344","key_id_or_name","simple",[],"The unique identifier or the name of the Key to retrieve.",{"type":"57","examples":"58","$schema":"59","x-stoplight":"60"},["61","62","63","64","65","66"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"string",["76"],"http://json-schema.org/draft-07/schema#",{"id":"77"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","78"],"24D0DBDA-671C-11ED-BA0B-EF1DCCD3725","b700185284d97","https"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-key",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a Key",["18"],"6dd9e45d1bb6d","get","/keys/{key_id_or_name}",["19"],{},"get-key","Get a Key using ID or name.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Keys",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45"],["46"],{"id":"47","url":"48","name":"49","description":"50","variables":"51"},"4602f2db096a2","419dabddb08d1","200",[],["52"],"Successfully fetched Key","e16daa00e0b8d","401",[],["53"],"Unauthorized","e1bdaa00e0202","404",[],[],"Resource does not exist",{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},{"id":"77","mediaType":"73","examples":"78","encodings":"79","schema":"80"},"8868e62b88c1c","key_id_or_name","simple",[],"The unique identifier or the name of the Key to retrieve.",{"type":"81","examples":"82","$schema":"83","x-stoplight":"84"},["85","86","87","88","89","90"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"8be65f53363dd","application/json",["100"],[],{"description":"101","properties":"102","type":"103","title":"104","examples":"105"},"e7a29c2f5bfd0",["106","107","108"],[],{"type":"103","properties":"109","required":"110","title":"111","$schema":"83","x-stoplight":"112"},"string",["113"],"http://json-schema.org/draft-07/schema#",{"id":"114"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","115"],{"id":"116","value":"117","key":"118"},"A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.",{"created_at":"119","id":"120","jwk":"121","kid":"122","name":"123","pem":"124","set":"125","tags":"126","updated_at":"127"},"object","Key",["117"],{"id":"128","key":"129","value":"130","summary":"131"},{"id":"132","key":"133","value":"134","summary":"135"},{"id":"136","key":"137","value":"138","summary":"139"},{"status":"140","message":"141"},["142","143"],"UnauthorizedError",{"id":"144"},"24D0DBDA-671C-11ED-BA0B-EF1DCCD3725","2868c839ec4a7","https","2088b36db8c20",{"id":"145","jwk":"146","kid":"147","name":"148","pem":"149","set":"150"},"default",{"description":"151","type":"152"},{"type":"81"},{"description":"153","type":"81"},{"description":"154","type":"81"},{"description":"155","type":"81"},{"description":"156","properties":"157","type":"103"},{"additionalProperties":false,"description":"158","properties":"159","type":"103"},{"description":"160","items":"161","type":"162"},{"description":"163","type":"152"},"c71e9f45bddd6","DuplicateApiKey",{"message":"131","status":401},"Duplicate API key found","4beae2054b709","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","fc0e7589732f5","NoAPIKey",{"message":"164","status":401},"No API key found",{"type":"152"},{"type":"81"},"status","message","470b68e5f0549","d958f66b-8e99-44d2-b0b4-edd5bbf24658","{\"alg\":\"RSA\", \"kid\": \"42\", ...}","42","a-key",{"private_key":"165","public_key":"165"},{"id":"166"},"Unix epoch when the resource was created.","integer","A JSON Web Key represented as a string.","A unique identifier for a key.","The name to associate with the given keys.","A keypair in PEM format.",{"private_key":"167","public_key":"168"},"The id (an UUID) of the key-set with which to associate the key.",{"id":"169"},"An optional set of strings associated with the Key for grouping and filtering.",{"type":"81"},"array","Unix epoch when the resource was last updated.","No API key found in request","-----BEGIN","b86b331c-dcd0-4b3e-97ce-47c5a9543031",{"type":"81"},{"type":"81"},{"type":"81"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-key",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update a Key",["17"],"64a16a3a91a93","patch","/keys/{key_id_or_name}",["18"],{},"update-key","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Keys",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54"],["55"],{"id":"56","url":"57","name":"58","description":"59","variables":"60"},"4602f2db096a2","cc7a705c56434","200",[],["61"],"Successfully updated Key","a45a6e96adcc5","400",[],["62"],"Invalid Key","a44a6e96adf16","401",[],["63"],"Unauthorized","a49a6e96ae789","404",[],[],"Resource does not exist","d18380fdcc59c",["64"],"The request body for creating a new key entity.",{"id":"65","name":"66","style":"67","examples":"68","description":"69","required":true,"schema":"70","explicitProperties":"71"},{"id":"72","key":"73","extensions":"74","description":"75","type":"76","name":"77","in":"78"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"79","path":"80","port":"81","protocol":"82"},{"id":"83","mediaType":"84","examples":"85","encodings":"86","schema":"87"},{"id":"88","mediaType":"84","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"84","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"84","examples":"97","encodings":"98","schema":"99"},"f11351a6d3c3d","key_id_or_name","simple",[],"The unique identifier or the name of the Key to retrieve.",{"type":"100","examples":"101","$schema":"102","x-stoplight":"103"},["104","105","106","107","108","109"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"110","description":"111"},{"default":"112","description":"113"},{"default":"114","description":"115"},{"default":"116","description":"117","enum":"118"},"f518df71d7b71","application/json",["119"],[],{"description":"120","properties":"121","type":"122","title":"123","examples":"124"},"0fad9b777da34",[],[],{"type":"122","$schema":"102","x-stoplight":"125"},"6a06e371072b3",["126","127","128"],[],{"type":"122","properties":"129","required":"130","title":"131","$schema":"102","x-stoplight":"132"},"1ac65ecc94225",[],[],{"type":"122","x-examples":"133","properties":"134","required":"135","$schema":"102","x-stoplight":"136"},"string",["137"],"http://json-schema.org/draft-07/schema#",{"id":"138"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["116","139"],{"id":"140","value":"141","key":"142"},"A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.",{"created_at":"143","id":"144","jwk":"145","kid":"146","name":"147","pem":"148","set":"149","tags":"150","updated_at":"151"},"object","Key",["141"],{"id":"152"},{"id":"153","key":"154","value":"155","summary":"156"},{"id":"157","key":"158","value":"159","summary":"160"},{"id":"161","key":"162","value":"163","summary":"164"},{"status":"165","message":"166"},["167","168"],"UnauthorizedError",{"id":"169"},{"Example 1":"170"},{"set":"171","name":"172","kid":"173","jwk":"174","pem":"175","tags":"176"},["177"],{"id":"178"},"24D0DBDA-671C-11ED-BA0B-EF1DCCD3725","5b5639875d881","https","801affc8483e6",{"id":"179","jwk":"180","kid":"181","name":"182","pem":"183","set":"184"},"default",{"description":"185","type":"186"},{"type":"100"},{"description":"187","type":"100"},{"description":"188","type":"100"},{"description":"189","type":"100"},{"description":"190","properties":"191","type":"122"},{"additionalProperties":false,"description":"192","properties":"193","type":"122"},{"description":"194","items":"195","type":"196"},{"description":"197","type":"186"},"1b856166808d8","9745d3a8252fc","DuplicateApiKey",{"message":"156","status":401},"Duplicate API key found","8d604c6c3d213","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","279f9410fca12","NoAPIKey",{"message":"198","status":401},"No API key found",{"type":"186"},{"type":"100"},"status","message","470b68e5f0549",{"set":"199","name":"200","kid":"181","jwk":"180","pem":"201","tags":"202"},{"type":"122","description":"203","properties":"204"},{"type":"100","description":"205","examples":"206"},{"type":"100","description":"207","examples":"208"},{"type":"100","description":"187","examples":"209"},{"type":"122","description":"210","properties":"211"},{"type":"196","description":"212","items":"213"},"kid","06145762ea39d","d958f66b-8e99-44d2-b0b4-edd5bbf24658","{\"alg\":\"RSA\", \"kid\": \"42\", ...}","42","a-key",{"private_key":"214","public_key":"214"},{"id":"215"},"Unix epoch when the resource was created.","integer","A JSON Web Key represented as a string.","A unique identifier for a key.","The name to associate with the given keys.","A keypair in PEM format.",{"private_key":"216","public_key":"217"},"The id (an UUID) of the key-set with which to associate the key.",{"id":"218"},"An optional set of strings associated with the Key for grouping and filtering.",{"type":"100"},"array","Unix epoch when the resource was last updated.","No API key found in request",{"id":"219"},"my-key",{"private_key":"214","public_key":"214"},["220","221"],"The id (an UUID) of the key-set with which to associate the key .With form-encoded, the notation is `set.id=<set id>` or `set.name=<set name>`. With JSON, use `\"set\":{\"id\":\"<set id>\"}` or `\"set\":{\"name\":\"<set name>\"}.`",{"id":"222"},"The name to associate with the given keys.\n",["200"],"A unique identifier for a key.\n",["181"],["223"],"A keypair in PEM format.\n",{"private_key":"224","public_key":"225"},"An optional set of strings associated with the Key for grouping and filtering.\n",{"type":"100"},"-----BEGIN","b86b331c-dcd0-4b3e-97ce-47c5a9543031",{"type":"100"},{"type":"100"},{"type":"100"},"46CA83EE-671C-11ED-BFAB-2FE47512C77A","application-a","public-key-xyz",{"type":"100","description":"219"},"{\\\"alg\\\":\\\"RSA\\\", \\\"kid\\\": \\\"42\\\", ...}",{"type":"100","examples":"226"},{"type":"100","examples":"227"},["228"],["229"],"private_key\": \"-----BEGIN","public_key\": \"-----BEGIN"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-key",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a Key",["18"],"b22da61e99742","put","/keys/{key_id_or_name}",["19"],{},"upsert-key","Create or update a key using ID or name.\n","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Keys",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"4602f2db096a2","17f6eed56081c","200",[],["56"],"Successfully upserted Key","8296ee43f03d2","400",[],["57"],"Invalid Key","8286ee43f056d","401",[],["58"],"Unauthorized","bf174a009cd47",["59"],"The request body for creating a new key entity.",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"79","examples":"84","encodings":"85","schema":"86"},{"id":"87","mediaType":"79","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"79","examples":"92","encodings":"93","schema":"94"},"3791e1a5b0dde","key_id_or_name","simple",[],"The unique identifier or the name of the Key to retrieve.",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110"},{"default":"111","description":"112","enum":"113"},"2d021daf5ce97","application/json",["114"],[],{"description":"115","properties":"116","type":"117","title":"118","examples":"119"},"2823c950f8a9b",[],[],{"type":"117","$schema":"97","x-stoplight":"120"},"aaf9752ab9276",["121","122","123"],[],{"type":"117","properties":"124","required":"125","title":"126","$schema":"97","x-stoplight":"127"},"3b39d840b9542",[],[],{"type":"117","x-examples":"128","properties":"129","required":"130","$schema":"97","x-stoplight":"131"},"string",["132"],"http://json-schema.org/draft-07/schema#",{"id":"133"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["111","134"],{"id":"135","value":"136","key":"137"},"A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.",{"created_at":"138","id":"139","jwk":"140","kid":"141","name":"142","pem":"143","set":"144","tags":"145","updated_at":"146"},"object","Key",["136"],{"id":"147"},{"id":"148","key":"149","value":"150","summary":"151"},{"id":"152","key":"153","value":"154","summary":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"status":"160","message":"161"},["162","163"],"UnauthorizedError",{"id":"164"},{"Example 1":"165"},{"set":"166","name":"167","kid":"168","jwk":"169","pem":"170","tags":"171"},["172"],{"id":"173"},"24D0DBDA-671C-11ED-BA0B-EF1DCCD3725","ac8e4a4c595a9","https","cb73d912c7b37",{"id":"174","jwk":"175","kid":"176","name":"177","pem":"178","set":"179"},"default",{"description":"180","type":"181"},{"type":"95"},{"description":"182","type":"95"},{"description":"183","type":"95"},{"description":"184","type":"95"},{"description":"185","properties":"186","type":"117"},{"additionalProperties":false,"description":"187","properties":"188","type":"117"},{"description":"189","items":"190","type":"191"},{"description":"192","type":"181"},"6ab9bcb6bcd74","da97b1f0eefff","DuplicateApiKey",{"message":"151","status":401},"Duplicate API key found","2f5d5dd017f63","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","7cd63c742ae1b","NoAPIKey",{"message":"193","status":401},"No API key found",{"type":"181"},{"type":"95"},"status","message","470b68e5f0549",{"set":"194","name":"195","kid":"176","jwk":"175","pem":"196","tags":"197"},{"type":"117","description":"198","properties":"199"},{"type":"95","description":"200","examples":"201"},{"type":"95","description":"202","examples":"203"},{"type":"95","description":"182","examples":"204"},{"type":"117","description":"205","properties":"206"},{"type":"191","description":"207","items":"208"},"kid","06145762ea39d","d958f66b-8e99-44d2-b0b4-edd5bbf24658","{\"alg\":\"RSA\", \"kid\": \"42\", ...}","42","a-key",{"private_key":"209","public_key":"209"},{"id":"210"},"Unix epoch when the resource was created.","integer","A JSON Web Key represented as a string.","A unique identifier for a key.","The name to associate with the given keys.","A keypair in PEM format.",{"private_key":"211","public_key":"212"},"The id (an UUID) of the key-set with which to associate the key.",{"id":"213"},"An optional set of strings associated with the Key for grouping and filtering.",{"type":"95"},"array","Unix epoch when the resource was last updated.","No API key found in request",{"id":"214"},"my-key",{"private_key":"209","public_key":"209"},["215","216"],"The id (an UUID) of the key-set with which to associate the key .With form-encoded, the notation is `set.id=<set id>` or `set.name=<set name>`. With JSON, use `\"set\":{\"id\":\"<set id>\"}` or `\"set\":{\"name\":\"<set name>\"}.`",{"id":"217"},"The name to associate with the given keys.\n",["195"],"A unique identifier for a key.\n",["176"],["218"],"A keypair in PEM format.\n",{"private_key":"219","public_key":"220"},"An optional set of strings associated with the Key for grouping and filtering.\n",{"type":"95"},"-----BEGIN","b86b331c-dcd0-4b3e-97ce-47c5a9543031",{"type":"95"},{"type":"95"},{"type":"95"},"46CA83EE-671C-11ED-BFAB-2FE47512C77A","application-a","public-key-xyz",{"type":"95","description":"214"},"{\\\"alg\\\":\\\"RSA\\\", \\\"kid\\\": \\\"42\\\", ...}",{"type":"95","examples":"221"},{"type":"95","examples":"222"},["223"],["224"],"private_key\": \"-----BEGIN","public_key\": \"-----BEGIN"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-key-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all Keys in a workspace",["17"],"f3d0ec5b770d2","get","/{workspace}/keys",["18"],{},"list-key-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Keys",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],["41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"4602f2db096a2","4c225ceeb3bbb","200",[],["48"],"OK","86b25c462a727","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"71","examples":"72","description":"73","required":true,"schema":"74","explicitProperties":"75"},{"id":"76","key":"77","extensions":"78","description":"79","type":"80","name":"81","in":"82"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"83","path":"84","port":"85","protocol":"86"},{"id":"87","mediaType":"88","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"88","examples":"93","encodings":"94","schema":"95"},"863915031d633","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103"],"86eb955d472b4","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"104","$schema":"97","x-stoplight":"105"},["99","100","101","102","103"],"a2179b741ea54","tags",["106"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"104","examples":"107","x-stoplight":"108","$schema":"97"},["99","109","100","101","102","103"],"ef443ef00a265","workspace","simple",[],"Name or ID of workspace",{"type":"104","examples":"110","$schema":"97","x-stoplight":"111"},["101","100","112","102","99","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"822628ee61385","application/json",["122","123"],[],{"description":"124","properties":"125","type":"126","title":"127","examples":"128"},"d8acd3461b7e0",["129","130","131"],[],{"type":"126","properties":"132","required":"133","title":"134","$schema":"97","x-stoplight":"135"},"integer","http://json-schema.org/draft-07/schema#",{"id":"136"},"description","in","name","schema","title","string",{"id":"137"},{"id":"138","value":"139","key":"140"},["139"],{"explicitProperties":"141","id":"142"},"example",["143"],{"id":"144"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","145"],{"id":"146","value":"147","key":"140"},{"id":"148","key":"149","value":"150"},"A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.",{"created_at":"151","id":"152","jwk":"153","kid":"154","name":"155","pem":"156","set":"157","tags":"158","updated_at":"159"},"object","Key",["147"],{"id":"160","key":"161","value":"162","summary":"163"},{"id":"164","key":"165","value":"166","summary":"167"},{"id":"168","key":"169","value":"170","summary":"171"},{"status":"172","message":"173"},["174","175"],"UnauthorizedError",{"id":"176"},"6d7e96c104200","8a137a702038e","151c403e23d75","tag1,tag2","default",["177","178","179"],"acb6ce6cfd5c5","team-a","3c1b99361f507","https","c59b20147fbcd",{"id":"180","jwk":"181","kid":"182","name":"183","pem":"184","set":"185"},"a6999783608c7","Example 1",{"id":"180","jwk":"181","kid":"182","name":"183","pem":"186","set":"187"},{"description":"188","type":"96"},{"type":"104"},{"description":"189","type":"104"},{"description":"190","type":"104"},{"description":"191","type":"104"},{"description":"192","properties":"193","type":"126"},{"additionalProperties":false,"description":"194","properties":"195","type":"126"},{"description":"196","items":"197","type":"198"},{"description":"199","type":"96"},"e365f83501828","DuplicateApiKey",{"message":"163","status":401},"Duplicate API key found","1450421d53fda","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","ca1e862bfa8b2","NoAPIKey",{"message":"200","status":401},"No API key found",{"type":"96"},{"type":"104"},"status","message","470b68e5f0549","type","nullable","examples","d958f66b-8e99-44d2-b0b4-edd5bbf24658","{\"alg\":\"RSA\", \"kid\": \"42\", ...}","42","a-key",{"private_key":"201","public_key":"201"},{"id":"202"},{"private_key":"201","public_key":"201"},{"id":"202"},"Unix epoch when the resource was created.","A JSON Web Key represented as a string.","A unique identifier for a key.","The name to associate with the given keys.","A keypair in PEM format.",{"private_key":"203","public_key":"204"},"The id (an UUID) of the key-set with which to associate the key.",{"id":"205"},"An optional set of strings associated with the Key for grouping and filtering.",{"type":"104"},"array","Unix epoch when the resource was last updated.","No API key found in request","-----BEGIN","b86b331c-dcd0-4b3e-97ce-47c5a9543031",{"type":"104"},{"type":"104"},{"type":"104"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-key-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new Key in a workspace",["17"],"81582706a7aea","post","/{workspace}/keys",["18"],{},"create-key-in-workspace","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Keys",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48"],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"4602f2db096a2","8d3989a7c9ef6","200",[],["55"],"Successfully created Key","bfd988ff328df","400",[],["56"],"Invalid Key","bfc988ff32910","401",[],["57"],"Unauthorized","9c5336da19d4a",["58"],"The request body for creating a new key entity.",{"id":"59","name":"60","style":"61","examples":"62","description":"63","required":true,"schema":"64","explicitProperties":"65"},{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},{"id":"86","mediaType":"78","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"78","examples":"91","encodings":"92","schema":"93"},"ebe1a34f47e4e","workspace","simple",[],"Name or ID of workspace",{"type":"94","examples":"95","$schema":"96","x-stoplight":"97"},["98","99","100","101","102","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111","enum":"112"},"18ef1d8829555","application/json",["113","114"],[],{"description":"115","properties":"116","type":"117","title":"118","examples":"119"},"084d28332977c",[],[],{"type":"117","$schema":"96","x-stoplight":"120"},"42e68dcaaa73e",["121","122","123"],[],{"type":"117","properties":"124","required":"125","title":"126","$schema":"96","x-stoplight":"127"},"86809868fc7da",[],[],{"type":"117","x-examples":"128","properties":"129","required":"130","$schema":"96","x-stoplight":"131"},"string",["132"],"http://json-schema.org/draft-07/schema#",{"id":"133"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["110","134"],{"id":"135","value":"136","key":"137"},{"id":"138","key":"34","value":"139"},"A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.",{"created_at":"140","id":"141","jwk":"142","kid":"143","name":"144","pem":"145","set":"146","tags":"147","updated_at":"148"},"object","Key",["136"],{"id":"149"},{"id":"150","key":"151","value":"152","summary":"153"},{"id":"154","key":"155","value":"156","summary":"157"},{"id":"158","key":"159","value":"160","summary":"161"},{"status":"162","message":"163"},["164","165"],"UnauthorizedError",{"id":"166"},{"Example 1":"167"},{"set":"168","name":"169","kid":"170","jwk":"171","pem":"172","tags":"173"},["174"],{"id":"175"},"team-a","d665f036a7104","https","4e267f48db148",{"id":"176","jwk":"177","kid":"178","name":"179","pem":"180","set":"181"},"default","ea611d3f12ec9",{"id":"176","jwk":"177","kid":"178","name":"179","pem":"182","set":"183"},{"description":"184","type":"185"},{"type":"94"},{"description":"186","type":"94"},{"description":"187","type":"94"},{"description":"188","type":"94"},{"description":"189","properties":"190","type":"117"},{"additionalProperties":false,"description":"191","properties":"192","type":"117"},{"description":"193","items":"194","type":"195"},{"description":"196","type":"185"},"98cbdc727212d","aa3218ca154ea","DuplicateApiKey",{"message":"153","status":401},"Duplicate API key found","9c517e4933b7b","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","f41966edc6338","NoAPIKey",{"message":"197","status":401},"No API key found",{"type":"185"},{"type":"94"},"status","message","470b68e5f0549",{"set":"198","name":"199","kid":"178","jwk":"177","pem":"200","tags":"201"},{"type":"117","description":"202","properties":"203"},{"type":"94","description":"204","examples":"205"},{"type":"94","description":"206","examples":"207"},{"type":"94","description":"186","examples":"208"},{"type":"117","description":"209","properties":"210"},{"type":"195","description":"211","items":"212"},"kid","06145762ea39d","d958f66b-8e99-44d2-b0b4-edd5bbf24658","{\"alg\":\"RSA\", \"kid\": \"42\", ...}","42","a-key",{"private_key":"213","public_key":"213"},{"id":"214"},{"private_key":"213","public_key":"213"},{"id":"214"},"Unix epoch when the resource was created.","integer","A JSON Web Key represented as a string.","A unique identifier for a key.","The name to associate with the given keys.","A keypair in PEM format.",{"private_key":"215","public_key":"216"},"The id (an UUID) of the key-set with which to associate the key.",{"id":"217"},"An optional set of strings associated with the Key for grouping and filtering.",{"type":"94"},"array","Unix epoch when the resource was last updated.","No API key found in request",{"id":"218"},"my-key",{"private_key":"213","public_key":"213"},["219","220"],"The id (an UUID) of the key-set with which to associate the key .With form-encoded, the notation is `set.id=<set id>` or `set.name=<set name>`. With JSON, use `\"set\":{\"id\":\"<set id>\"}` or `\"set\":{\"name\":\"<set name>\"}.`",{"id":"221"},"The name to associate with the given keys.\n",["199"],"A unique identifier for a key.\n",["178"],["222"],"A keypair in PEM format.\n",{"private_key":"223","public_key":"224"},"An optional set of strings associated with the Key for grouping and filtering.\n",{"type":"94"},"-----BEGIN","b86b331c-dcd0-4b3e-97ce-47c5a9543031",{"type":"94"},{"type":"94"},{"type":"94"},"46CA83EE-671C-11ED-BFAB-2FE47512C77A","application-a","public-key-xyz",{"type":"94","description":"218"},"{\\\"alg\\\":\\\"RSA\\\", \\\"kid\\\": \\\"42\\\", ...}",{"type":"94","examples":"225"},{"type":"94","examples":"226"},["227"],["228"],"private_key\": \"-----BEGIN","public_key\": \"-----BEGIN"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-key-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a Key in a workspace",["17"],"707712f1b7114","delete","/{workspace}/keys/{key_id_or_name}",["18"],{},"delete-key-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Keys",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38","39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"4602f2db096a2","c3e168f642ba3","204",[],[],"Successfully deleted Key or the resource didn't exist","9bf167309936f","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","name":"55","style":"49","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","key":"61","extensions":"62","description":"63","type":"64","name":"65","in":"66"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"67","path":"68","port":"69","protocol":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},"dbcef2289a19c","workspace","simple",[],"Name or ID of workspace",{"type":"76","examples":"77","$schema":"78","x-stoplight":"79"},["80","81","82","83","84","85"],"af533bc6d7971","key_id_or_name",[],"The unique identifier or the name of the Key to retrieve.",{"type":"76","examples":"86","$schema":"78","x-stoplight":"87"},["80","81","82","83","84","85"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95","enum":"96"},"f74bee2aa52d0","application/json",["97","98","99"],[],{"type":"100","properties":"101","required":"102","title":"103","$schema":"78","x-stoplight":"104"},"string",["105"],"http://json-schema.org/draft-07/schema#",{"id":"106"},"name","in","required","schema","description","title",["107"],{"id":"108"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["94","109"],{"id":"110","key":"111","value":"112","summary":"113"},{"id":"114","key":"115","value":"116","summary":"117"},{"id":"118","key":"119","value":"120","summary":"121"},"object",{"status":"122","message":"123"},["124","125"],"UnauthorizedError",{"id":"126"},"team-a","e1dc9a9c95312","24D0DBDA-671C-11ED-BA0B-EF1DCCD3725","b2965da55d982","https","08aed604dc8a6","DuplicateApiKey",{"message":"113","status":401},"Duplicate API key found","57f27eb006b48","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","f5b3db16febf6","NoAPIKey",{"message":"127","status":401},"No API key found",{"type":"128"},{"type":"76"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-key-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a Key in a workspace",["18"],"a479232b6c2f6","get","/{workspace}/keys/{key_id_or_name}",["19"],{},"get-key-in-workspace","Get a Key using ID or name in a workspace.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Keys",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46"],["47"],{"id":"48","url":"49","name":"50","description":"51","variables":"52"},"4602f2db096a2","9162813ea0341","200",[],["53"],"Successfully fetched Key","8ed281e16a6bc","401",[],["54"],"Unauthorized","8e8281e169e33","404",[],[],"Resource does not exist",{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"57","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"9ef91f3acdd66","workspace","simple",[],"Name or ID of workspace",{"type":"88","examples":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96","97"],"4f05f88355fd0","key_id_or_name",[],"The unique identifier or the name of the Key to retrieve.",{"type":"88","examples":"98","$schema":"90","x-stoplight":"99"},["92","93","94","95","96","97"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107","enum":"108"},"471e1522cff23","application/json",["109","110"],[],{"description":"111","properties":"112","type":"113","title":"114","examples":"115"},"ec73aa3bcbf60",["116","117","118"],[],{"type":"113","properties":"119","required":"120","title":"121","$schema":"90","x-stoplight":"122"},"string",["123"],"http://json-schema.org/draft-07/schema#",{"id":"124"},"name","in","required","schema","description","title",["125"],{"id":"126"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["106","127"],{"id":"128","value":"129","key":"130"},{"id":"131","key":"132","value":"133"},"A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.",{"created_at":"134","id":"135","jwk":"136","kid":"137","name":"138","pem":"139","set":"140","tags":"141","updated_at":"142"},"object","Key",["129"],{"id":"143","key":"144","value":"145","summary":"146"},{"id":"147","key":"148","value":"149","summary":"150"},{"id":"151","key":"152","value":"153","summary":"154"},{"status":"155","message":"156"},["157","158"],"UnauthorizedError",{"id":"159"},"team-a","7eb3819e1bb71","24D0DBDA-671C-11ED-BA0B-EF1DCCD3725","3fe406d10f13b","https","ff3f3f40f25a0",{"id":"160","jwk":"161","kid":"162","name":"163","pem":"164","set":"165"},"default","d0139c818aadb","Example 1",{"id":"160","jwk":"161","kid":"162","name":"163","pem":"166","set":"167"},{"description":"168","type":"169"},{"type":"88"},{"description":"170","type":"88"},{"description":"171","type":"88"},{"description":"172","type":"88"},{"description":"173","properties":"174","type":"113"},{"additionalProperties":false,"description":"175","properties":"176","type":"113"},{"description":"177","items":"178","type":"179"},{"description":"180","type":"169"},"48687e8fed90a","DuplicateApiKey",{"message":"146","status":401},"Duplicate API key found","b0595d9a6b316","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","ce2c3f2d6849d","NoAPIKey",{"message":"181","status":401},"No API key found",{"type":"169"},{"type":"88"},"status","message","470b68e5f0549","d958f66b-8e99-44d2-b0b4-edd5bbf24658","{\"alg\":\"RSA\", \"kid\": \"42\", ...}","42","a-key",{"private_key":"182","public_key":"182"},{"id":"183"},{"private_key":"182","public_key":"182"},{"id":"183"},"Unix epoch when the resource was created.","integer","A JSON Web Key represented as a string.","A unique identifier for a key.","The name to associate with the given keys.","A keypair in PEM format.",{"private_key":"184","public_key":"185"},"The id (an UUID) of the key-set with which to associate the key.",{"id":"186"},"An optional set of strings associated with the Key for grouping and filtering.",{"type":"88"},"array","Unix epoch when the resource was last updated.","No API key found in request","-----BEGIN","b86b331c-dcd0-4b3e-97ce-47c5a9543031",{"type":"88"},{"type":"88"},{"type":"88"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-key-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update a Key in a workspace",["17"],"7a7f5a79e330a","patch","/{workspace}/keys/{key_id_or_name}",["18"],{},"update-key-in-workspace","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Keys",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54","55"],["56"],{"id":"57","url":"58","name":"59","description":"60","variables":"61"},"4602f2db096a2","a137565724f03","200",[],["62"],"Successfully updated Key","01575833f4008","400",[],["63"],"Invalid Key","01675833f43bf","401",[],["64"],"Unauthorized","01175833f3b3c","404",[],[],"Resource does not exist","50ecb637985d7",["65"],"The request body for creating a new key entity.",{"id":"66","name":"67","style":"68","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","name":"74","style":"68","examples":"75","description":"76","required":true,"schema":"77","explicitProperties":"78"},{"id":"79","key":"80","extensions":"81","description":"82","type":"83","name":"84","in":"85"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"86","path":"87","port":"88","protocol":"89"},{"id":"90","mediaType":"91","examples":"92","encodings":"93","schema":"94"},{"id":"95","mediaType":"91","examples":"96","encodings":"97","schema":"98"},{"id":"99","mediaType":"91","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"91","examples":"104","encodings":"105","schema":"106"},"2f91291f259c6","workspace","simple",[],"Name or ID of workspace",{"type":"107","examples":"108","$schema":"109","x-stoplight":"110"},["111","112","113","114","115","116"],"2d5112264fe7a","key_id_or_name",[],"The unique identifier or the name of the Key to retrieve.",{"type":"107","examples":"117","$schema":"109","x-stoplight":"118"},["111","112","113","114","115","116"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"119","description":"120"},{"default":"121","description":"122"},{"default":"123","description":"124"},{"default":"125","description":"126","enum":"127"},"9a3b841b2afd7","application/json",["128"],[],{"description":"129","properties":"130","type":"131","title":"132","examples":"133"},"552e1ebd2b802",[],[],{"type":"131","$schema":"109","x-stoplight":"134"},"09f714f64d88d",["135","136","137"],[],{"type":"131","properties":"138","required":"139","title":"140","$schema":"109","x-stoplight":"141"},"4bcecfa583227",[],[],{"type":"131","x-examples":"142","properties":"143","required":"144","$schema":"109","x-stoplight":"145"},"string",["146"],"http://json-schema.org/draft-07/schema#",{"id":"147"},"name","in","required","schema","description","title",["148"],{"id":"149"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["125","150"],{"id":"151","value":"152","key":"153"},"A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.",{"created_at":"154","id":"155","jwk":"156","kid":"157","name":"158","pem":"159","set":"160","tags":"161","updated_at":"162"},"object","Key",["152"],{"id":"163"},{"id":"164","key":"165","value":"166","summary":"167"},{"id":"168","key":"169","value":"170","summary":"171"},{"id":"172","key":"173","value":"174","summary":"175"},{"status":"176","message":"177"},["178","179"],"UnauthorizedError",{"id":"180"},{"Example 1":"181"},{"set":"182","name":"183","kid":"184","jwk":"185","pem":"186","tags":"187"},["188"],{"id":"189"},"team-a","bfc2fbf6722c6","24D0DBDA-671C-11ED-BA0B-EF1DCCD3725","064684939776e","https","6e8d6a73e86c0",{"id":"190","jwk":"191","kid":"192","name":"193","pem":"194","set":"195"},"default",{"description":"196","type":"197"},{"type":"107"},{"description":"198","type":"107"},{"description":"199","type":"107"},{"description":"200","type":"107"},{"description":"201","properties":"202","type":"131"},{"additionalProperties":false,"description":"203","properties":"204","type":"131"},{"description":"205","items":"206","type":"207"},{"description":"208","type":"197"},"be6a75741eae6","3c665665bc424","DuplicateApiKey",{"message":"167","status":401},"Duplicate API key found","20e6fdc27eb49","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","7dd58ee5462e1","NoAPIKey",{"message":"209","status":401},"No API key found",{"type":"197"},{"type":"107"},"status","message","470b68e5f0549",{"set":"210","name":"211","kid":"192","jwk":"191","pem":"212","tags":"213"},{"type":"131","description":"214","properties":"215"},{"type":"107","description":"216","examples":"217"},{"type":"107","description":"218","examples":"219"},{"type":"107","description":"198","examples":"220"},{"type":"131","description":"221","properties":"222"},{"type":"207","description":"223","items":"224"},"kid","06145762ea39d","d958f66b-8e99-44d2-b0b4-edd5bbf24658","{\"alg\":\"RSA\", \"kid\": \"42\", ...}","42","a-key",{"private_key":"225","public_key":"225"},{"id":"226"},"Unix epoch when the resource was created.","integer","A JSON Web Key represented as a string.","A unique identifier for a key.","The name to associate with the given keys.","A keypair in PEM format.",{"private_key":"227","public_key":"228"},"The id (an UUID) of the key-set with which to associate the key.",{"id":"229"},"An optional set of strings associated with the Key for grouping and filtering.",{"type":"107"},"array","Unix epoch when the resource was last updated.","No API key found in request",{"id":"230"},"my-key",{"private_key":"225","public_key":"225"},["231","232"],"The id (an UUID) of the key-set with which to associate the key .With form-encoded, the notation is `set.id=<set id>` or `set.name=<set name>`. With JSON, use `\"set\":{\"id\":\"<set id>\"}` or `\"set\":{\"name\":\"<set name>\"}.`",{"id":"233"},"The name to associate with the given keys.\n",["211"],"A unique identifier for a key.\n",["192"],["234"],"A keypair in PEM format.\n",{"private_key":"235","public_key":"236"},"An optional set of strings associated with the Key for grouping and filtering.\n",{"type":"107"},"-----BEGIN","b86b331c-dcd0-4b3e-97ce-47c5a9543031",{"type":"107"},{"type":"107"},{"type":"107"},"46CA83EE-671C-11ED-BFAB-2FE47512C77A","application-a","public-key-xyz",{"type":"107","description":"230"},"{\\\"alg\\\":\\\"RSA\\\", \\\"kid\\\": \\\"42\\\", ...}",{"type":"107","examples":"237"},{"type":"107","examples":"238"},["239"],["240"],"private_key\": \"-----BEGIN","public_key\": \"-----BEGIN"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-key-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a Key in a workspace",["18"],"f966042946c17","put","/{workspace}/keys/{key_id_or_name}",["19"],{},"upsert-key-in-workspace","Create or Update Key using ID or name in a workspace.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Keys",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"4602f2db096a2","6abde6fb397e7","200",[],["57"],"Successfully upserted Key","d55de669c99b5","400",[],["58"],"Invalid Key","d56de669c9bea","401",[],["59"],"Unauthorized","804e706e6e104",["60"],"The request body for creating a new key entity.",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"101"},"1cd8f7f01af21","workspace","simple",[],"Name or ID of workspace",{"type":"102","examples":"103","$schema":"104","x-stoplight":"105"},["106","107","108","109","110","111"],"7eea07f281cd7","key_id_or_name",[],"The unique identifier or the name of the Key to retrieve.",{"type":"102","examples":"112","$schema":"104","x-stoplight":"113"},["106","107","108","109","110","111"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121","enum":"122"},"db058c6e7a08f","application/json",["123","124"],[],{"description":"125","properties":"126","type":"127","title":"128","examples":"129"},"687630d1436a2",[],[],{"type":"127","$schema":"104","x-stoplight":"130"},"bc4b9639ae785",["131","132","133"],[],{"type":"127","properties":"134","required":"135","title":"136","$schema":"104","x-stoplight":"137"},"4f8aa63ae4ea2",[],[],{"type":"127","x-examples":"138","properties":"139","required":"140","$schema":"104","x-stoplight":"141"},"string",["142"],"http://json-schema.org/draft-07/schema#",{"id":"143"},"name","in","required","schema","description","title",["144"],{"id":"145"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["120","146"],{"id":"147","value":"148","key":"149"},{"id":"150","key":"151","value":"152"},"A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.",{"created_at":"153","id":"154","jwk":"155","kid":"156","name":"157","pem":"158","set":"159","tags":"160","updated_at":"161"},"object","Key",["148"],{"id":"162"},{"id":"163","key":"164","value":"165","summary":"166"},{"id":"167","key":"168","value":"169","summary":"170"},{"id":"171","key":"172","value":"173","summary":"174"},{"status":"175","message":"176"},["177","178"],"UnauthorizedError",{"id":"179"},{"Example 1":"180"},{"set":"181","name":"182","kid":"183","jwk":"184","pem":"185","tags":"186"},["187"],{"id":"188"},"team-a","b67711123b360","24D0DBDA-671C-11ED-BA0B-EF1DCCD3725","04a5778dd0292","https","ed891eb177137",{"id":"189","jwk":"190","kid":"191","name":"192","pem":"193","set":"194"},"default","8da8889ed00dd","Example 1",{"id":"189","jwk":"190","kid":"191","name":"192","pem":"195","set":"196"},{"description":"197","type":"198"},{"type":"102"},{"description":"199","type":"102"},{"description":"200","type":"102"},{"description":"201","type":"102"},{"description":"202","properties":"203","type":"127"},{"additionalProperties":false,"description":"204","properties":"205","type":"127"},{"description":"206","items":"207","type":"208"},{"description":"209","type":"198"},"21059c7c84592","7511704812718","DuplicateApiKey",{"message":"166","status":401},"Duplicate API key found","a2233630435d4","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","c2a83d6324068","NoAPIKey",{"message":"210","status":401},"No API key found",{"type":"198"},{"type":"102"},"status","message","470b68e5f0549",{"set":"211","name":"212","kid":"191","jwk":"190","pem":"213","tags":"214"},{"type":"127","description":"215","properties":"216"},{"type":"102","description":"217","examples":"218"},{"type":"102","description":"219","examples":"220"},{"type":"102","description":"199","examples":"221"},{"type":"127","description":"222","properties":"223"},{"type":"208","description":"224","items":"225"},"kid","06145762ea39d","d958f66b-8e99-44d2-b0b4-edd5bbf24658","{\"alg\":\"RSA\", \"kid\": \"42\", ...}","42","a-key",{"private_key":"226","public_key":"226"},{"id":"227"},{"private_key":"226","public_key":"226"},{"id":"227"},"Unix epoch when the resource was created.","integer","A JSON Web Key represented as a string.","A unique identifier for a key.","The name to associate with the given keys.","A keypair in PEM format.",{"private_key":"228","public_key":"229"},"The id (an UUID) of the key-set with which to associate the key.",{"id":"230"},"An optional set of strings associated with the Key for grouping and filtering.",{"type":"102"},"array","Unix epoch when the resource was last updated.","No API key found in request",{"id":"231"},"my-key",{"private_key":"226","public_key":"226"},["232","233"],"The id (an UUID) of the key-set with which to associate the key .With form-encoded, the notation is `set.id=<set id>` or `set.name=<set name>`. With JSON, use `\"set\":{\"id\":\"<set id>\"}` or `\"set\":{\"name\":\"<set name>\"}.`",{"id":"234"},"The name to associate with the given keys.\n",["212"],"A unique identifier for a key.\n",["191"],["235"],"A keypair in PEM format.\n",{"private_key":"236","public_key":"237"},"An optional set of strings associated with the Key for grouping and filtering.\n",{"type":"102"},"-----BEGIN","b86b331c-dcd0-4b3e-97ce-47c5a9543031",{"type":"102"},{"type":"102"},{"type":"102"},"46CA83EE-671C-11ED-BFAB-2FE47512C77A","application-a","public-key-xyz",{"type":"102","description":"231"},"{\\\"alg\\\":\\\"RSA\\\", \\\"kid\\\": \\\"42\\\", ...}",{"type":"102","examples":"238"},{"type":"102","examples":"239"},["240"],["241"],"private_key\": \"-----BEGIN","public_key\": \"-----BEGIN"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-keyring",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch cluster Keyring",["18"],"2e996177aa466","get","/keyring",["19"],{},"get-keyring","Kong Gateway provides a mechanism to store sensitive data fields, such as consumer secrets, in an encrypted format within the database.This provides for encryption-at-rest security controls in a Kong cluster. For more information review the [keyring and data encryption documentation](https://docs.konghq.com/gateway/latest/kong-enterprise/db-encryption/#getting-started).","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Keyring",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"11dabf3511dac","18b4685bfb504","200",[],["45"],"The contents of the keyring.","de046904841a3","401",[],["46"],"Unauthorized",{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},{"id":"63","mediaType":"59","examples":"64","encodings":"65","schema":"66"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"d29182b115a4b","application/json",["76"],[],{"type":"77","x-examples":"78","description":"79","properties":"80","$schema":"81","x-stoplight":"82"},"bd591b29ece72",["83","84","85"],[],{"type":"77","properties":"86","required":"87","title":"88","$schema":"81","x-stoplight":"89"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","90"],{"id":"91","key":"92","value":"93"},"object",{"Example 1":"94"},"The keyring object contains an array of keyring ids.",{"ids":"95","active":"96"},"http://json-schema.org/draft-07/schema#",{"id":"97"},{"id":"98","key":"99","value":"100","summary":"101"},{"id":"102","key":"103","value":"104","summary":"105"},{"id":"106","key":"107","value":"108","summary":"109"},{"status":"110","message":"111"},["112","113"],"UnauthorizedError",{"id":"114"},"https","28054649b2c7e","example",{"ids":"115","active":"116"},{"ids":"117","active":"116"},{"type":"118","description":"119","items":"120"},{"type":"121","description":"122","examples":"123"},"e31358f1e83c8","ff92890a9d9a9","DuplicateApiKey",{"message":"101","status":401},"Duplicate API key found","e0b88c96de1c1","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","07be9fe945dc0","NoAPIKey",{"message":"124","status":401},"No API key found",{"type":"125"},{"type":"121"},"status","message","470b68e5f0549",["116"],"LaW1urRQ",["116"],"array","The list of the active key IDs",{"type":"121","examples":"126"},"string","The ID of the active key.",["116"],"No API key found in request","integer",["116"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-keyring-generate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Generate key",["18"],"fb944d82d617b","post","/keyring/generate",["19"],{},"post-keyring-generate","Generate key material.\n\nKong supports rotating keys by allowing for multiple keys to exist on the keyring at the same time. This allows for data fields written by one key to be read back, while a fresher encryption key is used for write operations. Rotating keys is a matter of importing or generating a new key into the keyring, and marking it as active.\n'401': \n $ref: '#/components/responses/HTTP401Error'","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Keyring",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35"},[],[],[],[],["36"],{"id":"37","url":"38","name":"39","description":"40","variables":"41"},"11dabf3511dac","360fcff7dcd85","200",[],["42"],"OK","07506093fc822",["43"],{"id":"44","key":"45","extensions":"46","description":"47","type":"48","name":"49","in":"50"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"51","path":"52","port":"53","protocol":"54"},{"id":"55","mediaType":"56","examples":"57","encodings":"58","schema":"59"},{"id":"60","mediaType":"56","examples":"61","encodings":"62","schema":"63"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"64","description":"65"},{"default":"66","description":"67"},{"default":"68","description":"69"},{"default":"70","description":"71","enum":"72"},"db9b2135e75f7","application/json",[],[],{"type":"73","x-examples":"74","properties":"75","$schema":"76","x-stoplight":"77"},"6dce281f63d0e",["78"],[],{"type":"73","x-examples":"79","properties":"80","$schema":"76","x-stoplight":"81"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["70","82"],"object",{"Example 1":"83"},{"key":"84","id":"85"},"http://json-schema.org/draft-07/schema#",{"id":"86"},{"id":"87","key":"88","value":"89"},{"Example 1":"90"},{"key":"91","id":"92"},{"id":"93"},"https",{"key":"94","id":"95"},{"type":"96","description":"97","examples":"98"},{"type":"96","description":"99","examples":"100"},"ed98691d51c51","91a7c4628d53e","Example 1",{"key":"94","id":"95"},{"key":"94","id":"95"},{"type":"96","examples":"101"},{"type":"96","examples":"102"},"514f97ee123e3","t6NWgbj3g9cbNVC3/D6oZ2Md1Br5gWtRrqb1T2FZy44=","8zgITLQh","string","Key material",["94"],"The key's ID",["95"],["94"],["95"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-keyring-activate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Activate key",["18"],"e12ebbb681fc3","post","/keyring/activate",["19"],{},"post-keyring-activate","Kong can write new sensitive data fields with the current active key, and read previously written fields in the database with the prior key, provided that key is in the keyring. Kong automatically selects the appropriate key to use when decrypting fields from the database.","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Keyring",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],[],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"11dabf3511dac","782d9eb93e37b","204",[],[],"No Content","9ffda07ee674d","401",[],["49"],"Unauthorized","86eec37186b82",["50"],"The request body contains a key ID that can be generated from the `/keyring/generate` endpoint.",{"id":"51","key":"52","extensions":"53","description":"54","type":"55","name":"56","in":"57"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"58","path":"59","port":"60","protocol":"61"},{"id":"62","mediaType":"63","examples":"64","encodings":"65","schema":"66"},{"id":"67","mediaType":"63","examples":"68","encodings":"69","schema":"70"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"71","description":"72"},{"default":"73","description":"74"},{"default":"75","description":"76"},{"default":"77","description":"78","enum":"79"},"3fe85e9aa1e3f","application/json",["80","81","82"],[],{"type":"83","properties":"84","required":"85","title":"86","$schema":"87","x-stoplight":"88"},"57e35dd6003aa",[],[],{"type":"83","x-examples":"89","properties":"90","$schema":"87","x-stoplight":"91"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["77","92"],{"id":"93","key":"94","value":"95","summary":"96"},{"id":"97","key":"98","value":"99","summary":"100"},{"id":"101","key":"102","value":"103","summary":"104"},"object",{"status":"105","message":"106"},["107","108"],"UnauthorizedError","http://json-schema.org/draft-07/schema#",{"id":"109"},{"Example 1":"110"},{"key":"111"},{"id":"112"},"https","131a521e5f042","DuplicateApiKey",{"message":"96","status":401},"Duplicate API key found","b9afd2177dfa8","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","adf59f0c05c57","NoAPIKey",{"message":"113","status":401},"No API key found",{"type":"114"},{"type":"115"},"status","message","470b68e5f0549",{"key":"116"},{"type":"115","description":"117","examples":"118"},"85be042939b59","No API key found in request","integer","string","3Rwvk223","The key ID",["116"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-keyring-recover",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Recover keyring",["18"],"26fc7277be2bc","post","/keyring/recover",["19"],{},"post-keyring-recover","The keyring material is then encrypted with the public RSA key defined with the `keyring_recovery_public_key` Kong configuration value in the database. The corresponding private key can be used to decrypt the keyring material in the database.\n\nThe response contains a list of keys that were successfully recovered and that could not be recovered. The Kong error log will contain the detailed reason why the keys could not be recovered.\n","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Keyring",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],[],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"11dabf3511dac","191761de85c60","200",[],["49"],"OK","b8e76001b5abe","401",[],["50"],"Unauthorized","904feca9418aa",["51"],"The request body contains a single file named `recovery_private_key` that represents a private RSA key used for decrypting a keyring material stored in the database.\n\nThe private key is uploaded in the PEM format, which is a binary format used for storing cryptographic keys and certificates. The contents of the file are encoded as a string using a specified encoding (such as base64) and included in the request body",{"id":"52","key":"53","extensions":"54","description":"55","type":"56","name":"57","in":"58"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"59","path":"60","port":"61","protocol":"62"},{"id":"63","mediaType":"64","examples":"65","encodings":"66","schema":"67"},{"id":"68","mediaType":"64","examples":"69","encodings":"70","schema":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"77","description":"78"},{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84","enum":"85"},"0495fcc5c1d85","application/json",["86"],[],{"type":"87","x-examples":"88","properties":"89","$schema":"90","x-stoplight":"91"},"74e2aaa83863b",["92","93","94"],[],{"type":"87","properties":"95","required":"96","title":"97","$schema":"90","x-stoplight":"98"},"79b145d54fa19","multipart/form-data",["99"],[],{"type":"87","properties":"100","$schema":"90","x-stoplight":"101"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["83","102"],{"id":"103","key":"104","value":"105"},"object",{"Example 1":"106"},{"message":"107","recovered":"108","not_recovered":"109"},"http://json-schema.org/draft-07/schema#",{"id":"110"},{"id":"111","key":"112","value":"113","summary":"114"},{"id":"115","key":"116","value":"117","summary":"118"},{"id":"119","key":"120","value":"121","summary":"122"},{"status":"123","message":"124"},["125","126"],"UnauthorizedError",{"id":"127"},{"id":"128","key":"129","value":"130"},{"recovery_private_key":"131"},{"id":"132"},"https","b8c1c673f771c","example",{"message":"133","recovered":"134","not_recovered":"135"},{"message":"133","recovered":"136","not_recovered":"137"},{"type":"138","description":"139","examples":"140"},{"type":"141","items":"142"},{"type":"141","items":"143"},"05def1002e67d","7ab414f7fd875","DuplicateApiKey",{"message":"114","status":401},"Duplicate API key found","fab4bee87110c","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","7351b7a94ee5d","NoAPIKey",{"message":"144","status":401},"No API key found",{"type":"145"},{"type":"138"},"status","message","470b68e5f0549","b338f3f16bea5","Example 1",{"recovery_private_key":"146"},{"type":"138","description":"147","examples":"148","contentMediaType":"149"},"ae4bc1d731b4b","successfully recovered 1 keys",["150"],["151"],["150"],["151"],"string","A message containing details about your request.",["133"],"array",{"type":"138","examples":"152"},{"type":"138","examples":"153"},"No API key found in request","integer","/path/to/generated/<base64-encoded-contents-of-key.pem>","Private key in PEM format.",["146"],"application/octet-stream","RfsDJ2Ol","xSD219lH",["150"],["151"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-keyring-remove",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Remove key",["18"],"91efb2c11dbf1","post","/keyring/remove",["19"],{},"post-keyring-remove","Remove a key from the keyring.","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Keyring",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],[],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"11dabf3511dac","b535399e7868b","204",[],[],"No Content","15253b7b486bb","401",[],["49"],"Unauthorized","6cb6687fa0de7",["50"],"The request body contains a key ID that can be generated from the `/keyring/generate` endpoint.",{"id":"51","key":"52","extensions":"53","description":"54","type":"55","name":"56","in":"57"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"58","path":"59","port":"60","protocol":"61"},{"id":"62","mediaType":"63","examples":"64","encodings":"65","schema":"66"},{"id":"67","mediaType":"63","examples":"68","encodings":"69","schema":"70"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"71","description":"72"},{"default":"73","description":"74"},{"default":"75","description":"76"},{"default":"77","description":"78","enum":"79"},"ee175f19d0a22","application/json",["80","81","82"],[],{"type":"83","properties":"84","required":"85","title":"86","$schema":"87","x-stoplight":"88"},"0a6d2decd289a",[],[],{"type":"83","x-examples":"89","properties":"90","$schema":"87","x-stoplight":"91"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["77","92"],{"id":"93","key":"94","value":"95","summary":"96"},{"id":"97","key":"98","value":"99","summary":"100"},{"id":"101","key":"102","value":"103","summary":"104"},"object",{"status":"105","message":"106"},["107","108"],"UnauthorizedError","http://json-schema.org/draft-07/schema#",{"id":"109"},{"Example 1":"110"},{"key":"111"},{"id":"112"},"https","d5d5e3527b2d0","DuplicateApiKey",{"message":"96","status":401},"Duplicate API key found","9f3ef9389aac1","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","b180984b87cb6","NoAPIKey",{"message":"113","status":401},"No API key found",{"type":"114"},{"type":"115"},"status","message","470b68e5f0549",{"key":"116"},{"type":"115","description":"117","examples":"118"},"d52cfdf8a3711","No API key found in request","integer","string","3Rwvk223","The key ID",["116"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-keyring-export",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Export keyring",["18"],"a9c23a56b952e","post","/keyring/export",["19"],{},"post-keyring-export","Export the keyring. The exported material can be re-imported to the cluster in the event of an outage or to restore a previously-deleted key.\nThe exported keyring should be stored in a safe location for disaster recovery purposes. It is not designed to be modified or decrypted before being used during a disaster recovery process.\n'401': \n $ref: '#/components/responses/HTTP401Error'\n","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Keyring",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],[],["33"],{"id":"34","url":"35","name":"36","description":"37","variables":"38"},"11dabf3511dac","a14be6074fc09","200",[],["39"],"OK",{"id":"40","key":"41","extensions":"42","description":"43","type":"44","name":"45","in":"46"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"47","path":"48","port":"49","protocol":"50"},{"id":"51","mediaType":"52","examples":"53","encodings":"54","schema":"55"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"56","description":"57"},{"default":"58","description":"59"},{"default":"60","description":"61"},{"default":"62","description":"63","enum":"64"},"cfc2964582872","application/json",["65"],[],{"type":"66","x-examples":"67","description":"68","properties":"69","$schema":"70","x-stoplight":"71"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["62","72"],{"id":"73","key":"74","value":"75"},"object",{"Example 1":"76"},"opaque blob containing a keyring.",{"data":"77"},"http://json-schema.org/draft-07/schema#",{"id":"78"},"https","73ca73a1a843e","Example",{"data":"79"},{"data":"80"},{"type":"81","examples":"82"},"ed638111467f7","eyJrIjoiV1JZeTdubDlYeFZpR3VVQWtWTXBcL0JiVW1jMWZrWHluc0dKd","eyJrIjoIn0=","string",["79"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-keyring-vault-sync",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Synchronize Vault keyring",["18"],"3162d04d3cde9","post","/keyring/vault/sync",["19"],{},"post-keyring-vault-sync","Kong reads the keyring material from Vault when the Kong process starts.\nAny changes to the Vault KV store are not reflected on the Kong node until Kong syncs with Vault via the `/keyring/vault/sync` Admin API endpoint. \nThis allows Kong to receive a Vault token with a low TTL, as the list and read operation only occur once.\n","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Keyring",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35"},[],[],[],[],["36"],{"id":"37","url":"38","name":"39","description":"40","variables":"41"},"11dabf3511dac","e07190fb3bbe4","204",[],[],"No Content","9fc2049762290",["42"],{"id":"43","key":"44","extensions":"45","description":"46","type":"47","name":"48","in":"49"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"50","path":"51","port":"52","protocol":"53"},{"id":"54","mediaType":"55","examples":"56","encodings":"57","schema":"58"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"59","description":"60"},{"default":"61","description":"62"},{"default":"63","description":"64"},{"default":"65","description":"66","enum":"67"},"1f309a0da8fbc","application/json",["68"],[],{"type":"69","properties":"70","$schema":"71","x-stoplight":"72"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["65","73"],{"id":"74","key":"75","value":"76"},"object",{"token":"77"},"http://json-schema.org/draft-07/schema#",{"id":"78"},"https","428253f2eaf7b","Example 1",{"token":"79"},{"type":"80","description":"81","examples":"82"},"72dd9703867d7","example-token","string","Optional token for Vault synchronization.",["79"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-keyring-import",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Import Keyring",["18"],"a8fe54dcbca98","post","/keyring/import",["19"],{},"post-keyring-import","Restart Kong and re-import the previously exported keyring. This operation requires that the keyring_private_key point to the private RSA key associated with the public key used during the initial keyring export.","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Keyring",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35","description":"4"},[],[],[],[],["36"],{"id":"37","url":"38","name":"39","description":"40","variables":"41"},"11dabf3511dac","d968c648d23c2","200",[],["42"],"OK","4fd396bdc53a2",["43"],{"id":"44","key":"45","extensions":"46","description":"47","type":"48","name":"49","in":"50"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"51","path":"52","port":"53","protocol":"54"},{"id":"55","mediaType":"56","examples":"57","encodings":"58","schema":"59"},{"id":"60","mediaType":"56","examples":"61","encodings":"62","schema":"63"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"64","description":"65"},{"default":"66","description":"67"},{"default":"68","description":"69"},{"default":"70","description":"71","enum":"72"},"caaaa9600ba50","application/json",[],[],{"type":"73","x-examples":"74","properties":"75","$schema":"76","x-stoplight":"77"},"5fa67bea6e177",["78"],[],{"type":"73","x-examples":"79","properties":"80","$schema":"76","x-stoplight":"81"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["70","82"],"object",{"Example 1":"83"},{"created_at":"84","consumer":"85","id":"86","password":"87","username":"88"},"http://json-schema.org/draft-07/schema#",{"id":"89"},{"id":"90","key":"91","value":"92"},{"Example 1":"93"},{"key":"94","id":"95"},{"id":"96"},"https",{"created_at":1576518704,"consumer":"97","id":"98","password":"99","username":"100"},{"type":"101","description":"102"},{"type":"73","description":"103","properties":"104"},{"type":"105","description":"106","examples":"107"},{"type":"105","description":"108","examples":"109"},{"type":"105","description":"110","examples":"111"},"b3ff1bf81c335","34c6180a3739e","Example 1",{},{"key":"112","id":"113"},{"type":"105","examples":"114"},{"type":"105","examples":"115"},"431fc09cc6a4e",{"id":"116"},"fc46ce48-c1d6-4078-9f51-5a777350a8a2","da61c0083b6d19ef3db2490d0da96a71572da0fa","bob","integer","Datetime representation of the keyring creation date.","The consumer object.",{"id":"117"},"string","UUID of the keyring",["116"],"Password associated with the keyring.",["99"],"Username associated with the keyring",["118"],"t6NWgbj3g9cbNVC3/D6oZ2Md1Br5gWtRrqb1T2FZy44=","8zgITLQh",["112"],["113"],"6375b5fd-9c95-4822-b2dd-80ffbccb7ec9",{"type":"105","description":"119","examples":"120"},"user","ID of the consumer object.",["116"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-key-set",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all Key-sets",["18"],"65fc37e4cfec3","get","/key-sets",["19"],{},"list-key-set","Retrieve a list of all Key-sets in the system. A Key Set object holds a collection of asymmetric key objects. This entity allows to logically group keys by their purpose. Key Sets can be both tagged and filtered by tags.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Key-sets",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40","41"],[],[],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"5da688d196138","cbe9e660ef48a","200",[],["48"],"Key set object response body","a3d9e49b460ee","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","key":"70","extensions":"71","description":"72","type":"73","name":"74","in":"75"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"76","path":"77","port":"78","protocol":"79"},{"id":"80","mediaType":"81","examples":"82","encodings":"83","schema":"84"},{"id":"85","mediaType":"81","examples":"86","encodings":"87","schema":"88"},"e940336620cc7","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96"],"28f55d95a8504","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"97","$schema":"90","x-stoplight":"98"},["92","93","94","95","96"],"7421b1c8d76ce","tags",["99"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"97","examples":"100","x-stoplight":"101","$schema":"90"},["92","102","93","94","95","96"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"103","description":"104"},{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110","enum":"111"},"ebc1a5835f060","application/json",["112"],[],{"type":"113","x-examples":"114","properties":"115","$schema":"90","x-stoplight":"116"},"8d6599d61b84a",["117","118","119"],[],{"type":"113","properties":"120","required":"121","title":"122","$schema":"90","x-stoplight":"123"},"integer","http://json-schema.org/draft-07/schema#",{"id":"124"},"description","in","name","schema","title","string",{"id":"125"},{"id":"126","value":"127","key":"128"},["127"],{"explicitProperties":"129","id":"130"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["109","131"],{"id":"132","key":"102","value":"133"},"object",{"Example 1":"134"},{"id":"135","name":"136","created_at":"137","updated_at":"138","tags":"139","next":"140"},{"id":"141"},{"id":"142","key":"143","value":"144","summary":"145"},{"id":"146","key":"147","value":"148","summary":"149"},{"id":"150","key":"151","value":"152","summary":"153"},{"status":"154","message":"155"},["156","157"],"UnauthorizedError",{"id":"158"},"32e00cbcad597","ab8b890735f90","402f4e78b5436","tag1,tag2","default",["159","160","161"],"0addc5c41e85b","https","4111368646f73",{"id":"162","name":"163","created_at":1422386534,"updated_at":1422386534,"tags":"164","next":"165"},{"id":"166","name":"167","created_at":1422386534,"updated_at":1422386534,"tags":"168","next":"165"},{"type":"97","examples":"169"},{"type":"97","description":"170","examples":"171"},{"type":"89","description":"172","examples":"173"},{"type":"89","description":"174","examples":"175"},{"type":"176","description":"170","items":"177"},{"type":"97","description":"178","examples":"179"},"2cac12b7bc1a0","27f51fcd81b03","DuplicateApiKey",{"message":"145","status":401},"Duplicate API key found","001d47d039a4a","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","3a0e9cbe4dcf2","NoAPIKey",{"message":"180","status":401},"No API key found",{"type":"89"},{"type":"97"},"status","message","470b68e5f0549","type","nullable","examples","4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F","my-key_set",["97"],"http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","b58c7d9d-e54f-444c-b24d-cdfc4159f61e","example-key-set",["181"],["162"],"The name to associate with the given key-set.\n",["163"],"Unix epoch when the resource was last created.",[1422386534],"Unix epoch when the resource was last updated.\n",[1422386534],"array",{"type":"97"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page\n",["165"],"No API key found in request","idp-keys"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-key-set",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create a new Key-set",["18"],"d92680f071393","post","/key-sets",["19"],{},"create-key-set","This endpoint allows creating a new Key-set by sending a JSON object that describes the Key-set to be created.The request body must contain all the fields required to create a new Key-set.\n","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"Key-sets",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],[],["55"],{"id":"56","url":"57","name":"58","description":"59","variables":"60"},"5da688d196138","38d396a5fa35b","201",[],["61"],"Key set object response body","d8c394c92aa71","400",[],["62"],"Invalid Key-set","d8b394c92ac22","401",[],["63"],"Unauthorized","d83394c929aba","409",[],["64"],"Conflict","63c1ea3d03c93",["65"],"The request body for creating a new key-set entity.",{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},{"id":"86","mediaType":"78","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"78","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"78","examples":"95","encodings":"96","schema":"97"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"98","description":"99"},{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105","enum":"106"},"369ae90349cf3","application/json",["107"],[],{"type":"108","x-examples":"109","properties":"110","$schema":"111","x-stoplight":"112"},"2ce098413000f",[],[],{"type":"108","$schema":"111","x-stoplight":"113"},"d6b8bb04489e5",["114","115","116"],[],{"type":"108","properties":"117","required":"118","title":"119","$schema":"111","x-stoplight":"120"},"faea112d10ce6",["121"],[],{"type":"108","properties":"122","x-examples":"123","$schema":"111","x-stoplight":"124"},"37695c4197b49",[],[],{"type":"108","x-examples":"125","properties":"126","$schema":"111","x-stoplight":"127"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["104","128"],{"id":"129","key":"130","value":"131"},"object",{"Example 1":"132"},{"id":"133","name":"134","created_at":"135","updated_at":"136","tags":"137","next":"138"},"http://json-schema.org/draft-07/schema#",{"id":"139"},{"id":"140"},{"id":"141","key":"142","value":"143","summary":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"status":"153","message":"154"},["155","156"],"UnauthorizedError",{"id":"157"},{"id":"158","key":"159","value":"160"},{"fields":"161","message":"162","name":"163","code":"164"},{"Example 1":"165"},{"id":"166"},{"Example 1":"167"},{"name":"168","tags":"169"},{"id":"170"},"https","83a6a23ecee0f","example",{"id":"171","name":"172","created_at":1422386534,"updated_at":1422386534,"tags":"173","next":"174"},{"id":"175","name":"176","created_at":1422386534,"updated_at":1422386534,"tags":"177","next":"174"},{"type":"178","examples":"179"},{"type":"178","description":"180","examples":"181"},{"type":"182","description":"183","examples":"184"},{"type":"182","description":"185","examples":"186"},{"type":"187","description":"180","items":"188"},{"type":"178","description":"189","examples":"190"},"2cac12b7bc1a0","a58b83f32bffa","af18c3dee8130","DuplicateApiKey",{"message":"144","status":401},"Duplicate API key found","07850622ba299","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","55407deb4e6d7","NoAPIKey",{"message":"191","status":401},"No API key found",{"type":"182"},{"type":"178"},"status","message","470b68e5f0549","6de589b33ef8a","Not Found",{"fields":"192","message":"193","name":"194","code":5},{"type":"108","properties":"195"},{"type":"178"},{"type":"178"},{"type":"182"},{"fields":"196","message":"193","name":"194","code":5},"cb2afc86b645f",{"name":"172","tags":"197"},{"type":"178","description":"180","examples":"198"},{"type":"187","description":"199","items":"200"},"15d5e0ab40247","4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F","my-key_set",["178"],"http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","b58c7d9d-e54f-444c-b24d-cdfc4159f61e","example-key-set",["201"],"string",["171"],"The name to associate with the given key-set.\n",["172"],"integer","Unix epoch when the resource was last created.",[1422386534],"Unix epoch when the resource was last updated.\n",[1422386534],"array",{"type":"178"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page\n",["174"],"No API key found in request",{"name":"172"},"UNIQUE violation detected on `{name=\"my-key_set\"}`","unique constraint violation",{"name":"202"},{"name":"172"},["203","204"],["172"],"An optional set of strings associated with the Key for grouping and filtering.\n",{"type":"178"},"idp-keys",{"type":"178"},"google-keys","mozilla-keys"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-key-set",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a Key-set",["17"],"f155d71d8102f","delete","/key-sets/{key-set_id_or_name}",["18"],{},"delete-key-set","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Key-sets",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38"],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"5da688d196138","3b9db56744fb5","204",[],[],"Successfully deleted Key-set or the resource didn't exist","936db74406192","401",[],["45"],"Unauthorized",{"id":"46","name":"47","style":"48","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},{"id":"64","mediaType":"65","examples":"66","encodings":"67","schema":"68"},"8c45d0e5c8b17","key-set_id_or_name","simple",[],"The unique identifier or the `name` attribute of the Key Set that should be associated to the newly-created Key.",{"type":"69","examples":"70","$schema":"71","x-stoplight":"72"},["73","74","75","76","77","78"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86","enum":"87"},"23d5c72c00e81","application/json",["88","89","90"],[],{"type":"91","properties":"92","required":"93","title":"94","$schema":"71","x-stoplight":"95"},"string",["96"],"http://json-schema.org/draft-07/schema#",{"id":"97"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["85","98"],{"id":"99","key":"100","value":"101","summary":"102"},{"id":"103","key":"104","value":"105","summary":"106"},{"id":"107","key":"108","value":"109","summary":"110"},"object",{"status":"111","message":"112"},["113","114"],"UnauthorizedError",{"id":"115"},"46CA83EE-671C-11ED-BFAB-2FE47512C77A","429c40febcc71","https","63dfe44358460","DuplicateApiKey",{"message":"102","status":401},"Duplicate API key found","3e76bff7c19eb","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","5ecdd60548464","NoAPIKey",{"message":"116","status":401},"No API key found",{"type":"117"},{"type":"69"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-key-set",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a Key-set",["18"],"7be14500ac288","get","/key-sets/{key-set_id_or_name}",["19"],{},"get-key-set","Get a Key-set using ID or name. This endpoint retrieves information about a specific key-set based on its ID or name.\n","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Key-sets",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45"],["46"],{"id":"47","url":"48","name":"49","description":"50","variables":"51"},"5da688d196138","c8e3b1ec8abce","200",[],["52"],"Key set object response body","70b3b00fc8795","401",[],["53"],"Unauthorized","7103b00fc8e0a","404",[],[],"Resource does not exist",{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},{"id":"77","mediaType":"73","examples":"78","encodings":"79","schema":"80"},"d05ab2d3789d6","key-set_id_or_name","simple",[],"The unique identifier or the `name` attribute of the Key Set that should be associated to the newly-created Key.",{"type":"81","examples":"82","$schema":"83","x-stoplight":"84"},["85","86","87","88","89","90"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"a7933a10b813a","application/json",["100"],[],{"type":"101","x-examples":"102","properties":"103","$schema":"83","x-stoplight":"104"},"b98944b498836",["105","106","107"],[],{"type":"101","properties":"108","required":"109","title":"110","$schema":"83","x-stoplight":"111"},"string",["112"],"http://json-schema.org/draft-07/schema#",{"id":"113"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","114"],{"id":"115","key":"116","value":"117"},"object",{"Example 1":"118"},{"id":"119","name":"120","created_at":"121","updated_at":"122","tags":"123","next":"124"},{"id":"125"},{"id":"126","key":"127","value":"128","summary":"129"},{"id":"130","key":"131","value":"132","summary":"133"},{"id":"134","key":"135","value":"136","summary":"137"},{"status":"138","message":"139"},["140","141"],"UnauthorizedError",{"id":"142"},"46CA83EE-671C-11ED-BFAB-2FE47512C77A","977f882862fc5","https","bad3aa4ba7221","example",{"id":"143","name":"144","created_at":1422386534,"updated_at":1422386534,"tags":"145","next":"146"},{"id":"147","name":"148","created_at":1422386534,"updated_at":1422386534,"tags":"149","next":"146"},{"type":"81","examples":"150"},{"type":"81","description":"151","examples":"152"},{"type":"153","description":"154","examples":"155"},{"type":"153","description":"156","examples":"157"},{"type":"158","description":"151","items":"159"},{"type":"81","description":"160","examples":"161"},"2cac12b7bc1a0","e23519af2568d","DuplicateApiKey",{"message":"129","status":401},"Duplicate API key found","ae3126ef9ad3b","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","34c5c65770043","NoAPIKey",{"message":"162","status":401},"No API key found",{"type":"153"},{"type":"81"},"status","message","470b68e5f0549","4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F","my-key_set",["81"],"http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","b58c7d9d-e54f-444c-b24d-cdfc4159f61e","example-key-set",["163"],["143"],"The name to associate with the given key-set.\n",["144"],"integer","Unix epoch when the resource was last created.",[1422386534],"Unix epoch when the resource was last updated.\n",[1422386534],"array",{"type":"81"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page\n",["146"],"No API key found in request","idp-keys"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-key-set",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a Key-set",["18"],"a56304162fc9c","patch","/key-sets/{key-set_id_or_name}",["19"],{},"update-key-set","Update a Key-set using ID or name.\n\nNote: This API is not available in DB-less mode.\n\nInserts (or replaces) the Key Set under the requested resource with the definition specified in the body. The Key Set will be identified via the name or id attribute.\n\nWhen the name or id attribute has the structure of a UUID, the Key Set being inserted/replaced will be identified by its id. Otherwise it will be identified by its name.\n\nWhen creating a new Key Set without specifying id (neither in the URL nor in the body), then it will be auto-generated.\n\nNotice that specifying a name in the URL and a different one in the request body is not allowed.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"Key-sets",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55"],["56"],{"id":"57","url":"58","name":"59","description":"60","variables":"61"},"5da688d196138","03ba18343fe59","200",[],["62"],"Key set object response body","5bda1a110155d","400",[],["63"],"Invalid Key-set","5bea1a110130a","401",[],["64"],"Unauthorized","5b9a1a1101a89","404",[],[],"Resource does not exist","121a272318b5b",["65"],"The request body for creating a new key-set entity.",{"id":"66","name":"67","style":"68","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","key":"74","extensions":"75","description":"76","type":"77","name":"78","in":"79"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"80","path":"81","port":"82","protocol":"83"},{"id":"84","mediaType":"85","examples":"86","encodings":"87","schema":"88"},{"id":"89","mediaType":"85","examples":"90","encodings":"91","schema":"92"},{"id":"93","mediaType":"85","examples":"94","encodings":"95","schema":"96"},{"id":"97","mediaType":"85","examples":"98","encodings":"99","schema":"100"},"c8d6da8ec4a5b","key-set_id_or_name","simple",[],"The unique identifier or the `name` attribute of the Key Set that should be associated to the newly-created Key.",{"type":"101","examples":"102","$schema":"103","x-stoplight":"104"},["105","106","107","108","109","110"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"111","description":"112"},{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118","enum":"119"},"652e268e26c82","application/json",["120"],[],{"type":"121","x-examples":"122","properties":"123","$schema":"103","x-stoplight":"124"},"ebd66e6174dd7",[],[],{"type":"121","$schema":"103","x-stoplight":"125"},"1fe0d62b74f91",["126","127","128"],[],{"type":"121","properties":"129","required":"130","title":"131","$schema":"103","x-stoplight":"132"},"7ab4ebec4233c",[],[],{"type":"121","x-examples":"133","properties":"134","$schema":"103","x-stoplight":"135"},"string",["136"],"http://json-schema.org/draft-07/schema#",{"id":"137"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["117","138"],{"id":"139","key":"140","value":"141"},"object",{"Example 1":"142"},{"id":"143","name":"144","created_at":"145","updated_at":"146","tags":"147","next":"148"},{"id":"149"},{"id":"150"},{"id":"151","key":"152","value":"153","summary":"154"},{"id":"155","key":"156","value":"157","summary":"158"},{"id":"159","key":"160","value":"161","summary":"162"},{"status":"163","message":"164"},["165","166"],"UnauthorizedError",{"id":"167"},{"Example 1":"168"},{"name":"169","tags":"170"},{"id":"171"},"46CA83EE-671C-11ED-BFAB-2FE47512C77A","d0b3996bc0154","https","b58ce5b0ec15a","example",{"id":"172","name":"173","created_at":1422386534,"updated_at":1422386534,"tags":"174","next":"175"},{"id":"176","name":"177","created_at":1422386534,"updated_at":1422386534,"tags":"178","next":"175"},{"type":"101","examples":"179"},{"type":"101","description":"180","examples":"181"},{"type":"182","description":"183","examples":"184"},{"type":"182","description":"185","examples":"186"},{"type":"187","description":"180","items":"188"},{"type":"101","description":"189","examples":"190"},"2cac12b7bc1a0","6cdd0751ec914","88144bbb41ad9","DuplicateApiKey",{"message":"154","status":401},"Duplicate API key found","58c0c7ae62901","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","0435f177bc2a7","NoAPIKey",{"message":"191","status":401},"No API key found",{"type":"182"},{"type":"101"},"status","message","470b68e5f0549",{"name":"173","tags":"192"},{"type":"101","description":"180","examples":"193"},{"type":"187","description":"194","items":"195"},"15d5e0ab40247","4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F","my-key_set",["101"],"http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","b58c7d9d-e54f-444c-b24d-cdfc4159f61e","example-key-set",["196"],["172"],"The name to associate with the given key-set.\n",["173"],"integer","Unix epoch when the resource was last created.",[1422386534],"Unix epoch when the resource was last updated.\n",[1422386534],"array",{"type":"101"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page\n",["175"],"No API key found in request",["197","198"],["173"],"An optional set of strings associated with the Key for grouping and filtering.\n",{"type":"101"},"idp-keys","google-keys","mozilla-keys"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-key-set",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update key-set",["18"],"1fc1799de9e98","put","/key-sets/{key-set_id_or_name}",["19"],{},"upsert-key-set","Update a Key-set using ID or name.\n","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Key-sets",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"5da688d196138","70a53f44b908a","200",[],["56"],"Key set object response body","10853d67e938a","400",[],["57"],"Invalid Key-set","10753d67e91d9","401",[],["58"],"Unauthorized","606af0df90ce9",["59"],"The request body for creating a new key-set entity.",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"79","examples":"84","encodings":"85","schema":"86"},{"id":"87","mediaType":"79","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"79","examples":"92","encodings":"93","schema":"94"},"773c7b264c7c9","key-set_id_or_name","simple",[],"The unique identifier or the `name` attribute of the Key Set that should be associated to the newly-created Key.",{"type":"95","examples":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110"},{"default":"111","description":"112","enum":"113"},"ff8317ab0a554","application/json",["114"],[],{"type":"115","x-examples":"116","properties":"117","$schema":"97","x-stoplight":"118"},"24b3eae5958bb",[],[],{"type":"115","$schema":"97","x-stoplight":"119"},"39e20efd2ee72",["120","121","122"],[],{"type":"115","properties":"123","required":"124","title":"125","$schema":"97","x-stoplight":"126"},"8457f8f102f5c",[],[],{"type":"115","x-examples":"127","properties":"128","$schema":"97","x-stoplight":"129"},"string",["130"],"http://json-schema.org/draft-07/schema#",{"id":"131"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["111","132"],{"id":"133","key":"134","value":"135"},"object",{"Example 1":"136"},{"id":"137","name":"138","created_at":"139","updated_at":"140","tags":"141","next":"142"},{"id":"143"},{"id":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},{"status":"157","message":"158"},["159","160"],"UnauthorizedError",{"id":"161"},{"Example 1":"162"},{"name":"163","tags":"164"},{"id":"165"},"46CA83EE-671C-11ED-BFAB-2FE47512C77A","d93f158cf95de","https","32bf60724e07e","example",{"id":"166","name":"167","created_at":1422386534,"updated_at":1422386534,"tags":"168","next":"169"},{"id":"170","name":"171","created_at":1422386534,"updated_at":1422386534,"tags":"172","next":"169"},{"type":"95","examples":"173"},{"type":"95","description":"174","examples":"175"},{"type":"176","description":"177","examples":"178"},{"type":"176","description":"179","examples":"180"},{"type":"181","description":"174","items":"182"},{"type":"95","description":"183","examples":"184"},"2cac12b7bc1a0","f5bf177146613","4009fd66cd955","DuplicateApiKey",{"message":"148","status":401},"Duplicate API key found","248aa4c38fa78","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","49ad919a69481","NoAPIKey",{"message":"185","status":401},"No API key found",{"type":"176"},{"type":"95"},"status","message","470b68e5f0549",{"name":"167","tags":"186"},{"type":"95","description":"174","examples":"187"},{"type":"181","description":"188","items":"189"},"15d5e0ab40247","4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F","my-key_set",["95"],"http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","b58c7d9d-e54f-444c-b24d-cdfc4159f61e","example-key-set",["190"],["166"],"The name to associate with the given key-set.\n",["167"],"integer","Unix epoch when the resource was last created.",[1422386534],"Unix epoch when the resource was last updated.\n",[1422386534],"array",{"type":"95"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page\n",["169"],"No API key found in request",["191","192"],["167"],"An optional set of strings associated with the Key for grouping and filtering.\n",{"type":"95"},"idp-keys","google-keys","mozilla-keys"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-key-set-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all Key-sets in a workspace",["17"],"f1777b7a0ac59","get","/{workspace}/key-sets",["18"],{},"list-key-set-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Key-sets",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38","39","40"],[],["41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"5da688d196138","c5a4cbc8cee93","200",[],["48"],"Key set object response body","edb4cd8e77029","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","name":"70","style":"71","examples":"72","description":"73","required":true,"schema":"74","explicitProperties":"75"},{"id":"76","key":"77","extensions":"78","description":"79","type":"80","name":"81","in":"82"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"83","path":"84","port":"85","protocol":"86"},{"id":"87","mediaType":"88","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"88","examples":"93","encodings":"94","schema":"95"},"a860e54c8cde6","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"96","$schema":"97","x-stoplight":"98"},["99","100","101","102","103"],"e623b2aa5aff5","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"104","$schema":"97","x-stoplight":"105"},["99","100","101","102","103"],"1bc383342694c","tags",["106"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"104","examples":"107","x-stoplight":"108","$schema":"97"},["99","109","100","101","102","103"],"78b200bbda07e","workspace","simple",[],"Name or ID of workspace",{"type":"104","examples":"110","$schema":"97","x-stoplight":"111"},["101","100","112","102","99","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"113","description":"114"},{"default":"115","description":"116"},{"default":"117","description":"118"},{"default":"119","description":"120","enum":"121"},"3a27cd46882e3","application/json",["122"],[],{"type":"123","x-examples":"124","properties":"125","$schema":"97","x-stoplight":"126"},"b0c2e5623462f",["127","128","129"],[],{"type":"123","properties":"130","required":"131","title":"132","$schema":"97","x-stoplight":"133"},"integer","http://json-schema.org/draft-07/schema#",{"id":"134"},"description","in","name","schema","title","string",{"id":"135"},{"id":"136","value":"137","key":"138"},["137"],{"explicitProperties":"139","id":"140"},"example",["141"],{"id":"142"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["119","143"],{"id":"144","key":"109","value":"145"},"object",{"Example 1":"146"},{"id":"147","name":"148","created_at":"149","updated_at":"150","tags":"151","next":"152"},{"id":"153"},{"id":"154","key":"155","value":"156","summary":"157"},{"id":"158","key":"159","value":"160","summary":"161"},{"id":"162","key":"163","value":"164","summary":"165"},{"status":"166","message":"167"},["168","169"],"UnauthorizedError",{"id":"170"},"59d68dabe38ff","e5dbc55d61232","fee1a2c6f0a9d","tag1,tag2","default",["171","172","173"],"4dce7241ca86e","team-a","f583131b1485f","https","6340f283c534d",{"id":"174","name":"175","created_at":1422386534,"updated_at":1422386534,"tags":"176","next":"177"},{"id":"178","name":"179","created_at":1422386534,"updated_at":1422386534,"tags":"180","next":"177"},{"type":"104","examples":"181"},{"type":"104","description":"182","examples":"183"},{"type":"96","description":"184","examples":"185"},{"type":"96","description":"186","examples":"187"},{"type":"188","description":"182","items":"189"},{"type":"104","description":"190","examples":"191"},"2cac12b7bc1a0","ab0c2ada278ee","DuplicateApiKey",{"message":"157","status":401},"Duplicate API key found","d22b3cc07872d","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","d0b3b29dbe6d2","NoAPIKey",{"message":"192","status":401},"No API key found",{"type":"96"},{"type":"104"},"status","message","470b68e5f0549","type","nullable","examples","4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F","my-key_set",["104"],"http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","b58c7d9d-e54f-444c-b24d-cdfc4159f61e","example-key-set",["193"],["174"],"The name to associate with the given key-set.\n",["175"],"Unix epoch when the resource was last created.",[1422386534],"Unix epoch when the resource was last updated.\n",[1422386534],"array",{"type":"104"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page\n",["177"],"No API key found in request","idp-keys"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-key-set-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new Key-set in a workspace",["17"],"a5814350cde07","post","/{workspace}/key-sets",["18"],{},"create-key-set-in-workspace","inheritedFromService",["19","20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Key-sets",{"id":"29","name":"17"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","contents":"46","description":"47"},[],[],[],["48"],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"5da688d196138","37243f5818a85","200",[],["55"],"Key set object response body","5f44411dc17f4","400",[],["56"],"Invalid Key-set","5f34411dc1823","401",[],["57"],"Unauthorized","d7677970c0278",["58"],"The request body for creating a new key-set entity.",{"id":"59","name":"60","style":"61","examples":"62","description":"63","required":true,"schema":"64","explicitProperties":"65"},{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},{"id":"86","mediaType":"78","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"78","examples":"91","encodings":"92","schema":"93"},"33ef9441c8c7c","workspace","simple",[],"Name or ID of workspace",{"type":"94","examples":"95","$schema":"96","x-stoplight":"97"},["98","99","100","101","102","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111","enum":"112"},"fdf1ad4bb5d9a","application/json",["113"],[],{"type":"114","x-examples":"115","properties":"116","$schema":"96","x-stoplight":"117"},"5564725b48d1a",[],[],{"type":"114","$schema":"96","x-stoplight":"118"},"4edb99ef541e7",["119","120","121"],[],{"type":"114","properties":"122","required":"123","title":"124","$schema":"96","x-stoplight":"125"},"2db79af0fcb3d",[],[],{"type":"114","x-examples":"126","properties":"127","$schema":"96","x-stoplight":"128"},"string",["129"],"http://json-schema.org/draft-07/schema#",{"id":"130"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["110","131"],{"id":"132","key":"133","value":"134"},"object",{"Example 1":"135"},{"id":"136","name":"137","created_at":"138","updated_at":"139","tags":"140","next":"141"},{"id":"142"},{"id":"143"},{"id":"144","key":"145","value":"146","summary":"147"},{"id":"148","key":"149","value":"150","summary":"151"},{"id":"152","key":"153","value":"154","summary":"155"},{"status":"156","message":"157"},["158","159"],"UnauthorizedError",{"id":"160"},{"Example 1":"161"},{"name":"162","tags":"163"},{"id":"164"},"team-a","f08e43b768cda","https","b0603df0efb26","example",{"id":"165","name":"166","created_at":1422386534,"updated_at":1422386534,"tags":"167","next":"168"},{"id":"169","name":"170","created_at":1422386534,"updated_at":1422386534,"tags":"171","next":"168"},{"type":"94","examples":"172"},{"type":"94","description":"173","examples":"174"},{"type":"175","description":"176","examples":"177"},{"type":"175","description":"178","examples":"179"},{"type":"180","description":"173","items":"181"},{"type":"94","description":"182","examples":"183"},"2cac12b7bc1a0","a2fc1b0c8063e","a993b510c5c25","DuplicateApiKey",{"message":"147","status":401},"Duplicate API key found","3fd567793378d","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","80cb12ead7f48","NoAPIKey",{"message":"184","status":401},"No API key found",{"type":"175"},{"type":"94"},"status","message","470b68e5f0549",{"name":"166","tags":"185"},{"type":"94","description":"173","examples":"186"},{"type":"180","description":"187","items":"188"},"15d5e0ab40247","4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F","my-key_set",["94"],"http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","b58c7d9d-e54f-444c-b24d-cdfc4159f61e","example-key-set",["189"],["165"],"The name to associate with the given key-set.\n",["166"],"integer","Unix epoch when the resource was last created.",[1422386534],"Unix epoch when the resource was last updated.\n",[1422386534],"array",{"type":"94"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page\n",["168"],"No API key found in request",["190","191"],["166"],"An optional set of strings associated with the Key for grouping and filtering.\n",{"type":"94"},"idp-keys","google-keys","mozilla-keys"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-key-set-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a Key-set in a workspace",["17"],"6c5d94bb80ade","delete","/{workspace}/key-sets/{key-set_id_or_name}",["18"],{},"delete-key-set-in-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Key-sets",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38","39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"5da688d196138","487a0d4f824ea","204",[],[],"Successfully deleted Key-set or the resource didn't exist","f0aa0b72c0376","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","name":"55","style":"49","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","key":"61","extensions":"62","description":"63","type":"64","name":"65","in":"66"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"67","path":"68","port":"69","protocol":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},"1e5fe393c686b","workspace","simple",[],"Name or ID of workspace",{"type":"76","examples":"77","$schema":"78","x-stoplight":"79"},["80","81","82","83","84","85"],"51014ab23ec0d","key-set_id_or_name",[],"The unique identifier or the `name` attribute of the Key Set that should be associated to the newly-created Key.",{"type":"76","examples":"86","$schema":"78","x-stoplight":"87"},["80","81","82","83","84","85"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95","enum":"96"},"83965c428ec10","application/json",["97","98","99"],[],{"type":"100","properties":"101","required":"102","title":"103","$schema":"78","x-stoplight":"104"},"string",["105"],"http://json-schema.org/draft-07/schema#",{"id":"106"},"name","in","required","schema","description","title",["107"],{"id":"108"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["94","109"],{"id":"110","key":"111","value":"112","summary":"113"},{"id":"114","key":"115","value":"116","summary":"117"},{"id":"118","key":"119","value":"120","summary":"121"},"object",{"status":"122","message":"123"},["124","125"],"UnauthorizedError",{"id":"126"},"team-a","3ba427cf8e6ad","46CA83EE-671C-11ED-BFAB-2FE47512C77A","469f88256476e","https","1cb9827c86744","DuplicateApiKey",{"message":"113","status":401},"Duplicate API key found","b21729288fc8e","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","7a55183eba4d6","NoAPIKey",{"message":"127","status":401},"No API key found",{"type":"128"},{"type":"76"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-key-set-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a Key-set in a workspace",["18"],"722c3a56692f5","get","/{workspace}/key-sets/{key-set_id_or_name}",["19"],{},"get-key-set-in-workspace","Get a Key-set using ID or name in a workspace.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Key-sets",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45","46"],["47"],{"id":"48","url":"49","name":"50","description":"51","variables":"52"},"5da688d196138","cee8246a54239","200",[],["53"],"Successfully fetched Key-set","f718262ffd1a1","401",[],["54"],"Unauthorized","f6c8262ffce22","404",[],[],"Resource does not exist",{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"57","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"f652ec5ce7a89","workspace","simple",[],"Name or ID of workspace",{"type":"88","examples":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96","97"],"b71a63f6b307f","key-set_id_or_name",[],"The unique identifier or the `name` attribute of the Key Set that should be associated to the newly-created Key.",{"type":"88","examples":"98","$schema":"90","x-stoplight":"99"},["92","93","94","95","96","97"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105"},{"default":"106","description":"107","enum":"108"},"e7bed6418a340","application/json",["109"],[],{"properties":"110","type":"111","title":"112","examples":"113","$schema":"90","x-stoplight":"114"},"ce4e5a900de71",["115","116","117"],[],{"type":"111","properties":"118","required":"119","title":"120","$schema":"90","x-stoplight":"121"},"string",["122"],"http://json-schema.org/draft-07/schema#",{"id":"123"},"name","in","required","schema","description","title",["124"],{"id":"125"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["106","126"],{"id":"127","value":"128","key":"129"},{"created_at":"130","id":"131","name":"132","tags":"133","updated_at":"134"},"object","Key-set",["128"],{"id":"135"},{"id":"136","key":"137","value":"138","summary":"139"},{"id":"140","key":"141","value":"142","summary":"143"},{"id":"144","key":"145","value":"146","summary":"147"},{"status":"148","message":"149"},["150","151"],"UnauthorizedError",{"id":"152"},"team-a","c0da87f442897","46CA83EE-671C-11ED-BFAB-2FE47512C77A","2867e3bf4dcc6","https","4ceab3e52f4b0",{"id":"153","name":"154","tags":"155"},"default",{"description":"156","type":"157"},{"type":"88"},{"type":"88"},{"items":"158","type":"159"},{"description":"160","type":"157"},"90d6e6da97434","f24c9aff81995","DuplicateApiKey",{"message":"139","status":401},"Duplicate API key found","9b394cecaba26","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","695301962b758","NoAPIKey",{"message":"161","status":401},"No API key found",{"type":"157"},{"type":"88"},"status","message","470b68e5f0549","b58c7d9d-e54f-444c-b24d-cdfc4159f61e","example-key-set",["162"],"Unix epoch when the resource was created.","integer",{"type":"88"},"array","Unix epoch when the resource was last updated.","No API key found in request","idp-keys"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-key-set-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update a Key-set in a workspace",["17"],"a12369abca91f","patch","/{workspace}/key-sets/{key-set_id_or_name}",["18"],{},"update-key-set-in-workspace","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Key-sets",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","description":"53"},[],[],[],["54","55"],["56"],{"id":"57","url":"58","name":"59","description":"60","variables":"61"},"5da688d196138","ccbd6e007a40c","200",[],["62"],"Key set object response body","ca1d6ea344cda","400",[],["63"],"Invalid Key-set","ca2d6ea344289","401",[],["64"],"Unauthorized","c9dd6ea344b06","404",[],[],"Resource does not exist","6730211deab47",["65"],"The request body for creating a new key-set entity.",{"id":"66","name":"67","style":"68","examples":"69","description":"70","required":true,"schema":"71","explicitProperties":"72"},{"id":"73","name":"74","style":"68","examples":"75","description":"76","required":true,"schema":"77","explicitProperties":"78"},{"id":"79","key":"80","extensions":"81","description":"82","type":"83","name":"84","in":"85"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"86","path":"87","port":"88","protocol":"89"},{"id":"90","mediaType":"91","examples":"92","encodings":"93","schema":"94"},{"id":"95","mediaType":"91","examples":"96","encodings":"97","schema":"98"},{"id":"99","mediaType":"91","examples":"100","encodings":"101","schema":"102"},{"id":"103","mediaType":"91","examples":"104","encodings":"105","schema":"106"},"00f7ab5ef980d","workspace","simple",[],"Name or ID of workspace",{"type":"107","examples":"108","$schema":"109","x-stoplight":"110"},["111","112","113","114","115","116"],"6c2289c0a847d","key-set_id_or_name",[],"The unique identifier or the `name` attribute of the Key Set that should be associated to the newly-created Key.",{"type":"107","examples":"117","$schema":"109","x-stoplight":"118"},["111","112","113","114","115","116"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"119","description":"120"},{"default":"121","description":"122"},{"default":"123","description":"124"},{"default":"125","description":"126","enum":"127"},"558c8890af875","application/json",["128"],[],{"type":"129","x-examples":"130","properties":"131","$schema":"109","x-stoplight":"132"},"f9aa07c5a1d1b",[],[],{"type":"129","$schema":"109","x-stoplight":"133"},"9bfd436644027",["134","135","136"],[],{"type":"129","properties":"137","required":"138","title":"139","$schema":"109","x-stoplight":"140"},"18c0ec386767b",[],[],{"type":"129","x-examples":"141","properties":"142","$schema":"109","x-stoplight":"143"},"string",["144"],"http://json-schema.org/draft-07/schema#",{"id":"145"},"name","in","required","schema","description","title",["146"],{"id":"147"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["125","148"],{"id":"149","key":"150","value":"151"},"object",{"Example 1":"152"},{"id":"153","name":"154","created_at":"155","updated_at":"156","tags":"157","next":"158"},{"id":"159"},{"id":"160"},{"id":"161","key":"162","value":"163","summary":"164"},{"id":"165","key":"166","value":"167","summary":"168"},{"id":"169","key":"170","value":"171","summary":"172"},{"status":"173","message":"174"},["175","176"],"UnauthorizedError",{"id":"177"},{"Example 1":"178"},{"name":"179","tags":"180"},{"id":"181"},"team-a","0ece52a4af1fa","46CA83EE-671C-11ED-BFAB-2FE47512C77A","20e329ba4de3d","https","81a993fe16b70","example",{"id":"182","name":"183","created_at":1422386534,"updated_at":1422386534,"tags":"184","next":"185"},{"id":"186","name":"187","created_at":1422386534,"updated_at":1422386534,"tags":"188","next":"185"},{"type":"107","examples":"189"},{"type":"107","description":"190","examples":"191"},{"type":"192","description":"193","examples":"194"},{"type":"192","description":"195","examples":"196"},{"type":"197","description":"190","items":"198"},{"type":"107","description":"199","examples":"200"},"2cac12b7bc1a0","730fec0f2023b","c72cdacdf5d9d","DuplicateApiKey",{"message":"164","status":401},"Duplicate API key found","abad822ab7120","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","42d9f251f61eb","NoAPIKey",{"message":"201","status":401},"No API key found",{"type":"192"},{"type":"107"},"status","message","470b68e5f0549",{"name":"183","tags":"202"},{"type":"107","description":"190","examples":"203"},{"type":"197","description":"204","items":"205"},"15d5e0ab40247","4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F","my-key_set",["107"],"http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","b58c7d9d-e54f-444c-b24d-cdfc4159f61e","example-key-set",["206"],["182"],"The name to associate with the given key-set.\n",["183"],"integer","Unix epoch when the resource was last created.",[1422386534],"Unix epoch when the resource was last updated.\n",[1422386534],"array",{"type":"107"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page\n",["185"],"No API key found in request",["207","208"],["183"],"An optional set of strings associated with the Key for grouping and filtering.\n",{"type":"107"},"idp-keys","google-keys","mozilla-keys"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-key-set-in-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a Key-set in a workspace",["18"],"bc35699fa2512","put","/{workspace}/key-sets/{key-set_id_or_name}",["19"],{},"upsert-key-set-in-workspace","Create or Update Key-set using ID or name in a workspace.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Key-sets",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],["49","50"],["51"],{"id":"52","url":"53","name":"54","description":"55","variables":"56"},"5da688d196138","a03ffd3abe949","200",[],["57"],"Key set object response body","6d9ffde3546bc","400",[],["58"],"Invalid Key-set","6d8ffde35476f","401",[],["59"],"Unauthorized","2cdc6762b7fc3",["60"],"The request body for creating a new key-set entity.",{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","name":"69","style":"63","examples":"70","description":"71","required":true,"schema":"72","explicitProperties":"73"},{"id":"74","key":"75","extensions":"76","description":"77","type":"78","name":"79","in":"80"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"81","path":"82","port":"83","protocol":"84"},{"id":"85","mediaType":"86","examples":"87","encodings":"88","schema":"89"},{"id":"90","mediaType":"86","examples":"91","encodings":"92","schema":"93"},{"id":"94","mediaType":"86","examples":"95","encodings":"96","schema":"97"},{"id":"98","mediaType":"86","examples":"99","encodings":"100","schema":"101"},"a5fcada04db93","workspace","simple",[],"Name or ID of workspace",{"type":"102","examples":"103","$schema":"104","x-stoplight":"105"},["106","107","108","109","110","111"],"54f95954675e9","key-set_id_or_name",[],"The unique identifier or the `name` attribute of the Key Set that should be associated to the newly-created Key.",{"type":"102","examples":"112","$schema":"104","x-stoplight":"113"},["106","107","108","109","110","111"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119"},{"default":"120","description":"121","enum":"122"},"8f77bacf0a984","application/json",["123"],[],{"type":"124","x-examples":"125","properties":"126","$schema":"104","x-stoplight":"127"},"82bb882dd5cb7",[],[],{"type":"124","$schema":"104","x-stoplight":"128"},"a32cef30460a5",["129","130","131"],[],{"type":"124","properties":"132","required":"133","title":"134","$schema":"104","x-stoplight":"135"},"454aa94842f54",[],[],{"type":"124","x-examples":"136","properties":"137","$schema":"104","x-stoplight":"138"},"string",["139"],"http://json-schema.org/draft-07/schema#",{"id":"140"},"name","in","required","schema","description","title",["141"],{"id":"142"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["120","143"],{"id":"144","key":"145","value":"146"},"object",{"Example 1":"147"},{"id":"148","name":"149","created_at":"150","updated_at":"151","tags":"152","next":"153"},{"id":"154"},{"id":"155"},{"id":"156","key":"157","value":"158","summary":"159"},{"id":"160","key":"161","value":"162","summary":"163"},{"id":"164","key":"165","value":"166","summary":"167"},{"status":"168","message":"169"},["170","171"],"UnauthorizedError",{"id":"172"},{"Example 1":"173"},{"name":"174","tags":"175"},{"id":"176"},"team-a","501703f2c76ed","46CA83EE-671C-11ED-BFAB-2FE47512C77A","46b167c0215e6","https","272a9e0a07a76","example",{"id":"177","name":"178","created_at":1422386534,"updated_at":1422386534,"tags":"179","next":"180"},{"id":"181","name":"182","created_at":1422386534,"updated_at":1422386534,"tags":"183","next":"180"},{"type":"102","examples":"184"},{"type":"102","description":"185","examples":"186"},{"type":"187","description":"188","examples":"189"},{"type":"187","description":"190","examples":"191"},{"type":"192","description":"185","items":"193"},{"type":"102","description":"194","examples":"195"},"2cac12b7bc1a0","18f6961b39032","d9f70ee790f70","DuplicateApiKey",{"message":"159","status":401},"Duplicate API key found","bd15249b9a324","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","9c34b84734908","NoAPIKey",{"message":"196","status":401},"No API key found",{"type":"187"},{"type":"102"},"status","message","470b68e5f0549",{"name":"178","tags":"197"},{"type":"102","description":"185","examples":"198"},{"type":"192","description":"199","items":"200"},"15d5e0ab40247","4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F","my-key_set",["102"],"http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969","b58c7d9d-e54f-444c-b24d-cdfc4159f61e","example-key-set",["201"],["177"],"The name to associate with the given key-set.\n",["178"],"integer","Unix epoch when the resource was last created.",[1422386534],"Unix epoch when the resource was last updated.\n",[1422386534],"array",{"type":"102"},"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page\n",["180"],"No API key found in request",["202","203"],["178"],"An optional set of strings associated with the Key for grouping and filtering.\n",{"type":"102"},"idp-keys","google-keys","mozilla-keys"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all Workspaces",["18"],"acd971f23f9ab","get","/workspaces",["19"],{},"list-workspace","List all Workspaces\n\nFor workspace use cases and configuration examples, see [Workspace examples](https://docs.konghq.com/gateway/latest/kong-enterprise/workspaces/). This endpoint will only return workspaces that the current user has access to.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Workspaces",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40","41"],[],[],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"a5dc04b4ff415","c378d4f26f1a5","200",[],["48"],"A successful response listing Workspaces","88c8d59af8143","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","schema":"67","explicitProperties":"68"},{"id":"69","key":"70","extensions":"71","description":"72","type":"73","name":"74","in":"75"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"76","path":"77","port":"78","protocol":"79"},{"id":"80","mediaType":"81","examples":"82","encodings":"83","schema":"84"},{"id":"85","mediaType":"81","examples":"86","encodings":"87","schema":"88"},"026cd3c5be2f1","size","form",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96"],"8a23197423e87","offset",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"97","$schema":"90","x-stoplight":"98"},["92","93","94","95","96"],"3d0d489fabb83","tags",["99"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"97","examples":"100","x-stoplight":"101","$schema":"90"},["92","102","93","94","95","96"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"103","description":"104"},{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110","enum":"111"},"e80a550cfaa0e","application/json",[],[],{"properties":"112","$schema":"90","x-stoplight":"113"},"ed1d04a986daa",["114","115","116"],[],{"type":"117","properties":"118","required":"119","title":"120","$schema":"90","x-stoplight":"121"},"integer","http://json-schema.org/draft-07/schema#",{"id":"122"},"description","in","name","schema","title","string",{"id":"123"},{"id":"124","value":"125","key":"126"},["125"],{"explicitProperties":"127","id":"128"},"example","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["109","129"],{"data":"130","offset":"131"},{"id":"132"},{"id":"133","key":"134","value":"135","summary":"136"},{"id":"137","key":"138","value":"139","summary":"140"},{"id":"141","key":"142","value":"143","summary":"144"},"object",{"status":"145","message":"146"},["147","148"],"UnauthorizedError",{"id":"149"},"bc5df82cf7167","c1bf35ed973eb","ae8631e49f1be","tag1,tag2","default",["150","151","152"],"1ba9fc92dd297","https",{"items":"153","type":"154"},{"description":"155","type":"97","title":"156"},"e764eddee0a39","465c1416d130b","DuplicateApiKey",{"message":"136","status":401},"Duplicate API key found","2600b16d2debc","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","481a964544182","NoAPIKey",{"message":"157","status":401},"No API key found",{"type":"89"},{"type":"97"},"status","message","470b68e5f0549","type","nullable","examples",{"type":"117","properties":"158","x-examples":"159","description":"160","title":"161"},"array","Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","pagination-offset-response","No API key found in request",{"comment":"162","config":"163","created_at":"164","id":"165","meta":"166","name":"167"},{"Example 1":"168"},"Workspaces provide a way to segment Kong entities.","Workspace",{"type":"97"},{"type":"117","properties":"169"},{"description":"170","type":"89"},{"type":"97","description":"171"},{"type":"117","properties":"172"},{"type":"97"},{"comment":"97","config":"173","created_at":0,"id":"97","meta":"174","name":"97"},{"meta":"175","portal":"176","portal_access_request_email":"177","portal_application_request_email":"178","portal_application_status_email":"179","portal_approved_email":"180","portal_auth":"181","portal_auth_conf":"182","portal_auto_approve":"183","portal_cors_origins":"184","portal_developer_meta_fields":"185","portal_emails_from":"186","portal_emails_reply_to":"187","portal_invite_email":"188","portal_is_legacy":"189","portal_reset_email":"190","portal_reset_success_email":"191","portal_session_conf":"192","portal_smtp_admin_emails":"193","portal_token_exp":"194"},"Unix epoch when the resource was created.","The unique UUID for this resource.",{"color":"195","thumbnail":"196"},{"meta":"197","portal":false,"portal_access_request_email":true,"portal_application_request_email":true,"portal_application_status_email":true,"portal_approved_email":true,"portal_auth":"97","portal_auth_conf":"97","portal_auto_approve":true,"portal_cors_origins":"198","portal_developer_meta_fields":"199","portal_emails_from":"97","portal_emails_reply_to":"97","portal_invite_email":true,"portal_is_legacy":true,"portal_reset_email":true,"portal_reset_success_email":true,"portal_session_conf":"97","portal_smtp_admin_emails":"200","portal_token_exp":0},{"color":"97","thumbnail":"97"},{"type":"117"},{"default":false,"type":"201","description":"202"},{"type":"201"},{"type":"201"},{"type":"201"},{"type":"201"},{"type":"97"},{"type":"97"},{"type":"201"},{"type":"154","items":"203"},{"default":"199","type":"97"},{"type":"97"},{"type":"97"},{"type":"201"},{"type":"201"},{"type":"201"},{"type":"201"},{"type":"97"},{"type":"154","items":"204"},{"type":"89"},{"type":"97"},{"type":"97"},{},["97"],"[{\"label\":\"Full Name\",\"title\":\"full_name\",\"validator\":{\"required\":true,\"type\":\"string\"}}]",["97"],"boolean","Portal enabled",{"type":"97"},{"type":"97"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create a new Workspace",["18"],"f10f7215b520d","post","/workspaces",["19"],{},"create-workspace","Create a new Workspace\n\nFor workspace use cases and configuration examples, see [Workspace examples](https://docs.konghq.com/gateway/3.2.x/kong-enterprise/workspaces/).\n","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Workspaces",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","required":true,"description":"48"},[],[],[],[],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"a5dc04b4ff415","d159138a78c23","200",[],["55"],"Successfully created Workspace","793911adb6bbb","400",[],["56"],"Invalid Workspace","794911adb6a68","401",[],["57"],"Unauthorized","c4e47afae7ff2",["58"],"Description of the new Workspace for creation",{"id":"59","key":"60","extensions":"61","description":"62","type":"63","name":"64","in":"65"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"66","path":"67","port":"68","protocol":"69"},{"id":"70","mediaType":"71","examples":"72","encodings":"73","schema":"74"},{"id":"75","mediaType":"71","examples":"76","encodings":"77","schema":"78"},{"id":"79","mediaType":"71","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"71","examples":"84","encodings":"85","schema":"74"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"86","description":"87"},{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93","enum":"94"},"8f6f924e16f28","application/json",[],[],{"type":"95","properties":"96","x-examples":"97","description":"98","title":"99"},"91c04a24b633e",[],[],{"type":"95","$schema":"100","x-stoplight":"101"},"d8c79c8c6cc00",["102","103","104"],[],{"type":"95","properties":"105","required":"106","title":"107","$schema":"100","x-stoplight":"108"},"bf7bc1f172709",[],[],"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["92","109"],"object",{"comment":"110","config":"111","created_at":"112","id":"113","meta":"114","name":"115"},{"Example 1":"116"},"Workspaces provide a way to segment Kong entities.","Workspace","http://json-schema.org/draft-07/schema#",{"id":"117"},{"id":"118","key":"119","value":"120","summary":"121"},{"id":"122","key":"123","value":"124","summary":"125"},{"id":"126","key":"127","value":"128","summary":"129"},{"status":"130","message":"131"},["132","133"],"UnauthorizedError",{"id":"134"},"https",{"type":"135"},{"type":"95","properties":"136"},{"description":"137","type":"138"},{"type":"135","description":"139"},{"type":"95","properties":"140"},{"type":"135"},{"comment":"135","config":"141","created_at":0,"id":"135","meta":"142","name":"135"},"5e45fc9c292d2","0a2dc8297ba94","DuplicateApiKey",{"message":"121","status":401},"Duplicate API key found","ab2f645d2906a","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","d7a1864f7b455","NoAPIKey",{"message":"143","status":401},"No API key found",{"type":"138"},{"type":"135"},"status","message","470b68e5f0549","string",{"meta":"144","portal":"145","portal_access_request_email":"146","portal_application_request_email":"147","portal_application_status_email":"148","portal_approved_email":"149","portal_auth":"150","portal_auth_conf":"151","portal_auto_approve":"152","portal_cors_origins":"153","portal_developer_meta_fields":"154","portal_emails_from":"155","portal_emails_reply_to":"156","portal_invite_email":"157","portal_is_legacy":"158","portal_reset_email":"159","portal_reset_success_email":"160","portal_session_conf":"161","portal_smtp_admin_emails":"162","portal_token_exp":"163"},"Unix epoch when the resource was created.","integer","The unique UUID for this resource.",{"color":"164","thumbnail":"165"},{"meta":"166","portal":false,"portal_access_request_email":true,"portal_application_request_email":true,"portal_application_status_email":true,"portal_approved_email":true,"portal_auth":"135","portal_auth_conf":"135","portal_auto_approve":true,"portal_cors_origins":"167","portal_developer_meta_fields":"168","portal_emails_from":"135","portal_emails_reply_to":"135","portal_invite_email":true,"portal_is_legacy":true,"portal_reset_email":true,"portal_reset_success_email":true,"portal_session_conf":"135","portal_smtp_admin_emails":"169","portal_token_exp":0},{"color":"135","thumbnail":"135"},"No API key found in request",{"type":"95"},{"default":false,"type":"170","description":"171"},{"type":"170"},{"type":"170"},{"type":"170"},{"type":"170"},{"type":"135"},{"type":"135"},{"type":"170"},{"type":"172","items":"173"},{"default":"168","type":"135"},{"type":"135"},{"type":"135"},{"type":"170"},{"type":"170"},{"type":"170"},{"type":"170"},{"type":"135"},{"type":"172","items":"174"},{"type":"138"},{"type":"135"},{"type":"135"},{},["135"],"[{\"label\":\"Full Name\",\"title\":\"full_name\",\"validator\":{\"required\":true,\"type\":\"string\"}}]",["135"],"boolean","Portal enabled","array",{"type":"135"},{"type":"135"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a Workspace",["17"],"1c3919e2573a1","delete","/workspaces/{workspace_id_or_name}",["18"],{},"delete-workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Workspaces",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38"],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"a5dc04b4ff415","1c7cff61e7d6c","204",[],[],"Successfully deleted Workspace or the resource didn't exist","874cfed078581","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","schema":"52","explicitProperties":"53"},{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},"d86848b32bf29","cascade","form",[],"The `cascade` option lets you delete a workspace and all of its entities in one request.",{"type":"77","examples":"78","$schema":"79","x-stoplight":"80"},["81","82","83","84"],"9d358bd930ff9","workspace_id_or_name","simple",[],"ID or name of the workspace to look up.",{"type":"85","examples":"86","$schema":"79","x-stoplight":"87"},["83","82","88","81","84","89"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95"},{"default":"96","description":"97","enum":"98"},"87aa1bbf90f4e","application/json",["99","100","101"],[],{"type":"102","properties":"103","required":"104","title":"105","$schema":"79","x-stoplight":"106"},"boolean",[true],"http://json-schema.org/draft-07/schema#",{"id":"107"},"schema","in","name","description","string",["108"],{"id":"109"},"required","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["96","110"],{"id":"111","key":"112","value":"113","summary":"114"},{"id":"115","key":"116","value":"117","summary":"118"},{"id":"119","key":"120","value":"121","summary":"122"},"object",{"status":"123","message":"124"},["125","126"],"UnauthorizedError",{"id":"127"},"7b78ecbce22da","2747d1e5-8246-4f65-a939-b392f1ee17f8","5d8c493863aae","https","f39face1c74df","DuplicateApiKey",{"message":"114","status":401},"Duplicate API key found","a5881af1a819a","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","3035b7a6522ba","NoAPIKey",{"message":"128","status":401},"No API key found",{"type":"129"},{"type":"85"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Fetch a Workspace",["18"],"811090af91a31","get","/workspaces/{workspace_id_or_name}",["19"],{},"get-workspace","Get a Workspace using ID or name.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Workspaces",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45"],["46"],{"id":"47","url":"48","name":"49","description":"50","variables":"51"},"a5dc04b4ff415","fef8eb725cb3e","200",[],["52"],"Successfully fetched Workspace","9468ec03cca8f","401",[],["53"],"Unauthorized","9418ec03cc230","404",[],[],"Resource does not exist",{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},{"id":"77","mediaType":"73","examples":"78","encodings":"79","schema":"80"},"53d7c777dff2f","workspace_id_or_name","simple",[],"ID or name of the workspace to look up.",{"type":"81","examples":"82","$schema":"83","x-stoplight":"84"},["85","86","87","88","89","90"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"f3258f8be64b7","application/json",[],[],{"type":"100","properties":"101","x-examples":"102","description":"103","title":"104"},"e6372fd95054e",["105","106","107"],[],{"type":"100","properties":"108","required":"109","title":"110","$schema":"83","x-stoplight":"111"},"string",["112"],"http://json-schema.org/draft-07/schema#",{"id":"113"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","114"],"object",{"comment":"115","config":"116","created_at":"117","id":"118","meta":"119","name":"120"},{"Example 1":"121"},"Workspaces provide a way to segment Kong entities.","Workspace",{"id":"122","key":"123","value":"124","summary":"125"},{"id":"126","key":"127","value":"128","summary":"129"},{"id":"130","key":"131","value":"132","summary":"133"},{"status":"134","message":"135"},["136","137"],"UnauthorizedError",{"id":"138"},"2747d1e5-8246-4f65-a939-b392f1ee17f8","cb39f9de6585d","https",{"type":"81"},{"type":"100","properties":"139"},{"description":"140","type":"141"},{"type":"81","description":"142"},{"type":"100","properties":"143"},{"type":"81"},{"comment":"81","config":"144","created_at":0,"id":"81","meta":"145","name":"81"},"9c3a67fa764da","DuplicateApiKey",{"message":"125","status":401},"Duplicate API key found","439462c2772a8","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","3a5f37891ff63","NoAPIKey",{"message":"146","status":401},"No API key found",{"type":"141"},{"type":"81"},"status","message","470b68e5f0549",{"meta":"147","portal":"148","portal_access_request_email":"149","portal_application_request_email":"150","portal_application_status_email":"151","portal_approved_email":"152","portal_auth":"153","portal_auth_conf":"154","portal_auto_approve":"155","portal_cors_origins":"156","portal_developer_meta_fields":"157","portal_emails_from":"158","portal_emails_reply_to":"159","portal_invite_email":"160","portal_is_legacy":"161","portal_reset_email":"162","portal_reset_success_email":"163","portal_session_conf":"164","portal_smtp_admin_emails":"165","portal_token_exp":"166"},"Unix epoch when the resource was created.","integer","The unique UUID for this resource.",{"color":"167","thumbnail":"168"},{"meta":"169","portal":false,"portal_access_request_email":true,"portal_application_request_email":true,"portal_application_status_email":true,"portal_approved_email":true,"portal_auth":"81","portal_auth_conf":"81","portal_auto_approve":true,"portal_cors_origins":"170","portal_developer_meta_fields":"171","portal_emails_from":"81","portal_emails_reply_to":"81","portal_invite_email":true,"portal_is_legacy":true,"portal_reset_email":true,"portal_reset_success_email":true,"portal_session_conf":"81","portal_smtp_admin_emails":"172","portal_token_exp":0},{"color":"81","thumbnail":"81"},"No API key found in request",{"type":"100"},{"default":false,"type":"173","description":"174"},{"type":"173"},{"type":"173"},{"type":"173"},{"type":"173"},{"type":"81"},{"type":"81"},{"type":"173"},{"type":"175","items":"176"},{"default":"171","type":"81"},{"type":"81"},{"type":"81"},{"type":"173"},{"type":"173"},{"type":"173"},{"type":"173"},{"type":"81"},{"type":"175","items":"177"},{"type":"141"},{"type":"81"},{"type":"81"},{},["81"],"[{\"label\":\"Full Name\",\"title\":\"full_name\",\"validator\":{\"required\":true,\"type\":\"string\"}}]",["81"],"boolean","Portal enabled","array",{"type":"81"},{"type":"81"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update a Workspace",["17"],"0d245cc96e585","patch","/workspaces/{workspace_id_or_name}",["18"],{},"update-workspace","inheritedFromService",["19","20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Workspaces",{"id":"30","name":"17"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","contents":"52","required":true,"description":"53"},[],[],[],["54"],["55"],{"id":"56","url":"57","name":"58","description":"59","variables":"60"},"a5dc04b4ff415","4ce6a9ceff7a0","200",[],["61"],"Successfully updated Workspace","ecc6a7f22faab","400",[],["62"],"Invalid Workspace","ecd6a7f230578","401",[],["63"],"Unauthorized","ed06a7f230057","404",[],[],"Resource does not exist","d18fc88e71a57",["64"],"Fields of the Workspace that need to be updated",{"id":"65","name":"66","style":"67","examples":"68","description":"69","required":true,"schema":"70","explicitProperties":"71"},{"id":"72","key":"73","extensions":"74","description":"75","type":"76","name":"77","in":"78"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"79","path":"80","port":"81","protocol":"82"},{"id":"83","mediaType":"84","examples":"85","encodings":"86","schema":"87"},{"id":"88","mediaType":"84","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"84","examples":"93","encodings":"94","schema":"95"},{"id":"96","mediaType":"84","examples":"97","encodings":"98","schema":"87"},"f7f7dda2b6cfe","workspace_id_or_name","simple",[],"ID or name of the workspace to look up.",{"type":"99","examples":"100","$schema":"101","x-stoplight":"102"},["103","104","105","106","107","108"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"109","description":"110"},{"default":"111","description":"112"},{"default":"113","description":"114"},{"default":"115","description":"116","enum":"117"},"41e0bac5875e1","application/json",[],[],{"type":"118","properties":"119","x-examples":"120","description":"121","title":"122"},"c8f162118a74e",[],[],{"type":"118","$schema":"101","x-stoplight":"123"},"6816c944a3177",["124","125","126"],[],{"type":"118","properties":"127","required":"128","title":"129","$schema":"101","x-stoplight":"130"},"ec6ed5ecdac3e",[],[],"string",["131"],"http://json-schema.org/draft-07/schema#",{"id":"132"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["115","133"],"object",{"comment":"134","config":"135","created_at":"136","id":"137","meta":"138","name":"139"},{"Example 1":"140"},"Workspaces provide a way to segment Kong entities.","Workspace",{"id":"141"},{"id":"142","key":"143","value":"144","summary":"145"},{"id":"146","key":"147","value":"148","summary":"149"},{"id":"150","key":"151","value":"152","summary":"153"},{"status":"154","message":"155"},["156","157"],"UnauthorizedError",{"id":"158"},"2747d1e5-8246-4f65-a939-b392f1ee17f8","cbb7b5d8932be","https",{"type":"99"},{"type":"118","properties":"159"},{"description":"160","type":"161"},{"type":"99","description":"162"},{"type":"118","properties":"163"},{"type":"99"},{"comment":"99","config":"164","created_at":0,"id":"99","meta":"165","name":"99"},"8af47b38ca3ee","a5fdbcdd367f2","DuplicateApiKey",{"message":"145","status":401},"Duplicate API key found","f7f4a9a09faf0","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","7c3e0259a135a","NoAPIKey",{"message":"166","status":401},"No API key found",{"type":"161"},{"type":"99"},"status","message","470b68e5f0549",{"meta":"167","portal":"168","portal_access_request_email":"169","portal_application_request_email":"170","portal_application_status_email":"171","portal_approved_email":"172","portal_auth":"173","portal_auth_conf":"174","portal_auto_approve":"175","portal_cors_origins":"176","portal_developer_meta_fields":"177","portal_emails_from":"178","portal_emails_reply_to":"179","portal_invite_email":"180","portal_is_legacy":"181","portal_reset_email":"182","portal_reset_success_email":"183","portal_session_conf":"184","portal_smtp_admin_emails":"185","portal_token_exp":"186"},"Unix epoch when the resource was created.","integer","The unique UUID for this resource.",{"color":"187","thumbnail":"188"},{"meta":"189","portal":false,"portal_access_request_email":true,"portal_application_request_email":true,"portal_application_status_email":true,"portal_approved_email":true,"portal_auth":"99","portal_auth_conf":"99","portal_auto_approve":true,"portal_cors_origins":"190","portal_developer_meta_fields":"191","portal_emails_from":"99","portal_emails_reply_to":"99","portal_invite_email":true,"portal_is_legacy":true,"portal_reset_email":true,"portal_reset_success_email":true,"portal_session_conf":"99","portal_smtp_admin_emails":"192","portal_token_exp":0},{"color":"99","thumbnail":"99"},"No API key found in request",{"type":"118"},{"default":false,"type":"193","description":"194"},{"type":"193"},{"type":"193"},{"type":"193"},{"type":"193"},{"type":"99"},{"type":"99"},{"type":"193"},{"type":"195","items":"196"},{"default":"191","type":"99"},{"type":"99"},{"type":"99"},{"type":"193"},{"type":"193"},{"type":"193"},{"type":"193"},{"type":"99"},{"type":"195","items":"197"},{"type":"161"},{"type":"99"},{"type":"99"},{},["99"],"[{\"label\":\"Full Name\",\"title\":\"full_name\",\"validator\":{\"required\":true,\"type\":\"string\"}}]",["99"],"boolean","Portal enabled","array",{"type":"99"},{"type":"99"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/upsert-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Upsert a Workspace",["18"],"13b59f61ab3e1","put","/workspaces/{workspace_id_or_name}",["19"],{},"upsert-workspace","Create or Update Workspace using ID or name.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Workspaces",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","required":true,"description":"48"},[],[],[],["49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"a5dc04b4ff415","3ea79c4eaa9a7","200",[],["56"],"Successfully upserted Workspace","66c79e14536d0","400",[],["57"],"Invalid Workspace","66d79e14538a7","401",[],["58"],"Unauthorized","2caa84a623060",["59"],"Description of the Workspace",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"79","examples":"84","encodings":"85","schema":"86"},{"id":"87","mediaType":"79","examples":"88","encodings":"89","schema":"90"},{"id":"91","mediaType":"79","examples":"92","encodings":"93","schema":"82"},"56c9de7f55581","workspace_id_or_name","simple",[],"ID or name of the workspace to look up.",{"type":"94","examples":"95","$schema":"96","x-stoplight":"97"},["98","99","100","101","102","103"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111","enum":"112"},"6b69f09946085","application/json",[],[],{"type":"113","properties":"114","x-examples":"115","description":"116","title":"117"},"72b30042ec3e0",[],[],{"type":"113","$schema":"96","x-stoplight":"118"},"8fa16c935d8ba",["119","120","121"],[],{"type":"113","properties":"122","required":"123","title":"124","$schema":"96","x-stoplight":"125"},"87fcbda8e4c3d",[],[],"string",["126"],"http://json-schema.org/draft-07/schema#",{"id":"127"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["110","128"],"object",{"comment":"129","config":"130","created_at":"131","id":"132","meta":"133","name":"134"},{"Example 1":"135"},"Workspaces provide a way to segment Kong entities.","Workspace",{"id":"136"},{"id":"137","key":"138","value":"139","summary":"140"},{"id":"141","key":"142","value":"143","summary":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"status":"149","message":"150"},["151","152"],"UnauthorizedError",{"id":"153"},"2747d1e5-8246-4f65-a939-b392f1ee17f8","0ceae134ea93c","https",{"type":"94"},{"type":"113","properties":"154"},{"description":"155","type":"156"},{"type":"94","description":"157"},{"type":"113","properties":"158"},{"type":"94"},{"comment":"94","config":"159","created_at":0,"id":"94","meta":"160","name":"94"},"ea87abd1028ae","0917e92e3aa8c","DuplicateApiKey",{"message":"140","status":401},"Duplicate API key found","fedea8f2ef910","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","d2f6d9fcb2c15","NoAPIKey",{"message":"161","status":401},"No API key found",{"type":"156"},{"type":"94"},"status","message","470b68e5f0549",{"meta":"162","portal":"163","portal_access_request_email":"164","portal_application_request_email":"165","portal_application_status_email":"166","portal_approved_email":"167","portal_auth":"168","portal_auth_conf":"169","portal_auto_approve":"170","portal_cors_origins":"171","portal_developer_meta_fields":"172","portal_emails_from":"173","portal_emails_reply_to":"174","portal_invite_email":"175","portal_is_legacy":"176","portal_reset_email":"177","portal_reset_success_email":"178","portal_session_conf":"179","portal_smtp_admin_emails":"180","portal_token_exp":"181"},"Unix epoch when the resource was created.","integer","The unique UUID for this resource.",{"color":"182","thumbnail":"183"},{"meta":"184","portal":false,"portal_access_request_email":true,"portal_application_request_email":true,"portal_application_status_email":true,"portal_approved_email":true,"portal_auth":"94","portal_auth_conf":"94","portal_auto_approve":true,"portal_cors_origins":"185","portal_developer_meta_fields":"186","portal_emails_from":"94","portal_emails_reply_to":"94","portal_invite_email":true,"portal_is_legacy":true,"portal_reset_email":true,"portal_reset_success_email":true,"portal_session_conf":"94","portal_smtp_admin_emails":"187","portal_token_exp":0},{"color":"94","thumbnail":"94"},"No API key found in request",{"type":"113"},{"default":false,"type":"188","description":"189"},{"type":"188"},{"type":"188"},{"type":"188"},{"type":"188"},{"type":"94"},{"type":"94"},{"type":"188"},{"type":"190","items":"191"},{"default":"186","type":"94"},{"type":"94"},{"type":"94"},{"type":"188"},{"type":"188"},{"type":"188"},{"type":"188"},{"type":"94"},{"type":"190","items":"192"},{"type":"156"},{"type":"94"},{"type":"94"},{},["94"],"[{\"label\":\"Full Name\",\"title\":\"full_name\",\"validator\":{\"required\":true,\"type\":\"string\"}}]",["94"],"boolean","Portal enabled","array",{"type":"94"},{"type":"94"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-groups",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Retrieve a list of all groups",["17"],"974286ee0f336","get","/workspace_/groups",["18"],{},"list-groups","inheritedFromService",["19"],{"headers":"20","query":"21","cookie":"22","path":"23"},["24"],["25"],"Workspaces",{"id":"26","name":"17"},{"id":"27","code":"28","headers":"29","contents":"30","description":"31"},[],[],[],[],["32"],{"id":"33","url":"34","name":"35","description":"36","variables":"37"},"a5dc04b4ff415","65a611752df74","200",[],["38"],"Successfully retrieved the list of groups",{"id":"39","key":"40","extensions":"41","description":"42","type":"43","name":"44","in":"45"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"46","path":"47","port":"48","protocol":"49"},{"id":"50","mediaType":"51","examples":"52","encodings":"53","schema":"54"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"55","description":"56"},{"default":"57","description":"58"},{"default":"59","description":"60"},{"default":"61","description":"62","enum":"63"},"b0f669402d0da","application/json",[],[],{"items":"64","type":"65","$schema":"66","x-stoplight":"67"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["61","68"],{"properties":"69","type":"70"},"array","http://json-schema.org/draft-07/schema#",{"id":"71"},"https",{"created_at":"72","id":"73","name":"74"},"object","ddcdda189890e",{"format":"75","type":"76"},{"type":"76"},{"type":"76"},"date-time","string"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-group",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Create a new group",["17"],"009889a53a4c2","post","/workspace_/groups",["18"],{},"create-group","inheritedFromService",["19"],{"body":"20","headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Workspaces",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","contents":"34"},[],[],[],[],["35"],{"id":"36","url":"37","name":"38","description":"39","variables":"40"},"a5dc04b4ff415","da3cbbf6f4302","201",[],["41"],"Successfully created the group","03f901d08328c",["42"],{"id":"43","key":"44","extensions":"45","description":"46","type":"47","name":"48","in":"49"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"50","path":"51","port":"52","protocol":"53"},{"id":"54","mediaType":"55","examples":"56","encodings":"57","schema":"58"},{"id":"59","mediaType":"55","examples":"60","encodings":"61","schema":"62"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"63","description":"64"},{"default":"65","description":"66"},{"default":"67","description":"68"},{"default":"69","description":"70","enum":"71"},"0b86740b6817f","application/json",[],[],{"properties":"72","type":"73","$schema":"74","x-stoplight":"75"},"0c6fe5991617f",[],[],{"properties":"76","required":"77","type":"73","$schema":"74","x-stoplight":"78"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["69","79"],{"created_at":"80","id":"81","name":"82"},"object","http://json-schema.org/draft-07/schema#",{"id":"83"},{"name":"84"},["85"],{"id":"86"},"https",{"format":"87","type":"88"},{"type":"88"},{"type":"88"},"701ddf18dbe1b",{"type":"88"},"name","8588ba3beef7b","date-time","string"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/update-group",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update details of a specific group",["17"],"137b367235335","patch","/workspace_/groups/{groups}",["18"],{},"update-group","inheritedFromService",["19"],{"body":"20","headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Workspaces",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","contents":"34"},[],[],[],["35"],["36"],{"id":"37","url":"38","name":"39","description":"40","variables":"41"},"a5dc04b4ff415","235dc79402997","200",[],[],"Successfully updated the group","d355e8d0280c3",["42"],{"id":"43","name":"44","style":"45","examples":"46","required":true,"schema":"47","explicitProperties":"48"},{"id":"49","key":"50","extensions":"51","description":"52","type":"53","name":"54","in":"55"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"56","path":"57","port":"58","protocol":"59"},{"id":"60","mediaType":"61","examples":"62","encodings":"63","schema":"64"},"9163065f3ef8f","groups","simple",[],{"type":"65","$schema":"66","x-stoplight":"67"},["68","69","70","71"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"72","description":"73"},{"default":"74","description":"75"},{"default":"76","description":"77"},{"default":"78","description":"79","enum":"80"},"29e267fc216d9","application/json",[],[],{"properties":"81","type":"82","$schema":"66","x-stoplight":"83"},"string","http://json-schema.org/draft-07/schema#",{"id":"84"},"in","name","required","schema","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["78","85"],{"name":"86"},"object",{"id":"87"},"997c081d72e16","https",{"type":"65"},"d36ee2fe9bf92"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/remove-role-from-group",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Remove a role association from a group",["17"],"fd2d75e12385e","delete","/workspace_/groups/{groups}/roles",["18"],{},"remove-role-from-group","inheritedFromService",["19"],{"headers":"20","query":"21","cookie":"22","path":"23"},["24"],["25"],"Workspaces",{"id":"26","name":"17"},{"id":"27","code":"28","headers":"29","contents":"30","description":"31"},[],["32","33"],[],["34"],["35"],{"id":"36","url":"37","name":"38","description":"39","variables":"40"},"a5dc04b4ff415","54069c570f30e","204",[],[],"Successfully removed the role association",{"id":"41","name":"42","style":"43","examples":"44","required":true,"schema":"45","explicitProperties":"46"},{"id":"47","name":"48","style":"43","examples":"49","required":true,"schema":"50","explicitProperties":"51"},{"id":"52","name":"53","style":"54","examples":"55","required":true,"schema":"56","explicitProperties":"57"},{"id":"58","key":"59","extensions":"60","description":"61","type":"62","name":"63","in":"64"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"65","path":"66","port":"67","protocol":"68"},"532df42516175","rbac_role_id","form",[],{"type":"69","$schema":"70","x-stoplight":"71"},["72","73","74","75"],"738459749dde4","workspace_id",[],{"type":"69","$schema":"70","x-stoplight":"76"},["72","73","74","75"],"4d0f2ba93caa2","groups","simple",[],{"type":"69","$schema":"70","x-stoplight":"77"},["72","73","74","75"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"78","description":"79"},{"default":"80","description":"81"},{"default":"82","description":"83"},{"default":"84","description":"85","enum":"86"},"string","http://json-schema.org/draft-07/schema#",{"id":"87"},"in","name","required","schema",{"id":"88"},{"id":"89"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["84","90"],"9d797aa7bf4e9","995fa883b8bd5","d30140049919d","https"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/list-group-roles",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Retrieve roles associated with a specific group",["17"],"c51811fa26947","get","/workspace_/groups/{groups}/roles",["18"],{},"list-group-roles","inheritedFromService",["19"],{"headers":"20","query":"21","cookie":"22","path":"23"},["24"],["25"],"Workspaces",{"id":"26","name":"17"},{"id":"27","code":"28","headers":"29","contents":"30","description":"31"},[],[],[],["32"],["33"],{"id":"34","url":"35","name":"36","description":"37","variables":"38"},"a5dc04b4ff415","aabc82cbf3849","200",[],["39"],"Successfully retrieved the roles",{"id":"40","name":"41","style":"42","examples":"43","required":true,"schema":"44","explicitProperties":"45"},{"id":"46","key":"47","extensions":"48","description":"49","type":"50","name":"51","in":"52"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"53","path":"54","port":"55","protocol":"56"},{"id":"57","mediaType":"58","examples":"59","encodings":"60","schema":"61"},"3bfe2ac1488f3","groups","simple",[],{"type":"62","$schema":"63","x-stoplight":"64"},["65","66","67","68"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74"},{"default":"75","description":"76","enum":"77"},"7999f26b4e1fb","application/json",[],[],{"items":"78","type":"79","$schema":"63","x-stoplight":"80"},"string","http://json-schema.org/draft-07/schema#",{"id":"81"},"in","name","required","schema","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["75","82"],{"properties":"83","type":"84"},"array",{"id":"85"},"ccab5200185b0","https",{"group":"86","rbac_role":"87","workspace":"88"},"object","25c96c281df4d",{"properties":"89","type":"84"},{"properties":"90","type":"84"},{"properties":"91","type":"84"},{"id":"92","name":"93"},{"id":"94","name":"95"},{"id":"96"},{"type":"62"},{"type":"62"},{"type":"62"},{"type":"62"},{"type":"62"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/add-role-to-group",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Associate a role with a group",["17"],"cd955f08fc84c","post","/workspace_/groups/{groups}/roles",["18"],{},"add-role-to-group","inheritedFromService",["19"],{"body":"20","headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Workspaces",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","contents":"34"},[],[],[],["35"],["36"],{"id":"37","url":"38","name":"39","description":"40","variables":"41"},"a5dc04b4ff415","339061561895f","201",[],["42"],"Successfully associated the role with the group","cf87f38371f71",["43"],{"id":"44","name":"45","style":"46","examples":"47","required":true,"schema":"48","explicitProperties":"49"},{"id":"50","key":"51","extensions":"52","description":"53","type":"54","name":"55","in":"56"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"57","path":"58","port":"59","protocol":"60"},{"id":"61","mediaType":"62","examples":"63","encodings":"64","schema":"65"},{"id":"66","mediaType":"62","examples":"67","encodings":"68","schema":"69"},"4050cbc6d9329","groups","simple",[],{"type":"70","$schema":"71","x-stoplight":"72"},["73","74","75","76"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"77","description":"78"},{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84","enum":"85"},"297a59a04a583","application/json",[],[],{"properties":"86","type":"87","$schema":"71","x-stoplight":"88"},"7650a094a916b",[],[],{"properties":"89","required":"90","type":"87","$schema":"71","x-stoplight":"91"},"string","http://json-schema.org/draft-07/schema#",{"id":"92"},"in","name","required","schema","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["83","93"],{"group":"94","rbac_role":"95","workspace":"96"},"object",{"id":"97"},{"rbac_role_id":"98","workspace_id":"99"},["100","101"],{"id":"102"},"fd98d0d9fd156","https",{"properties":"103","type":"87"},{"properties":"104","type":"87"},{"properties":"105","type":"87"},"f283f27634797",{"type":"70"},{"type":"70"},"rbac_role_id","workspace_id","c7aab103d9a34",{"id":"106","name":"107"},{"id":"108","name":"109"},{"id":"110"},{"type":"70"},{"type":"70"},{"type":"70"},{"type":"70"},{"type":"70"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-licenses",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List licenses",["18"],"5e9d702ae3bde","get","/licenses",["19"],{},"get-licenses","List active licenses. The data planes use the most recent updated_at license.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"licenses",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"b2ca266667082","cf581c9a8ac24","200",[],["45"],"The license response object.","64a81d2bf9229","401",[],["46"],"Unauthorized",{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},{"id":"63","mediaType":"59","examples":"64","encodings":"65","schema":"66"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"87bf8bc14d888","application/json",["76","77"],[],{"type":"78","x-examples":"79","properties":"80","$schema":"81","x-stoplight":"82"},"df7adcae7b666",["83","84","85"],[],{"type":"78","properties":"86","required":"87","title":"88","$schema":"81","x-stoplight":"89"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","90"],{"id":"91","key":"92","value":"93"},{"id":"94","key":"95","value":"96"},"object",{"Example 1":"97"},{"created_at":"98","id":"99","payload":"100","updated_at":"101"},"http://json-schema.org/draft-07/schema#",{"id":"102"},{"id":"103","key":"104","value":"105","summary":"106"},{"id":"107","key":"108","value":"109","summary":"110"},{"id":"111","key":"112","value":"113","summary":"114"},{"status":"115","message":"116"},["117","118"],"UnauthorizedError",{"id":"119"},"https","1a9fe6c2330df","Active license",{"created_at":1500508800,"id":"120","payload":"121","updated_at":1500508800},"654347de20d17","No license",{"data":"122","next":null},{"created_at":1500508800,"id":"120","payload":"123","updated_at":1500508800},{"type":"124","examples":"125"},{"type":"126","description":"127","examples":"128"},{"type":"126","description":"129","examples":"130"},{"type":"124","examples":"131"},"757a70753f51b","82a9779488c87","DuplicateApiKey",{"message":"106","status":401},"Duplicate API key found","d4a06457f1b4f","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","c9272e19b8e6f","NoAPIKey",{"message":"132","status":401},"No API key found",{"type":"124"},{"type":"126"},"status","message","470b68e5f0549","30b4edb7-0847-4f65-af90-efbed8b0161f","{\\\"license\\\":{\\\"payload\\\":{\\\"admin_seats\\\":\\\"1\\\",\\\"customer\\\":\\\"Example Company, Inc\\\",\\\"dataplanes\\\":\\\"1\\\",\\\"license_creation_date\\\":\\\"2017-07-20\\\",\\\"license_expiration_date\\\":\\\"2017-07-21\\\",\\\"license_key\\\":\\\"00141000017ODj3AAG_a1V41000004wT0OEAU\\\",\\\"product_subscription\\\":\\\"Konnect Enterprise\\\",\\\"support_plan\\\":\\\"None\\\"},\\\"signature\\\":\\\"24cc21223633044c15c300be19cacc26ccc5aca0dd9a12df8a7324a1970fe304bc07b8dcd7fb08d7b92e04169313377ae3b550ead653b951bc44cd2eb59f6beb\\\",\\\"version\\\":\\\"1\\\"}}",[],"{\"license\":{\"payload\":{\"admin_seats\":\"1\",\"customer\":\"Example Company, Inc\",\"dataplanes\":\"1\",\"license_creation_date\":\"2017-07-20\",\"license_expiration_date\":\"2017-07-21\",\"license_key\":\"00141000017ODj3AAG_a1V41000004wT0OEAU\",\"product_subscription\":\"Konnect Enterprise\",\"support_plan\":\"None\"},\"signature\":\"24cc21223633044c15c300be19cacc26ccc5aca0dd9a12df8a7324a1970fe304bc07b8dcd7fb08d7b92e04169313377ae3b550ead653b951bc44cd2eb59f6beb\",\"version\":\"1\"}}","integer",[1500508800],"string","The UUID of the license",["120"],"The Kong Gateway license in JSON format.\n",["121"],[1500508800],"No API key found in request"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-licenses",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Add a license",["18"],"0fcf002c234de","post","/licenses",["19"],{},"post-licenses","Create a license using an auto-generated UUID. When using `POST`, if the request payload does contain a valid Kong Gateway license, the license will be added.\n\nIf the request payload does not contain a valid licence, a `400 BAD REQUEST` will be returned.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"licenses",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","description":"48"},[],[],[],[],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"b2ca266667082","ef56cfa5088fb","201",[],["55"],"The license response object.","bcc6d04d9f54f","400",[],[],"Bad Request","bcb6d04d9f69c","401",[],["56"],"Unauthorized","c29e2c6c0affe",["57"],"The request body for uploading a license.",{"id":"58","key":"59","extensions":"60","description":"61","type":"62","name":"63","in":"64"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"65","path":"66","port":"67","protocol":"68"},{"id":"69","mediaType":"70","examples":"71","encodings":"72","schema":"73"},{"id":"74","mediaType":"70","examples":"75","encodings":"76","schema":"77"},{"id":"78","mediaType":"70","examples":"79","encodings":"80","schema":"81"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"82","description":"83"},{"default":"84","description":"85"},{"default":"86","description":"87"},{"default":"88","description":"89","enum":"90"},"d8ecc1fdf0d03","application/json",["91","92"],[],{"type":"93","x-examples":"94","properties":"95","$schema":"96","x-stoplight":"97"},"b937b8e1a4348",["98","99","100"],[],{"type":"93","properties":"101","required":"102","title":"103","$schema":"96","x-stoplight":"104"},"0a99eaac2aae9",[],[],{"type":"93","properties":"105","$schema":"96","x-stoplight":"106"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["88","107"],{"id":"108","key":"109","value":"110"},{"id":"111","key":"112","value":"113"},"object",{"Example 1":"114"},{"created_at":"115","id":"116","payload":"117","updated_at":"118"},"http://json-schema.org/draft-07/schema#",{"id":"119"},{"id":"120","key":"121","value":"122","summary":"123"},{"id":"124","key":"125","value":"126","summary":"127"},{"id":"128","key":"129","value":"130","summary":"131"},{"status":"132","message":"133"},["134","135"],"UnauthorizedError",{"id":"136"},{"payload":"137"},{"id":"138"},"https","187dfbdb4e96b","Active license",{"created_at":1500508800,"id":"139","payload":"140","updated_at":1500508800},"856416433fcb0","No license",{"data":"141","next":null},{"created_at":1500508800,"id":"139","payload":"142","updated_at":1500508800},{"type":"143","examples":"144"},{"type":"145","description":"146","examples":"147"},{"type":"145","description":"148","examples":"149"},{"type":"143","examples":"150"},"757a70753f51b","95898c4fb50f9","DuplicateApiKey",{"message":"123","status":401},"Duplicate API key found","3e763e3cdf282","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","bdcf8efc3d633","NoAPIKey",{"message":"151","status":401},"No API key found",{"type":"143"},{"type":"145"},"status","message","470b68e5f0549",{"type":"145","description":"148","examples":"152"},"4601ca9a2e41f","30b4edb7-0847-4f65-af90-efbed8b0161f","{\\\"license\\\":{\\\"payload\\\":{\\\"admin_seats\\\":\\\"1\\\",\\\"customer\\\":\\\"Example Company, Inc\\\",\\\"dataplanes\\\":\\\"1\\\",\\\"license_creation_date\\\":\\\"2017-07-20\\\",\\\"license_expiration_date\\\":\\\"2017-07-21\\\",\\\"license_key\\\":\\\"00141000017ODj3AAG_a1V41000004wT0OEAU\\\",\\\"product_subscription\\\":\\\"Konnect Enterprise\\\",\\\"support_plan\\\":\\\"None\\\"},\\\"signature\\\":\\\"24cc21223633044c15c300be19cacc26ccc5aca0dd9a12df8a7324a1970fe304bc07b8dcd7fb08d7b92e04169313377ae3b550ead653b951bc44cd2eb59f6beb\\\",\\\"version\\\":\\\"1\\\"}}",[],"{\"license\":{\"payload\":{\"admin_seats\":\"1\",\"customer\":\"Example Company, Inc\",\"dataplanes\":\"1\",\"license_creation_date\":\"2017-07-20\",\"license_expiration_date\":\"2017-07-21\",\"license_key\":\"00141000017ODj3AAG_a1V41000004wT0OEAU\",\"product_subscription\":\"Konnect Enterprise\",\"support_plan\":\"None\"},\"signature\":\"24cc21223633044c15c300be19cacc26ccc5aca0dd9a12df8a7324a1970fe304bc07b8dcd7fb08d7b92e04169313377ae3b550ead653b951bc44cd2eb59f6beb\",\"version\":\"1\"}}","integer",[1500508800],"string","The UUID of the license",["139"],"The Kong Gateway license in JSON format.\n",["140"],[1500508800],"No API key found in request",["153"],"{\\\"license\\\":{\\\"payload\\\":{\\\"admin_seats\\\":\\\"1\\\",\\\"customer\\\":\\\"Example Company, Inc\\\",\\\"dataplanes\\\":\\\"1\\\",\\\"license_creation_date\\\":\\\"2017-07-20\\\",\\\"license_expiration_date\\\":\\\"2017-07-20\\\",\\\"license_key\\\":\\\"00141000017ODj3AAG_a1V41000004wT0OEAU\\\",\\\"product_subscription\\\":\\\"Konnect Enterprise\\\",\\\"support_plan\\\":\\\"None\\\"},\\\"signature\\\":\\\"6985968131533a967fcc721244a979948b1066967f1e9cd65dbd8eeabe060fc32d894a2945f5e4a03c1cd2198c74e058ac63d28b045c2f1fcec95877bd790e1b\\\",\\\"version\\\":\\\"1\\\"}}"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-licenses-license-id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List a specific license",["18"],"6907090d886f3","get","/licenses/{license-id}",["19"],{},"get-licenses-license-id","List a specific license using the license id parameter.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"licenses",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"b2ca266667082","f3fa8ec6754bf","200",[],["46"],"The license response object.","4c0a90a3372d1","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","key":"56","extensions":"57","description":"58","type":"59","name":"60","in":"61"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"62","path":"63","port":"64","protocol":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},"5e4dac89ac4d9","license-id","simple",[],"The license's unique ID.",{"type":"75","examples":"76","$schema":"77","x-stoplight":"78"},["79","80","81","82","83","84"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"85","description":"86"},{"default":"87","description":"88"},{"default":"89","description":"90"},{"default":"91","description":"92","enum":"93"},"cb7899670bad6","application/json",["94","95"],[],{"type":"96","x-examples":"97","properties":"98","$schema":"77","x-stoplight":"99"},"62d62e4c58104",["100","101","102"],[],{"type":"96","properties":"103","required":"104","title":"105","$schema":"77","x-stoplight":"106"},"string",["107"],"http://json-schema.org/draft-07/schema#",{"id":"108"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["91","109"],{"id":"110","key":"111","value":"112"},{"id":"113","key":"114","value":"115"},"object",{"Example 1":"116"},{"created_at":"117","id":"118","payload":"119","updated_at":"120"},{"id":"121"},{"id":"122","key":"123","value":"124","summary":"125"},{"id":"126","key":"127","value":"128","summary":"129"},{"id":"130","key":"131","value":"132","summary":"133"},{"status":"134","message":"135"},["136","137"],"UnauthorizedError",{"id":"138"},"30b4edb7-0847-4f65-af90-efbed8b0161f","f5c145738d181","https","27eae7e961303","Active license",{"created_at":1500508800,"id":"107","payload":"139","updated_at":1500508800},"dc6d44fff3149","No license",{"data":"140","next":null},{"created_at":1500508800,"id":"107","payload":"141","updated_at":1500508800},{"type":"142","examples":"143"},{"type":"75","description":"144","examples":"145"},{"type":"75","description":"146","examples":"147"},{"type":"142","examples":"148"},"757a70753f51b","34f1b6104fb8d","DuplicateApiKey",{"message":"125","status":401},"Duplicate API key found","00edc350c413b","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","3f25163999a51","NoAPIKey",{"message":"149","status":401},"No API key found",{"type":"142"},{"type":"75"},"status","message","470b68e5f0549","{\\\"license\\\":{\\\"payload\\\":{\\\"admin_seats\\\":\\\"1\\\",\\\"customer\\\":\\\"Example Company, Inc\\\",\\\"dataplanes\\\":\\\"1\\\",\\\"license_creation_date\\\":\\\"2017-07-20\\\",\\\"license_expiration_date\\\":\\\"2017-07-21\\\",\\\"license_key\\\":\\\"00141000017ODj3AAG_a1V41000004wT0OEAU\\\",\\\"product_subscription\\\":\\\"Konnect Enterprise\\\",\\\"support_plan\\\":\\\"None\\\"},\\\"signature\\\":\\\"24cc21223633044c15c300be19cacc26ccc5aca0dd9a12df8a7324a1970fe304bc07b8dcd7fb08d7b92e04169313377ae3b550ead653b951bc44cd2eb59f6beb\\\",\\\"version\\\":\\\"1\\\"}}",[],"{\"license\":{\"payload\":{\"admin_seats\":\"1\",\"customer\":\"Example Company, Inc\",\"dataplanes\":\"1\",\"license_creation_date\":\"2017-07-20\",\"license_expiration_date\":\"2017-07-21\",\"license_key\":\"00141000017ODj3AAG_a1V41000004wT0OEAU\",\"product_subscription\":\"Konnect Enterprise\",\"support_plan\":\"None\"},\"signature\":\"24cc21223633044c15c300be19cacc26ccc5aca0dd9a12df8a7324a1970fe304bc07b8dcd7fb08d7b92e04169313377ae3b550ead653b951bc44cd2eb59f6beb\",\"version\":\"1\"}}","integer",[1500508800],"The UUID of the license",["107"],"The Kong Gateway license in JSON format.\n",["139"],[1500508800],"No API key found in request"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/put-licenses-license-id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update or add a license",["18"],"91ebc2c6e8753","put","/licenses/{license-id}",["19"],{},"put-licenses-license-id","When using `PUT`, if the request payload does not contain an entity's primary key (`id` for licenses), the license will be added and assigned the given ID.\n\nIf the request payload does contain an entity's primary key (id for Licenses), the license will be replaced with the given payload attribute. If the ID is not a valid UUID, a `400 BAD REQUEST` will be returned. If the ID is omitted, a `405 NOT ALLOWED` will be returned.","inheritedFromService",["20","21","22","23"],{"body":"24","headers":"25","query":"26","cookie":"27","path":"28"},["29"],["30"],"licenses",{"id":"31","name":"18"},{"id":"32","code":"33","headers":"34","contents":"35","description":"36"},{"id":"37","code":"38","headers":"39","contents":"40","description":"41"},{"id":"42","code":"43","headers":"44","contents":"45","description":"46"},{"id":"47","code":"48","headers":"49","contents":"50","description":"51"},{"id":"52","contents":"53","description":"54"},[],[],[],["55"],["56"],{"id":"57","url":"58","name":"59","description":"60","variables":"61"},"b2ca266667082","6a482b78397e8","200",[],["62"],"The license response object.","422829b29027f","400",[],[],"Bad Request","423829b2903cc","401",[],["63"],"Unauthorized","427829b290af0","405",[],[],"Method Not Allowed","1e945734a6ba9",["64"],"The request body for uploading a license.",{"id":"65","name":"66","style":"67","examples":"68","description":"69","required":true,"schema":"70","explicitProperties":"71"},{"id":"72","key":"73","extensions":"74","description":"75","type":"76","name":"77","in":"78"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"79","path":"80","port":"81","protocol":"82"},{"id":"83","mediaType":"84","examples":"85","encodings":"86","schema":"87"},{"id":"88","mediaType":"84","examples":"89","encodings":"90","schema":"91"},{"id":"92","mediaType":"84","examples":"93","encodings":"94","schema":"95"},"ef6a4aef1220d","license-id","simple",[],"The license's unique ID.",{"type":"96","examples":"97","$schema":"98","x-stoplight":"99"},["100","101","102","103","104","105"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111"},{"default":"112","description":"113","enum":"114"},"670fe095d1462","application/json",["115","116"],[],{"type":"117","x-examples":"118","properties":"119","$schema":"98","x-stoplight":"120"},"f2f79da497b83",["121","122","123"],[],{"type":"117","properties":"124","required":"125","title":"126","$schema":"98","x-stoplight":"127"},"3a78636854ed3",[],[],{"type":"117","properties":"128","$schema":"98","x-stoplight":"129"},"string",["130"],"http://json-schema.org/draft-07/schema#",{"id":"131"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["112","132"],{"id":"133","key":"134","value":"135"},{"id":"136","key":"137","value":"138"},"object",{"Example 1":"139"},{"created_at":"140","id":"141","payload":"142","updated_at":"143"},{"id":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"id":"153","key":"154","value":"155","summary":"156"},{"status":"157","message":"158"},["159","160"],"UnauthorizedError",{"id":"161"},{"payload":"162"},{"id":"163"},"30b4edb7-0847-4f65-af90-efbed8b0161f","eaac9beffe009","https","f7f04b8ee8d33","Active license",{"created_at":1500508800,"id":"130","payload":"164","updated_at":1500508800},"59dabb62f9f17","No license",{"data":"165","next":null},{"created_at":1500508800,"id":"130","payload":"166","updated_at":1500508800},{"type":"167","examples":"168"},{"type":"96","description":"169","examples":"170"},{"type":"96","description":"171","examples":"172"},{"type":"167","examples":"173"},"757a70753f51b","5c2643cc88c3a","DuplicateApiKey",{"message":"148","status":401},"Duplicate API key found","037b799e1f195","InvalidAuthCred",{"message":"46","status":401},"Invalid authentication credentials","d74f2c55e6edb","NoAPIKey",{"message":"174","status":401},"No API key found",{"type":"167"},{"type":"96"},"status","message","470b68e5f0549",{"type":"96","description":"171","examples":"175"},"4601ca9a2e41f","{\\\"license\\\":{\\\"payload\\\":{\\\"admin_seats\\\":\\\"1\\\",\\\"customer\\\":\\\"Example Company, Inc\\\",\\\"dataplanes\\\":\\\"1\\\",\\\"license_creation_date\\\":\\\"2017-07-20\\\",\\\"license_expiration_date\\\":\\\"2017-07-21\\\",\\\"license_key\\\":\\\"00141000017ODj3AAG_a1V41000004wT0OEAU\\\",\\\"product_subscription\\\":\\\"Konnect Enterprise\\\",\\\"support_plan\\\":\\\"None\\\"},\\\"signature\\\":\\\"24cc21223633044c15c300be19cacc26ccc5aca0dd9a12df8a7324a1970fe304bc07b8dcd7fb08d7b92e04169313377ae3b550ead653b951bc44cd2eb59f6beb\\\",\\\"version\\\":\\\"1\\\"}}",[],"{\"license\":{\"payload\":{\"admin_seats\":\"1\",\"customer\":\"Example Company, Inc\",\"dataplanes\":\"1\",\"license_creation_date\":\"2017-07-20\",\"license_expiration_date\":\"2017-07-21\",\"license_key\":\"00141000017ODj3AAG_a1V41000004wT0OEAU\",\"product_subscription\":\"Konnect Enterprise\",\"support_plan\":\"None\"},\"signature\":\"24cc21223633044c15c300be19cacc26ccc5aca0dd9a12df8a7324a1970fe304bc07b8dcd7fb08d7b92e04169313377ae3b550ead653b951bc44cd2eb59f6beb\",\"version\":\"1\"}}","integer",[1500508800],"The UUID of the license",["130"],"The Kong Gateway license in JSON format.\n",["164"],[1500508800],"No API key found in request",["176"],"{\\\"license\\\":{\\\"payload\\\":{\\\"admin_seats\\\":\\\"1\\\",\\\"customer\\\":\\\"Example Company, Inc\\\",\\\"dataplanes\\\":\\\"1\\\",\\\"license_creation_date\\\":\\\"2017-07-20\\\",\\\"license_expiration_date\\\":\\\"2017-07-20\\\",\\\"license_key\\\":\\\"00141000017ODj3AAG_a1V41000004wT0OEAU\\\",\\\"product_subscription\\\":\\\"Konnect Enterprise\\\",\\\"support_plan\\\":\\\"None\\\"},\\\"signature\\\":\\\"6985968131533a967fcc721244a979948b1066967f1e9cd65dbd8eeabe060fc32d894a2945f5e4a03c1cd2198c74e058ac63d28b045c2f1fcec95877bd790e1b\\\",\\\"version\\\":\\\"1\\\"}}"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/patch-licenses-license-id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a license",["18"],"3e8e660be21cb","patch","/licenses/{license-id}",["19"],{},"patch-licenses-license-id","When using `PATCH`, if the request payload does contain an entity's primary key (`id` for licenses), the license will be replaced with the given payload attribute.\n\nIf the request payload does not contain an entity's primary key (`id` for licenses), a `404 NOT FOUND `will be returned or if the request payload contains a invalid licence, a `400 BAD REQUEST` will be returned.","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"licenses",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],["43"],["44"],{"id":"45","url":"46","name":"47","description":"48","variables":"49"},"b2ca266667082","3e872f439eddc","200",[],["50"],"The license response object.","a9172eb22eaad","401",[],["51"],"Unauthorized","2af59d69f4396",["52"],"The request body for uploading a license.",{"id":"53","name":"54","style":"55","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","key":"61","extensions":"62","description":"63","type":"64","name":"65","in":"66"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"67","path":"68","port":"69","protocol":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},{"id":"76","mediaType":"72","examples":"77","encodings":"78","schema":"79"},{"id":"80","mediaType":"72","examples":"81","encodings":"82","schema":"83"},"60f85f7f17b78","license-id","simple",[],"The license's unique ID.",{"type":"84","examples":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92","93"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"94","description":"95"},{"default":"96","description":"97"},{"default":"98","description":"99"},{"default":"100","description":"101","enum":"102"},"38f4a295352b5","application/json",["103","104"],[],{"type":"105","x-examples":"106","properties":"107","$schema":"86","x-stoplight":"108"},"8b11dd670c0c8",["109","110","111"],[],{"type":"105","properties":"112","required":"113","title":"114","$schema":"86","x-stoplight":"115"},"d0968dba1b405",[],[],{"type":"105","properties":"116","$schema":"86","x-stoplight":"117"},"string",["118"],"http://json-schema.org/draft-07/schema#",{"id":"119"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["100","120"],{"id":"121","key":"122","value":"123"},{"id":"124","key":"125","value":"126"},"object",{"Example 1":"127"},{"created_at":"128","id":"129","payload":"130","updated_at":"131"},{"id":"132"},{"id":"133","key":"134","value":"135","summary":"136"},{"id":"137","key":"138","value":"139","summary":"140"},{"id":"141","key":"142","value":"143","summary":"144"},{"status":"145","message":"146"},["147","148"],"UnauthorizedError",{"id":"149"},{"payload":"150"},{"id":"151"},"30b4edb7-0847-4f65-af90-efbed8b0161f","b01a59b06e9aa","https","cdcf5473f1afe","Active license",{"created_at":1500508800,"id":"118","payload":"152","updated_at":1500508800},"835adfcb8dfd2","No license",{"data":"153","next":null},{"created_at":1500508800,"id":"118","payload":"154","updated_at":1500508800},{"type":"155","examples":"156"},{"type":"84","description":"157","examples":"158"},{"type":"84","description":"159","examples":"160"},{"type":"155","examples":"161"},"757a70753f51b","0797b35e13188","DuplicateApiKey",{"message":"136","status":401},"Duplicate API key found","1d66443a31f91","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","ec1f2247f6a00","NoAPIKey",{"message":"162","status":401},"No API key found",{"type":"155"},{"type":"84"},"status","message","470b68e5f0549",{"type":"84","description":"159","examples":"163"},"4601ca9a2e41f","{\\\"license\\\":{\\\"payload\\\":{\\\"admin_seats\\\":\\\"1\\\",\\\"customer\\\":\\\"Example Company, Inc\\\",\\\"dataplanes\\\":\\\"1\\\",\\\"license_creation_date\\\":\\\"2017-07-20\\\",\\\"license_expiration_date\\\":\\\"2017-07-21\\\",\\\"license_key\\\":\\\"00141000017ODj3AAG_a1V41000004wT0OEAU\\\",\\\"product_subscription\\\":\\\"Konnect Enterprise\\\",\\\"support_plan\\\":\\\"None\\\"},\\\"signature\\\":\\\"24cc21223633044c15c300be19cacc26ccc5aca0dd9a12df8a7324a1970fe304bc07b8dcd7fb08d7b92e04169313377ae3b550ead653b951bc44cd2eb59f6beb\\\",\\\"version\\\":\\\"1\\\"}}",[],"{\"license\":{\"payload\":{\"admin_seats\":\"1\",\"customer\":\"Example Company, Inc\",\"dataplanes\":\"1\",\"license_creation_date\":\"2017-07-20\",\"license_expiration_date\":\"2017-07-21\",\"license_key\":\"00141000017ODj3AAG_a1V41000004wT0OEAU\",\"product_subscription\":\"Konnect Enterprise\",\"support_plan\":\"None\"},\"signature\":\"24cc21223633044c15c300be19cacc26ccc5aca0dd9a12df8a7324a1970fe304bc07b8dcd7fb08d7b92e04169313377ae3b550ead653b951bc44cd2eb59f6beb\",\"version\":\"1\"}}","integer",[1500508800],"The UUID of the license",["118"],"The Kong Gateway license in JSON format.\n",["152"],[1500508800],"No API key found in request",["164"],"{\\\"license\\\":{\\\"payload\\\":{\\\"admin_seats\\\":\\\"1\\\",\\\"customer\\\":\\\"Example Company, Inc\\\",\\\"dataplanes\\\":\\\"1\\\",\\\"license_creation_date\\\":\\\"2017-07-20\\\",\\\"license_expiration_date\\\":\\\"2017-07-20\\\",\\\"license_key\\\":\\\"00141000017ODj3AAG_a1V41000004wT0OEAU\\\",\\\"product_subscription\\\":\\\"Konnect Enterprise\\\",\\\"support_plan\\\":\\\"None\\\"},\\\"signature\\\":\\\"6985968131533a967fcc721244a979948b1066967f1e9cd65dbd8eeabe060fc32d894a2945f5e4a03c1cd2198c74e058ac63d28b045c2f1fcec95877bd790e1b\\\",\\\"version\\\":\\\"1\\\"}}"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-licenses-license-id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a license",["18"],"7de13b7dbe0a0","delete","/licenses/{license-id}",["19"],{},"delete-licenses-license-id","Delete a license by passing the license ID as a path parameter.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"licenses",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"b2ca266667082","24bdb0d92a408","204",[],[],"No Content","57adb0309472c","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},{"id":"65","mediaType":"66","examples":"67","encodings":"68","schema":"69"},"d2e8e68eb1bb8","license-id","simple",[],"The license's unique ID.",{"type":"70","examples":"71","$schema":"72","x-stoplight":"73"},["74","75","76","77","78","79"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"80","description":"81"},{"default":"82","description":"83"},{"default":"84","description":"85"},{"default":"86","description":"87","enum":"88"},"2f476b0225d8e","application/json",["89","90","91"],[],{"type":"92","properties":"93","required":"94","title":"95","$schema":"72","x-stoplight":"96"},"string",["97"],"http://json-schema.org/draft-07/schema#",{"id":"98"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["86","99"],{"id":"100","key":"101","value":"102","summary":"103"},{"id":"104","key":"105","value":"106","summary":"107"},{"id":"108","key":"109","value":"110","summary":"111"},"object",{"status":"112","message":"113"},["114","115"],"UnauthorizedError",{"id":"116"},"30b4edb7-0847-4f65-af90-efbed8b0161f","9010403114c18","https","c0308eefe991b","DuplicateApiKey",{"message":"103","status":401},"Duplicate API key found","ef0d7091fe295","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","db717a041835e","NoAPIKey",{"message":"117","status":401},"No API key found",{"type":"118"},{"type":"70"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-license-report",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Generate a report",["18"],"0caf463dc7a5d","get","/license/report",["19"],{},"get-license-report","Generate a report on the Kong Gateway instance to gather monthly usage data.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"licenses",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"b2ca266667082","27cabb990d4ab","200",[],["45"],"Fields available in the report","ffbab9d36474e","401",[],["46"],"Unauthorized",{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},{"id":"63","mediaType":"59","examples":"64","encodings":"65","schema":"66"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"d4edee21d5445","application/json",[],[],{"type":"76","x-examples":"77","properties":"78","$schema":"79","x-stoplight":"80"},"8c370dfede742",["81","82","83"],[],{"type":"76","properties":"84","required":"85","title":"86","$schema":"79","x-stoplight":"87"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","88"],"object",{"Example 1":"89"},{"checksum":"90","counters":"91","db_version":"92","deployment_info":"93","kong_version":"94","license":"95","rbac_users":"96","consumers_count":"97","plugins_count":"98","routes_count":"99","services_count":"100","system_info":"101","timestamp":"102","workspaces_count":"103"},"http://json-schema.org/draft-07/schema#",{"id":"104"},{"id":"105","key":"106","value":"107","summary":"108"},{"id":"109","key":"110","value":"111","summary":"112"},{"id":"113","key":"114","value":"115","summary":"116"},{"status":"117","message":"118"},["119","120"],"UnauthorizedError",{"id":"121"},"https",{"checksum":"122","consumers_count":0,"counters":"123","db_version":"124","deployment_info":"125","kong_version":"126","license":"127","plugins_count":"128","rbac_users":0,"routes_count":0,"services_count":0,"system_info":"129","timestamp":"130","workspaces_count":1},{"type":"131","description":"132","examples":"133"},{"type":"76","description":"134","properties":"135"},{"type":"131","description":"136","examples":"137"},{"type":"76","description":"138","properties":"139"},{"type":"131","description":"140","examples":"141"},{"type":"76","description":"142","properties":"143"},{"type":"144","description":"145","examples":"146"},{"type":"144","description":"147","examples":"148"},{"type":"76","description":"149","properties":"150"},{"type":"144","description":"151","examples":"152"},{"type":"144","description":"153","examples":"154"},{"type":"76","description":"155","properties":"156"},{"type":"131","description":"157","examples":"158"},{"type":"144","description":"159","examples":"160"},"9c595669abcf9","3115cbcd25771","DuplicateApiKey",{"message":"108","status":401},"Duplicate API key found","53b3e8013668c","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","e13efee37d223","NoAPIKey",{"message":"161","status":401},"No API key found",{"type":"144"},{"type":"131"},"status","message","470b68e5f0549","38b06b3c3c69299740e1f2d48a1a197d17864b99",{"total_requests":10,"buckets":"162"},"postgres 13.18",{"type":"163"},"3.9.0.0",{"license_expiration_date":"164","license_key":"165"},{"tiers":"166","unique_route_kafkas":0,"unique_route_lambdas":0},{"cores":4,"hostname":"167","uname":"168"},"a1737692223","string","The checksum of the current report.",["122"],"Counts the number of requests made in a given month.\n",{"total_requests":"169","buckets":"170"},"The type and version of the data store Kong Gateway is using.\n",["124"],"Displays information about the deployment running Kong Gateway.",{"type":"171","connected_dp_count":"172"},"The version of the Kong Gateway instance.\n",["126"],"Information about the license.",{"license_expiration_date":"173","license_key":"174"},"integer","The number of users registered with through RBAC.\n",[0],"The number of configured consumers in the Kong Gateway instance.",[0],"Counts the number of plugins in use.",{"unique_route_lambdas":"175","unique_route_kafkas":"176","tiers":"177"},"The number of configured routes in the Kong Gateway instance.",[0],"The number of configured services in the Kong Gateway instance.\n",[0],"Displays information about the system running Kong Gateway.\n",{"cores":"178","hostname":"179","uname":"180"},"The timestamp of the current response.",[1737692223],"The number of workspaces configured in the Kong Gateway instance.\n",[1],"No API key found in request",["181"],"hybrid","2025-02-20","ASDASDASDASDASDASDASDASDASD_ASDASDA",{"custom":0,"enterprise":"182","free":"183"},"13b867agsa008","Linux x86_64",{"type":"184","description":"185","examples":"186"},{"type":"187","description":"188","items":"189"},{"type":"131","description":"190","examples":"191"},{"type":"184","description":"192"},{"type":"131","description":"193","examples":"194"},{"type":"131","description":"195","examples":"196"},{"type":"184","description":"197","examples":"198"},{"type":"184","description":"199","examples":"200"},{"type":"76","description":"201","properties":"202"},{"type":"144","description":"203","examples":"204"},{"type":"131","description":"205","examples":"206"},{"type":"131","description":"207","examples":"208"},{"bucket":"209","request_count":10},{"rate-limiting-advanced":1},{"basic-auth":1},"number","The total number of requests made in all buckets.",[10],"array","A list of year-month buckets and the number of requests made in each one.",{"properties":"210"},"Type of the deployment mode.",["211"],"Number of data planes across the cluster. If the deployment is not hybrid mode, the field is not displayed.","The date current license expires. If no license is present, the field displays as 2017-7-20.",["164"],"An encrypted identifier for the current license key. If no license is present, the field displays as UNLICENSED.\n",["165"],"Number of AWS Lambda plugins in use. Only counts in case of the plugin is defined on a service-less route level and have a unique function name.\n",[0],"Number of unique broker IPs listed in broker array across Kafka Upstream plugins defined on a service-less route level.",[0],"The number of configured plugins in each subscription tier.",{"custom":"212","enterprise":"213","free":"214"},"Number of CPU cores on the node",[11],"Encrypted system hostname",["167"],"Operating system",["168"],"2025-01",{"bucket":"215","request_count":"216"},"traditional",{"type":"76","description":"217"},{"type":"76","description":"218","examples":"219"},{"type":"76","description":"220","examples":"221"},{"type":"131","description":"222","examples":"223"},{"type":"144","description":"224","examples":"225"},"A list of all configured custom plugins and the number of instances of each.","A list of all configured Enterprise plugins and the number of instances of each.",["226"],"A list of all configured free plugins and the number of instances of each.",["227"],"Year and month when the requests were processed. If the value in bucket is UNKNOWN, then the requests were processed before Kong Gateway 2.7.0.1.",["209"],"Number of requests processed in the given month and year.",[10],{"rate-limiting-advanced":1},{"basic-auth":1}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/paths/fips-status/get",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","description":"11","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"FIPS Mode Status",["17"],"f689ecc7ead4f","get","/fips-status",["18"],{},"Retrieves the current FIPS mode status. This endpoint indicates whether FIPS mode is active and provides the version of the FIPS module. ","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"licenses",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],[],["38"],{"id":"39","url":"40","name":"41","description":"42","variables":"43"},"b2ca266667082","74ff2456e3331","200",[],["44"],"FIPS mode status retrieved successfully.","afaf23ae5a293","401",[],["45"],"Unauthorized",{"id":"46","key":"47","extensions":"48","description":"49","type":"50","name":"51","in":"52"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"53","path":"54","port":"55","protocol":"56"},{"id":"57","mediaType":"58","examples":"59","encodings":"60","schema":"61"},{"id":"62","mediaType":"58","examples":"63","encodings":"64","schema":"65"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"66","description":"67"},{"default":"68","description":"69"},{"default":"70","description":"71"},{"default":"72","description":"73","enum":"74"},"7eb3081a03db6","application/json",["75","76"],[],{"type":"77","properties":"78","$schema":"79","x-stoplight":"80"},"571f390e50d06",["81","82","83"],[],{"type":"77","properties":"84","required":"85","title":"86","$schema":"79","x-stoplight":"87"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["72","88"],{"id":"89","key":"90","value":"91","summary":"92"},{"id":"93","key":"94","value":"95","summary":"96"},"object",{"active":"97","version":"98"},"http://json-schema.org/draft-07/schema#",{"id":"99"},{"id":"100","key":"101","value":"102","summary":"103"},{"id":"104","key":"105","value":"106","summary":"107"},{"id":"108","key":"109","value":"110","summary":"111"},{"status":"112","message":"113"},["114","115"],"UnauthorizedError",{"id":"116"},"https","789291bcc4498","fips_enabled",{"active":true,"version":"117"},"FIPS mode is enabled. This may occur after a license configuration change that enables FIPS mode.","2f24116acd867","fips_disabled",{"active":false,"version":"118"},"FIPS mode is disabled or not supported. This may be the default state or result from a license configuration that does not enable FIPS mode.",{"type":"119","description":"120"},{"type":"121","description":"122"},"1f9a528a36b3f","313d35278f98a","DuplicateApiKey",{"message":"103","status":401},"Duplicate API key found","907843ec341f0","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","b363b34ea4509","NoAPIKey",{"message":"123","status":401},"No API key found",{"type":"124"},{"type":"121"},"status","message","470b68e5f0549","2.0.16","unknown","boolean","Indicates if FIPS mode is currently active (true) or inactive (false).","string","The version of the FIPS module, or 'unknown' if the version cannot be determined.","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-consumer_groups",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List consumer groups",["18"],"927f8c581ece8","get","/consumer_groups",["19"],{},"get-consumer_groups","List all consumer groups\n\nUse consumer groups to manage consumer affiliation.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"2b5601ccc1bbe","c33d687e4d0e3","200",[],["45"],"The consumer group response body","fdcd67d5c42ef","401",[],["46"],"Unauthorized",{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},{"id":"63","mediaType":"59","examples":"64","encodings":"65","schema":"66"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"ed98a20ff3a57","application/json",[],[],{"type":"76","properties":"77","x-examples":"78","$schema":"79","x-stoplight":"80"},"bf85e75c22022",["81","82","83"],[],{"type":"76","properties":"84","required":"85","title":"86","$schema":"79","x-stoplight":"87"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","88"],"object",{"data":"89","next":"90"},{"Example 1":"91","Consumer group example":"92"},"http://json-schema.org/draft-07/schema#",{"id":"93"},{"id":"94","key":"95","value":"96","summary":"97"},{"id":"98","key":"99","value":"100","summary":"101"},{"id":"102","key":"103","value":"104","summary":"105"},{"status":"106","message":"107"},["108","109"],"UnauthorizedError",{"id":"110"},"https",{"type":"111","description":"112","items":"113"},{"type":"114","description":"115","examples":"116"},{"data":"117","next":null},{"data":"118","next":null},"0953fe2bd7e24","3270cec5d333a","DuplicateApiKey",{"message":"97","status":401},"Duplicate API key found","63099d2d8f082","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","ebd49d717fa0c","NoAPIKey",{"message":"119","status":401},"No API key found",{"type":"120"},{"type":"114"},"status","message","470b68e5f0549","array","The data array contains consumer group objects",{"type":"76","properties":"121"},"string","Link to the next page of results, if applicable",[null],["122","123","124"],["125"],"No API key found in request","integer",{"created_at":"126","id":"127","name":"128","tags":"129","updated_at":"130"},{"created_at":1719859003,"id":"131","name":"132","tags":"133","updated_at":1719859003},{"created_at":1719858982,"id":"134","name":"135","tags":"136","updated_at":1719858982},{"created_at":1719859346,"id":"137","name":"138","tags":null,"updated_at":1719859346},{"created_at":1719859003,"id":"131","name":"132","tags":"139","updated_at":1719859003},{"type":"120","description":"140","examples":"141"},{"type":"114","description":"142","examples":"143"},{"type":"114","description":"144","examples":"145"},{"type":"111","description":"146","items":"147"},{"type":"120","description":"148","examples":"149"},"0d8f5353-8dd2-4013-859a-21510b970a64","group2",[],"7012a570-e372-4280-92db-7fbbe4af80bb","group1",[],"9faf2f1b-2110-4690-8b64-c70dc14aa51a","group3",[],"Unix epoch when the resource was created.",[1719859003],"The UUID of the consumer group",["131"],"The name of the consumer group",["132"],"An optional set of strings associated with the consumer group for grouping and filtering.",{"type":"114","examples":"150"},"Unix epoch when the resource was last updated.",[1719859003],["151"],"example_tag"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-consumer_groups",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create a consumer group",["18"],"3d18b62447c88","post","/consumer_groups",["19"],{},"post-consumer_groups","Create a new consumer group.","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"consumer_groups",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],[],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"2b5601ccc1bbe","a60995f6ee9ac","201",[],["49"],"The consumer group response body","45e9941a1e9a8","401",[],["50"],"Unauthorized","ab2dd86caea37",["51"],"The consumer groups request body for creating new consumer groups.",{"id":"52","key":"53","extensions":"54","description":"55","type":"56","name":"57","in":"58"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"59","path":"60","port":"61","protocol":"62"},{"id":"63","mediaType":"64","examples":"65","encodings":"66","schema":"67"},{"id":"68","mediaType":"64","examples":"69","encodings":"70","schema":"71"},{"id":"72","mediaType":"64","examples":"73","encodings":"74","schema":"75"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"76","description":"77"},{"default":"78","description":"79"},{"default":"80","description":"81"},{"default":"82","description":"83","enum":"84"},"733d6e596fe4c","application/json",[],[],{"type":"85","properties":"86","x-examples":"87","$schema":"88","x-stoplight":"89"},"076b1236e286e",["90","91","92"],[],{"type":"85","properties":"93","required":"94","title":"95","$schema":"88","x-stoplight":"96"},"07edb6e0cda61",["97"],[],{"type":"85","x-examples":"98","properties":"99","required":"100","$schema":"88","x-stoplight":"101"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["82","102"],"object",{"data":"103","next":"104"},{"Example 1":"105","Consumer group example":"106"},"http://json-schema.org/draft-07/schema#",{"id":"107"},{"id":"108","key":"109","value":"110","summary":"111"},{"id":"112","key":"113","value":"114","summary":"115"},{"id":"116","key":"117","value":"118","summary":"119"},{"status":"120","message":"121"},["122","123"],"UnauthorizedError",{"id":"124"},{"id":"125","key":"126","value":"127"},{"Example 1":"128"},{"name":"129","tags":"130"},["131"],{"id":"132"},"https",{"type":"133","description":"134","items":"135"},{"type":"136","description":"137","examples":"138"},{"data":"139","next":null},{"data":"140","next":null},"0953fe2bd7e24","b6fe8f77cb109","DuplicateApiKey",{"message":"111","status":401},"Duplicate API key found","6ba89a0892f42","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","0bb87e32b3a7d","NoAPIKey",{"message":"141","status":401},"No API key found",{"type":"142"},{"type":"136"},"status","message","470b68e5f0549","cc087a87867df","example consumer group request body",{"name":"143","tags":"144"},{"created_at":1557522650,"id":"145","name":"146","tags":"147"},{"type":"136","description":"148","examples":"149"},{"type":"133","description":"150","items":"151"},"name","1598c3a7bbe87","array","The data array contains consumer group objects",{"type":"85","properties":"152"},"string","Link to the next page of results, if applicable",[null],["153","154","155"],["156"],"No API key found in request","integer","my_group",["136"],"fa6881b2-f49f-4007-9475-577cd21d34f4","JL",["157","158"],"A unique name for the consumer group you want to create.",["143"],"An optional set of strings associated with the consumer group for grouping and filtering.",{"type":"136"},{"created_at":"159","id":"160","name":"161","tags":"162","updated_at":"163"},{"created_at":1719859003,"id":"164","name":"165","tags":"166","updated_at":1719859003},{"created_at":1719858982,"id":"167","name":"168","tags":"169","updated_at":1719858982},{"created_at":1719859346,"id":"170","name":"171","tags":null,"updated_at":1719859346},{"created_at":1719859003,"id":"164","name":"165","tags":"172","updated_at":1719859003},"tag1","tag2",{"type":"142","description":"173","examples":"174"},{"type":"136","description":"175","examples":"176"},{"type":"136","description":"177","examples":"178"},{"type":"133","description":"150","items":"179"},{"type":"142","description":"180","examples":"181"},"0d8f5353-8dd2-4013-859a-21510b970a64","group2",[],"7012a570-e372-4280-92db-7fbbe4af80bb","group1",[],"9faf2f1b-2110-4690-8b64-c70dc14aa51a","group3",[],"Unix epoch when the resource was created.",[1719859003],"The UUID of the consumer group",["164"],"The name of the consumer group",["165"],{"type":"136","examples":"182"},"Unix epoch when the resource was last updated.",[1719859003],["183"],"example_tag"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-consumer_groups-group_name",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List a specific consumer group",["18"],"aaf18e22e7265","get","/consumer_groups/{group_name_or_id}",["19"],{},"get-consumer_groups-group_name","Returns a consumer group by passing either the `group_name` or `group_id` as a path parameter.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39"],[],["40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"2b5601ccc1bbe","44d5a054de50d","200",[],["47"],"The consumer group response body","a505a231aeda6","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"58","examples":"59","description":"60","required":true,"schema":"61","explicitProperties":"62"},{"id":"63","key":"64","extensions":"65","description":"66","type":"67","name":"68","in":"69"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"70","path":"71","port":"72","protocol":"73"},{"id":"74","mediaType":"75","examples":"76","encodings":"77","schema":"78"},{"id":"79","mediaType":"75","examples":"80","encodings":"81","schema":"82"},"3a43b55110e80","list_consumers","form",[],"Indicates whether the list of consumers should be included in the consumer group details.",{"default":true,"type":"83","$schema":"84","x-stoplight":"85"},["86","87","88","89","90"],"17aa99eb0b9f0","group_name_or_id","simple",[],"The name or UUID of the consumer group.",{"anyOf":"91","type":"92","examples":"93","$schema":"84","x-stoplight":"94"},["88","87","95","89","86","90"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"96","description":"97"},{"default":"98","description":"99"},{"default":"100","description":"101"},{"default":"102","description":"103","enum":"104"},"f83cb6224f479","application/json",[],[],{"type":"105","properties":"106","x-examples":"107","$schema":"84","x-stoplight":"108"},"41a2480876230",["109","110","111"],[],{"type":"105","properties":"112","required":"113","title":"114","$schema":"84","x-stoplight":"115"},"boolean","http://json-schema.org/draft-07/schema#",{"id":"116"},"description","in","name","schema","title",["117","118"],"string",["119"],{"id":"120"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["102","121"],"object",{"data":"122","next":"123"},{"Example 1":"124","Consumer group example":"125"},{"id":"126"},{"id":"127","key":"128","value":"129","summary":"130"},{"id":"131","key":"132","value":"133","summary":"134"},{"id":"135","key":"136","value":"137","summary":"138"},{"status":"139","message":"140"},["141","142"],"UnauthorizedError",{"id":"143"},"852873292796b",{"type":"92","examples":"144"},{"type":"92","examples":"145"},"my_group","66e66a7888a04","https",{"type":"146","description":"147","items":"148"},{"type":"92","description":"149","examples":"150"},{"data":"151","next":null},{"data":"152","next":null},"0953fe2bd7e24","c870319d9fcd3","DuplicateApiKey",{"message":"130","status":401},"Duplicate API key found","7c258add222dc","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","c3c50eafe6594","NoAPIKey",{"message":"153","status":401},"No API key found",{"type":"154"},{"type":"92"},"status","message","470b68e5f0549",["119"],["155"],"array","The data array contains consumer group objects",{"type":"105","properties":"156"},"Link to the next page of results, if applicable",[null],["157","158","159"],["160"],"No API key found in request","integer","84a73fb8-50fc-44a7-a4d5-aa17728ee83f",{"created_at":"161","id":"162","name":"163","tags":"164","updated_at":"165"},{"created_at":1719859003,"id":"166","name":"167","tags":"168","updated_at":1719859003},{"created_at":1719858982,"id":"169","name":"170","tags":"171","updated_at":1719858982},{"created_at":1719859346,"id":"172","name":"173","tags":null,"updated_at":1719859346},{"created_at":1719859003,"id":"166","name":"167","tags":"174","updated_at":1719859003},{"type":"154","description":"175","examples":"176"},{"type":"92","description":"177","examples":"178"},{"type":"92","description":"179","examples":"180"},{"type":"146","description":"181","items":"182"},{"type":"154","description":"183","examples":"184"},"0d8f5353-8dd2-4013-859a-21510b970a64","group2",[],"7012a570-e372-4280-92db-7fbbe4af80bb","group1",[],"9faf2f1b-2110-4690-8b64-c70dc14aa51a","group3",[],"Unix epoch when the resource was created.",[1719859003],"The UUID of the consumer group",["166"],"The name of the consumer group",["167"],"An optional set of strings associated with the consumer group for grouping and filtering.",{"type":"92","examples":"185"},"Unix epoch when the resource was last updated.",[1719859003],["186"],"example_tag"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/put-consumer_groups-group_name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create consumer group",["18"],"d31e6ab68549b","put","/consumer_groups/{group_name_or_id}",["19"],{},"put-consumer_groups-group_name_or_id","Create a consumer group by passing a new group name as the path parameter","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"consumer_groups",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],["43"],[],["44"],["45"],{"id":"46","url":"47","name":"48","description":"49","variables":"50"},"2b5601ccc1bbe","791be36a49e91","200",[],["51"],"The consumer group response body","a12be52ff202f","401",[],["52"],"Unauthorized","b7ade1b4eb441",["53"],"The consumer groups request body for creating new consumer groups.",{"id":"54","name":"55","style":"56","examples":"57","description":"58","schema":"59","explicitProperties":"60"},{"id":"61","name":"62","style":"63","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},{"id":"88","mediaType":"80","examples":"89","encodings":"90","schema":"91"},"b8426bfbb52b6","list_consumers","form",[],"Indicates whether the list of consumers should be included in the consumer group details.",{"default":true,"type":"92","$schema":"93","x-stoplight":"94"},["95","96","97","98","99"],"8031949b279d4","group_name_or_id","simple",[],"The name or UUID of the consumer group.",{"anyOf":"100","type":"101","examples":"102","$schema":"93","x-stoplight":"103"},["97","96","104","98","95","99"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110"},{"default":"111","description":"112","enum":"113"},"d42d28264dd4c","application/json",[],[],{"type":"114","properties":"115","x-examples":"116","$schema":"93","x-stoplight":"117"},"95f1308df0761",["118","119","120"],[],{"type":"114","properties":"121","required":"122","title":"123","$schema":"93","x-stoplight":"124"},"ae4b617ff6b4c",["125"],[],{"type":"114","x-examples":"126","properties":"127","required":"128","$schema":"93","x-stoplight":"129"},"boolean","http://json-schema.org/draft-07/schema#",{"id":"130"},"description","in","name","schema","title",["131","132"],"string",["133"],{"id":"134"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["111","135"],"object",{"data":"136","next":"137"},{"Example 1":"138","Consumer group example":"139"},{"id":"140"},{"id":"141","key":"142","value":"143","summary":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"status":"153","message":"154"},["155","156"],"UnauthorizedError",{"id":"157"},{"id":"158","key":"159","value":"160"},{"Example 1":"161"},{"name":"162","tags":"163"},["97"],{"id":"164"},"851e35725e5c8",{"type":"101","examples":"165"},{"type":"101","examples":"166"},"my_group","ff8679132fea8","https",{"type":"167","description":"168","items":"169"},{"type":"101","description":"170","examples":"171"},{"data":"172","next":null},{"data":"173","next":null},"0953fe2bd7e24","451c057395fc6","DuplicateApiKey",{"message":"144","status":401},"Duplicate API key found","3b4a4d814e8c9","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","1d8d98ad1df77","NoAPIKey",{"message":"174","status":401},"No API key found",{"type":"175"},{"type":"101"},"status","message","470b68e5f0549","263e6043054fd","example consumer group request body",{"name":"133","tags":"176"},{"created_at":1557522650,"id":"177","name":"178","tags":"179"},{"type":"101","description":"180","examples":"181"},{"type":"167","description":"182","items":"183"},"1598c3a7bbe87",["133"],["184"],"array","The data array contains consumer group objects",{"type":"114","properties":"185"},"Link to the next page of results, if applicable",[null],["186","187","188"],["189"],"No API key found in request","integer",["101"],"fa6881b2-f49f-4007-9475-577cd21d34f4","JL",["190","191"],"A unique name for the consumer group you want to create.",["133"],"An optional set of strings associated with the consumer group for grouping and filtering.",{"type":"101"},"84a73fb8-50fc-44a7-a4d5-aa17728ee83f",{"created_at":"192","id":"193","name":"194","tags":"195","updated_at":"196"},{"created_at":1719859003,"id":"197","name":"198","tags":"199","updated_at":1719859003},{"created_at":1719858982,"id":"200","name":"201","tags":"202","updated_at":1719858982},{"created_at":1719859346,"id":"203","name":"204","tags":null,"updated_at":1719859346},{"created_at":1719859003,"id":"197","name":"198","tags":"205","updated_at":1719859003},"tag1","tag2",{"type":"175","description":"206","examples":"207"},{"type":"101","description":"208","examples":"209"},{"type":"101","description":"210","examples":"211"},{"type":"167","description":"182","items":"212"},{"type":"175","description":"213","examples":"214"},"0d8f5353-8dd2-4013-859a-21510b970a64","group2",[],"7012a570-e372-4280-92db-7fbbe4af80bb","group1",[],"9faf2f1b-2110-4690-8b64-c70dc14aa51a","group3",[],"Unix epoch when the resource was created.",[1719859003],"The UUID of the consumer group",["197"],"The name of the consumer group",["198"],{"type":"101","examples":"215"},"Unix epoch when the resource was last updated.",[1719859003],["216"],"example_tag"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-consumer_groups-group_name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a consumer group",["18"],"008ba1a73d8b7","delete","/consumer_groups/{group_name_or_id}",["19"],{},"delete-consumer_groups-group_name_or_id","Delete a consumer group. Deleting a consumer group removes all consumers from that group. This operation does not delete existing consuemrs.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39"],[],["40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"2b5601ccc1bbe","ff5a068c06ed3","204",[],[],"HTTP/1.1 204 No Content\n","a76a04af44bd4","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","key":"63","extensions":"64","description":"65","type":"66","name":"67","in":"68"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"69","path":"70","port":"71","protocol":"72"},{"id":"73","mediaType":"74","examples":"75","encodings":"76","schema":"77"},"eeca68ed2f8d5","list_consumers","form",[],"Indicates whether the list of consumers should be included in the consumer group details.",{"default":true,"type":"78","$schema":"79","x-stoplight":"80"},["81","82","83","84","85"],"de76b9cf94e4e","group_name_or_id","simple",[],"The name or UUID of the consumer group.",{"anyOf":"86","type":"87","examples":"88","$schema":"79","x-stoplight":"89"},["83","82","90","84","81","85"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"571c6cfb3e935","application/json",["100","101","102"],[],{"type":"103","properties":"104","required":"105","title":"106","$schema":"79","x-stoplight":"107"},"boolean","http://json-schema.org/draft-07/schema#",{"id":"108"},"description","in","name","schema","title",["109","110"],"string",["111"],{"id":"112"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","113"],{"id":"114","key":"115","value":"116","summary":"117"},{"id":"118","key":"119","value":"120","summary":"121"},{"id":"122","key":"123","value":"124","summary":"125"},"object",{"status":"126","message":"127"},["128","129"],"UnauthorizedError",{"id":"130"},"a4cbd3b7e3ece",{"type":"87","examples":"131"},{"type":"87","examples":"132"},"my_group","280e39f19481c","https","fb081771fbb5f","DuplicateApiKey",{"message":"117","status":401},"Duplicate API key found","582feca05c41c","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","eee0abc4cc597","NoAPIKey",{"message":"133","status":401},"No API key found",{"type":"134"},{"type":"87"},"status","message","470b68e5f0549",["111"],["135"],"No API key found in request","integer","84a73fb8-50fc-44a7-a4d5-aa17728ee83f"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-consumers-consumer_name_or_id-consumer_groups",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List consumer groups for a consumer",["18"],"533b4b3cfa423","get","/consumers/{consumer_username_or_id}/consumer_groups",["19"],{},"get-consumers-consumer_name_or_id-consumer_groups","View all consumer groups that a consumer is assigned to.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40"],[],["41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"2b5601ccc1bbe","47574c0768265","200",[],["48"],"The consumer group response body","a7874de438f5e","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"65","examples":"66","description":"67","required":true,"schema":"68","explicitProperties":"69"},{"id":"70","key":"71","extensions":"72","description":"73","type":"74","name":"75","in":"76"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"77","path":"78","port":"79","protocol":"80"},{"id":"81","mediaType":"82","examples":"83","encodings":"84","schema":"85"},{"id":"86","mediaType":"82","examples":"87","encodings":"88","schema":"89"},"408f41d01ed6d","offset","form",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"90","$schema":"91","x-stoplight":"92"},["93","94","95","96","97"],"9d88fe5ed43ce","size",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"98","$schema":"91","x-stoplight":"99"},["93","94","95","96","97"],"ed19586daaae9","consumer_username_or_id","simple",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"90","examples":"100","$schema":"91","x-stoplight":"101"},["95","94","102","96","93","97"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"103","description":"104"},{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110","enum":"111"},"8d851cde5c4f1","application/json",[],[],{"type":"112","properties":"113","x-examples":"114","$schema":"91","x-stoplight":"115"},"63af471efe987",["116","117","118"],[],{"type":"112","properties":"119","required":"120","title":"121","$schema":"91","x-stoplight":"122"},"string","http://json-schema.org/draft-07/schema#",{"id":"123"},"description","in","name","schema","title","integer",{"id":"124"},["125"],{"id":"126"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["109","127"],"object",{"data":"128","next":"129"},{"Example 1":"130","Consumer group example":"131"},{"id":"132"},{"id":"133","key":"134","value":"135","summary":"136"},{"id":"137","key":"138","value":"139","summary":"140"},{"id":"141","key":"142","value":"143","summary":"144"},{"status":"145","message":"146"},["147","148"],"UnauthorizedError",{"id":"149"},"a486c294601f4","1e253ef93e680","my-username","543ef9f6de5b8","https",{"type":"150","description":"151","items":"152"},{"type":"90","description":"153","examples":"154"},{"data":"155","next":null},{"data":"156","next":null},"0953fe2bd7e24","51114378bea6d","DuplicateApiKey",{"message":"136","status":401},"Duplicate API key found","1608a8252f4c6","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","a558cfa4723c6","NoAPIKey",{"message":"157","status":401},"No API key found",{"type":"98"},{"type":"90"},"status","message","470b68e5f0549","array","The data array contains consumer group objects",{"type":"112","properties":"158"},"Link to the next page of results, if applicable",[null],["159","160","161"],["162"],"No API key found in request",{"created_at":"163","id":"164","name":"165","tags":"166","updated_at":"167"},{"created_at":1719859003,"id":"168","name":"169","tags":"170","updated_at":1719859003},{"created_at":1719858982,"id":"171","name":"172","tags":"173","updated_at":1719858982},{"created_at":1719859346,"id":"174","name":"175","tags":null,"updated_at":1719859346},{"created_at":1719859003,"id":"168","name":"169","tags":"176","updated_at":1719859003},{"type":"98","description":"177","examples":"178"},{"type":"90","description":"179","examples":"180"},{"type":"90","description":"181","examples":"182"},{"type":"150","description":"183","items":"184"},{"type":"98","description":"185","examples":"186"},"0d8f5353-8dd2-4013-859a-21510b970a64","group2",[],"7012a570-e372-4280-92db-7fbbe4af80bb","group1",[],"9faf2f1b-2110-4690-8b64-c70dc14aa51a","group3",[],"Unix epoch when the resource was created.",[1719859003],"The UUID of the consumer group",["168"],"The name of the consumer group",["169"],"An optional set of strings associated with the consumer group for grouping and filtering.",{"type":"90","examples":"187"},"Unix epoch when the resource was last updated.",[1719859003],["188"],"example_tag"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-consumers-consumer_username_or_id-consumer_groups",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Add a consumer to a specific consumer group.",["18"],"34125d4b77a3f","post","/consumers/{consumer_username_or_id}/consumer_groups",["19"],{},"post-consumers-consumer_username_or_id-consumer_groups","Add a consumer to a specific consumer group.\n\nIf you add a consumer to multiple groups:\n\nIf all groups are allowed by the Rate Limiting Advanced plugin, only the first group's settings will apply.\nOtherwise, whichever group is specified in the Rate Limiting Advanced plugin will be active.\n","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"consumer_groups",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],["43"],["44"],{"id":"45","url":"46","name":"47","description":"48","variables":"49"},"2b5601ccc1bbe","fc2838ddae91a","200",[],["50"],"The object returns information about the consumer and the group","f998398077587","401",[],["51"],"Unauthorized","9a62c8fde86e3",["52"],"The request body contains the group ID for the group that you are adding a consumer into.",{"id":"53","name":"54","style":"55","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","key":"61","extensions":"62","description":"63","type":"64","name":"65","in":"66"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"67","path":"68","port":"69","protocol":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},{"id":"76","mediaType":"72","examples":"77","encodings":"78","schema":"79"},{"id":"80","mediaType":"72","examples":"81","encodings":"82","schema":"83"},"51428d1df9259","consumer_username_or_id","simple",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"84","examples":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92","93"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"94","description":"95"},{"default":"96","description":"97"},{"default":"98","description":"99"},{"default":"100","description":"101","enum":"102"},"cd8d44c970af9","application/json",["103"],[],{"type":"104","x-examples":"105","properties":"106","$schema":"86","x-stoplight":"107"},"63d4d0f6e2c96",["108","109","110"],[],{"type":"104","properties":"111","required":"112","title":"113","$schema":"86","x-stoplight":"114"},"dd8b149543fc2",["115"],[],{"type":"104","properties":"116","required":"117","$schema":"86","x-stoplight":"118"},"string",["119"],"http://json-schema.org/draft-07/schema#",{"id":"120"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["100","121"],{"id":"122","key":"123","value":"124"},"object",{"Example 1":"125"},{"consumer":"126","consumer_groups":"127"},{"id":"128"},{"id":"129","key":"130","value":"131","summary":"132"},{"id":"133","key":"134","value":"135","summary":"136"},{"id":"137","key":"138","value":"139","summary":"140"},{"status":"141","message":"142"},["143","144"],"UnauthorizedError",{"id":"145"},{"id":"146","key":"147","value":"148"},{"group":"149"},["150"],{"id":"151"},"my-username","c7b9e89abc32b","https","f456198730985","Example",{"consumer":"152","consumer_groups":"153"},{"consumer":"154","consumer_groups":"155"},{"type":"104","properties":"156"},{"type":"157","items":"158"},"23d895bd3f81a","2cd39f88efd5d","DuplicateApiKey",{"message":"132","status":401},"Duplicate API key found","0c242f449ad38","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","ce301b05b63cc","NoAPIKey",{"message":"159","status":401},"No API key found",{"type":"160"},{"type":"84"},"status","message","470b68e5f0549","0331c2b59039f","Example request body",{"group":"161"},{"type":"84","description":"162","examples":"163"},"group","541e28cc6bdcb",{"created_at":0,"custom_id":null,"id":"84","tags":null,"type":0,"username":"84","username_lower":"84"},["164"],{"created_at":1638918560,"custom_id":null,"id":"161","tags":null,"type":0,"username":"165","username_lower":"166"},["167"],{"created_at":"168","custom_id":"169","id":"170","tags":"171","type":"172","username":"173","username_lower":"174"},"array",{"type":"104","properties":"175"},"No API key found in request","integer","288f2bfc-04e2-4ec3-b6f3-40408dff5417","The name or ID of the group to add the consumer to.\n",["161"],{"created_at":0,"id":"84","name":"84","tags":"176"},"BarryAllen","barryallen",{"created_at":1638918476,"id":"177","name":"178","tags":null},{"type":"160","description":"179","examples":"180"},{"type":"181","description":"182"},{"type":"84","description":"183"},{"type":"184","description":"185"},{"type":"160","default":0,"examples":"186"},{"type":"84","description":"187"},{"type":"84","description":"188"},{"created_at":"189","id":"190","name":"191","tags":"192"},{"red":null},"e2c3f16e-22c7-4ef4-b6e4-ab25c522b339","JL","Unix epoch when the resource was created.",[1638918560],["84","193"],"Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or `username` with the request.","The UUID for the consumer",["104","193"],"An optional set of strings associated with consumer group for grouping and filtering.",[0],"The unique username of the Consumer. You must send either this field or `custom_id` with the request.","A lowercase representation of the username",{"type":"160","description":"179"},{"type":"84","description":"194"},{"type":"84","description":"195"},{"type":"196","description":"185"},"null","The UUID for the consumer group","The name of the consumer group",["104","193"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-consumers-consumer_username_or_id-consumer_groups",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Remove a consumer from all groups",["18"],"f94537f295eb4","delete","/consumers/{consumer_username_or_id}/consumer_groups",["19"],{},"delete-consumers-consumer_username_or_id-consumer_groups","Remove a consumer from all groups.","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"consumer_groups",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33"],["34"],{"id":"35","url":"36","name":"37","description":"38","variables":"39"},"2b5601ccc1bbe","250730d55a0ef","204",[],[],"HTTP/1.1 204 No Content\n",{"id":"40","name":"41","style":"42","examples":"43","description":"44","required":true,"schema":"45","explicitProperties":"46"},{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},"cd0e2fb5cbe3d","consumer_username_or_id","simple",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"58","examples":"59","$schema":"60","x-stoplight":"61"},["62","63","64","65","66","67"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"68","description":"69"},{"default":"70","description":"71"},{"default":"72","description":"73"},{"default":"74","description":"75","enum":"76"},"string",["77"],"http://json-schema.org/draft-07/schema#",{"id":"78"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["74","79"],"my-username","7de2b77284b4b","https"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-consumer_groups-group_name_or_id-consumers",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all consumers in a consumer group",["17"],"2f0c1f9dcf68c","get","/consumer_groups/{group_name_or_id}/consumers",["18"],{},"get-consumer_groups-group_name_or_id-consumers","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"consumer_groups",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38"],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"2b5601ccc1bbe","7b042ebd3f25b","200",[],["46"],"A consumer response object","10742f4eaf18a","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"57","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","key":"63","extensions":"64","description":"65","type":"66","name":"67","in":"68"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"69","path":"70","port":"71","protocol":"72"},{"id":"73","mediaType":"74","examples":"75","encodings":"76","schema":"77"},{"id":"78","mediaType":"74","examples":"79","encodings":"80","schema":"81"},"3af823700c7f7","tags","form",["82"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"83","examples":"84","x-stoplight":"85","$schema":"86"},["87","88","89","90","91","92"],"7ddf5d6d470ce","group_name_or_id","simple",[],"The name or UUID of the consumer group.",{"anyOf":"93","type":"83","examples":"94","$schema":"86","x-stoplight":"95"},["90","89","96","91","87","92"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"97","description":"98"},{"default":"99","description":"100"},{"default":"101","description":"102"},{"default":"103","description":"104","enum":"105"},"6a851f73901ff","application/json",[],[],{"type":"106","properties":"107","x-examples":"108","$schema":"86","x-stoplight":"109"},"84c1df55f3cb5",["110","111","112"],[],{"type":"106","properties":"113","required":"114","title":"115","$schema":"86","x-stoplight":"116"},{"id":"117","value":"118","key":"119"},"string",["118"],{"explicitProperties":"120","id":"121"},"http://json-schema.org/draft-07/schema#","description","example","in","name","schema","title",["122","123"],["124"],{"id":"125"},"required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["103","126"],"object",{"data":"127","next":"128"},{"Example 1":"129","One consumer":"130","Multiple consumers":"131"},{"id":"132"},{"id":"133","key":"134","value":"135","summary":"136"},{"id":"137","key":"138","value":"139","summary":"140"},{"id":"141","key":"142","value":"143","summary":"144"},{"status":"145","message":"146"},["147","148"],"UnauthorizedError",{"id":"149"},"fdcd9bea93307","tag1,tag2","default",["150","151","152"],"efbf16e7dbb82",{"type":"83","examples":"153"},{"type":"83","examples":"154"},"my_group","6433c58b201bd","https",{"type":"155","description":"156","items":"157"},{"type":"83","description":"158","examples":"159"},{"data":"160","next":null},{"data":"161","next":null},{"data":"162","next":null},"ab70985368bb5","123ddae90de6c","DuplicateApiKey",{"message":"136","status":401},"Duplicate API key found","005c3f8ff116e","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","62d738dae3965","NoAPIKey",{"message":"163","status":401},"No API key found",{"type":"164"},{"type":"83"},"status","message","470b68e5f0549","type","nullable","examples",["124"],["165"],"array","The data array contains consumer objects",{"type":"106","properties":"166"},"Link to the next page of results, if applicable",[null],["167","168","169"],["170"],["171","172","173"],"No API key found in request","integer","84a73fb8-50fc-44a7-a4d5-aa17728ee83f",{"created_at":"174","custom_id":"175","id":"176","tags":"177","type":"178","updated_at":"179","username":"180","username_lower":"181"},{"created_at":1719859293,"custom_id":"182","id":"183","tags":null,"type":0,"updated_at":1719859293,"username":"184","username_lower":"184"},{"created_at":1719858943,"custom_id":"185","id":"186","tags":null,"type":0,"updated_at":1719858943,"username":"187","username_lower":"187"},{"created_at":1719858965,"custom_id":"188","id":"189","tags":null,"type":0,"updated_at":1719858965,"username":"190","username_lower":"190"},{"created_at":1719859293,"custom_id":"182","id":"183","tags":null,"type":0,"updated_at":1719859293,"username":"184","username_lower":"184"},{"created_at":1719859293,"custom_id":"182","id":"183","tags":null,"type":0,"updated_at":1719859293,"username":"184","username_lower":"184"},{"created_at":1719858943,"custom_id":"185","id":"186","tags":null,"type":0,"updated_at":1719858943,"username":"187","username_lower":"187"},{"created_at":1719858965,"custom_id":"188","id":"189","tags":null,"type":0,"updated_at":1719858965,"username":"190","username_lower":"190"},{"type":"164","description":"191","examples":"192"},{"type":"83","description":"193","examples":"194"},{"type":"83","description":"195","examples":"196"},{"type":"155","description":"197","items":"198"},{"type":"164","default":0,"examples":"199"},{"type":"164","description":"200","examples":"201"},{"type":"83","description":"202","examples":"203"},{"type":"83","description":"204","examples":"205"},"consumer_id3","1cf590ba-4b23-46fa-9e8d-4296213e2ac6","consumer3","consumer_id","73b74f15-5185-4b16-a2fc-3c2fd834ba6c","consumer","consumer_id2","f9383372-7bf4-4275-8bbc-4f89d7a38a23","consumer2","Unix epoch when the resource was created.",[1719859293],"Custom ID of the consumer",["182"],"The consumer ID",["183"],"Tags associated with the consumer",{"type":"83","examples":"206"},[0],"Unix epoch when the resource was last updated.",[1719859293],"The username of the consumer",["184"],"Lowercase representation of the consumer username.",["184"],["207"],"test"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-consumer_groups-group_name_or_id-consumers",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Add a consumer to a group",["18"],"070918dc56212","post","/consumer_groups/{group_name_or_id}/consumers",["19"],{},"post-consumer_groups-group_name_or_id-consumers","Add a consumer to a specific consumer group.\n\nIf you add a consumer to multiple groups:\n\nIf all groups are allowed by the Rate Limiting Advanced plugin, only the first group's settings will apply.\nOtherwise, whichever group is specified in the Rate Limiting Advanced plugin will be active.","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"consumer_groups",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41"},[],[],[],["42"],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"2b5601ccc1bbe","d270915cfbfa5","200",[],["49"],"The object returns information about the consumer and the group","7a408f803938a","401",[],["50"],"Unauthorized","12f552dc5c00f",["51"],{"id":"52","name":"53","style":"54","examples":"55","description":"56","required":true,"schema":"57","explicitProperties":"58"},{"id":"59","key":"60","extensions":"61","description":"62","type":"63","name":"64","in":"65"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"66","path":"67","port":"68","protocol":"69"},{"id":"70","mediaType":"71","examples":"72","encodings":"73","schema":"74"},{"id":"75","mediaType":"71","examples":"76","encodings":"77","schema":"78"},{"id":"79","mediaType":"71","examples":"80","encodings":"81","schema":"82"},"6368f65490b39","group_name_or_id","simple",[],"The name or UUID of the consumer group.",{"anyOf":"83","type":"84","examples":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92","93"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"94","description":"95"},{"default":"96","description":"97"},{"default":"98","description":"99"},{"default":"100","description":"101","enum":"102"},"a4cc07ebc5cb8","application/json",["103"],[],{"type":"104","x-examples":"105","properties":"106","$schema":"86","x-stoplight":"107"},"7517b32d32684",["108","109","110"],[],{"type":"104","properties":"111","required":"112","title":"113","$schema":"86","x-stoplight":"114"},"d472cc9e0e233",[],[],{"type":"104","properties":"115","$schema":"86","x-stoplight":"116"},["117","118"],"string",["119"],"http://json-schema.org/draft-07/schema#",{"id":"120"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["100","121"],{"id":"122","key":"123","value":"124"},"object",{"Example 1":"125"},{"consumer":"126","consumer_groups":"127"},{"id":"128"},{"id":"129","key":"130","value":"131","summary":"132"},{"id":"133","key":"134","value":"135","summary":"136"},{"id":"137","key":"138","value":"139","summary":"140"},{"status":"141","message":"142"},["143","144"],"UnauthorizedError",{"id":"145"},{"consumer":"146"},{"id":"147"},{"type":"84","examples":"148"},{"type":"84","examples":"149"},"my_group","bda750db7858f","https","62bb8c1c36c33","Example",{"consumer":"150","consumer_groups":"151"},{"consumer":"152","consumer_groups":"153"},{"type":"104","properties":"154"},{"type":"155","items":"156"},"23d895bd3f81a","760f507f8611b","DuplicateApiKey",{"message":"132","status":401},"Duplicate API key found","3d2c682f1e2f1","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","1b7efe91c6aaf","NoAPIKey",{"message":"157","status":401},"No API key found",{"type":"158"},{"type":"84"},"status","message","470b68e5f0549",{"type":"84","description":"159","examples":"160"},"2b27ad483cd86",["119"],["161"],{"created_at":0,"custom_id":null,"id":"84","tags":null,"type":0,"username":"84","username_lower":"84"},["162"],{"created_at":1638918560,"custom_id":null,"id":"163","tags":null,"type":0,"username":"164","username_lower":"165"},["166"],{"created_at":"167","custom_id":"168","id":"169","tags":"170","type":"171","username":"172","username_lower":"173"},"array",{"type":"104","properties":"174"},"No API key found in request","integer","The name or ID of the consumer to add to this group.\n",["175"],"84a73fb8-50fc-44a7-a4d5-aa17728ee83f",{"created_at":0,"id":"84","name":"84","tags":"176"},"288f2bfc-04e2-4ec3-b6f3-40408dff5417","BarryAllen","barryallen",{"created_at":1638918476,"id":"177","name":"178","tags":null},{"type":"158","description":"179","examples":"180"},{"type":"181","description":"182"},{"type":"84","description":"183"},{"type":"184","description":"185"},{"type":"158","default":0,"examples":"186"},{"type":"84","description":"187"},{"type":"84","description":"188"},{"created_at":"189","id":"190","name":"191","tags":"192"},"8a4bba3c-7f82-45f0-8121-ed4d2847c4a4",{"red":null},"e2c3f16e-22c7-4ef4-b6e4-ab25c522b339","JL","Unix epoch when the resource was created.",[1638918560],["84","193"],"Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or `username` with the request.","The UUID for the consumer",["104","193"],"An optional set of strings associated with consumer group for grouping and filtering.",[0],"The unique username of the Consumer. You must send either this field or `custom_id` with the request.","A lowercase representation of the username",{"type":"158","description":"179"},{"type":"84","description":"194"},{"type":"84","description":"195"},{"type":"196","description":"185"},"null","The UUID for the consumer group","The name of the consumer group",["104","193"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-consumer_groups-group_name_or_id-consumers",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Remove all consumers from a consumer group",["18"],"c56463a945088","delete","/consumer_groups/{group_name_or_id}/consumers",["19"],{},"delete-consumer_groups-group_name_or_id-consumers","Removes all consumers from a specified consumer group.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"2b5601ccc1bbe","53b9dca543bb8","204",[],[],"HTTP/1.1 204 No Content\n","ab89de820528f","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},{"id":"65","mediaType":"66","examples":"67","encodings":"68","schema":"69"},"40808ef08b375","group_name_or_id","simple",[],"The name or UUID of the consumer group.",{"anyOf":"70","type":"71","examples":"72","$schema":"73","x-stoplight":"74"},["75","76","77","78","79","80"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88","enum":"89"},"61c8212de80f7","application/json",["90","91","92"],[],{"type":"93","properties":"94","required":"95","title":"96","$schema":"73","x-stoplight":"97"},["98","99"],"string",["100"],"http://json-schema.org/draft-07/schema#",{"id":"101"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["87","102"],{"id":"103","key":"104","value":"105","summary":"106"},{"id":"107","key":"108","value":"109","summary":"110"},{"id":"111","key":"112","value":"113","summary":"114"},"object",{"status":"115","message":"116"},["117","118"],"UnauthorizedError",{"id":"119"},{"type":"71","examples":"120"},{"type":"71","examples":"121"},"my_group","724c0e78c0276","https","7bf74632de9b9","DuplicateApiKey",{"message":"106","status":401},"Duplicate API key found","535b2ba5cdbfa","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","a4795c453f0d3","NoAPIKey",{"message":"122","status":401},"No API key found",{"type":"123"},{"type":"71"},"status","message","470b68e5f0549",["100"],["124"],"No API key found in request","integer","84a73fb8-50fc-44a7-a4d5-aa17728ee83f"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-consumers-consumer_name_or_id-consumer_groups-group_name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Remove a consumer from a consumer group",["18"],"c0182c9881b97","delete","/consumers/{consumer_name_or_id}/consumer_groups/{group_name_or_id}",["19"],{},"delete-consumers-consumer_name_or_id-consumer_groups-group_name_or_id","Removes a consumer from a consumer group. This operation does not delete the consumer group.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"2b5601ccc1bbe","9bcf93f771bec","204",[],[],"HTTP/1.1 204 No Content\n","d6bf934ee8100","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"50","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},"6aa69a4e30d6d","consumer_name_or_id","simple",[],"The name or UUID of the consumer to remove.",{"type":"77","$schema":"78","x-stoplight":"79"},["80","81","82","83","84","85"],"6b63aa8bf2447","group_name_or_id",[],"The name or UUID of the consumer group.",{"anyOf":"86","type":"77","examples":"87","$schema":"78","x-stoplight":"88"},["80","81","82","83","84","85"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"89","description":"90"},{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96","enum":"97"},"7289a3ef19f6c","application/json",["98","99","100"],[],{"type":"101","properties":"102","required":"103","title":"104","$schema":"78","x-stoplight":"105"},"string","http://json-schema.org/draft-07/schema#",{"id":"106"},"name","in","required","schema","description","title",["107","108"],["109"],{"id":"110"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["95","111"],{"id":"112","key":"113","value":"114","summary":"115"},{"id":"116","key":"117","value":"118","summary":"119"},{"id":"120","key":"121","value":"122","summary":"123"},"object",{"status":"124","message":"125"},["126","127"],"UnauthorizedError",{"id":"128"},"69b7c61905346",{"type":"77","examples":"129"},{"type":"77","examples":"130"},"my_group","ac885f62dbbbd","https","f85ef96c258ff","DuplicateApiKey",{"message":"115","status":401},"Duplicate API key found","15c8b1be46bcc","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","c60368316d897","NoAPIKey",{"message":"131","status":401},"No API key found",{"type":"132"},{"type":"77"},"status","message","470b68e5f0549",["109"],["133"],"No API key found in request","integer","84a73fb8-50fc-44a7-a4d5-aa17728ee83f"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-consumer_groups-group_name_or_id-consumers-consumer_name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Remove a consumer from a consumer group",["18"],"da6481cb433e7","delete","/consumer_groups/{group_name_or_id}/consumers/{consumer_username_or_id}",["19"],{},"delete-consumer_groups-group_name_or_id-consumers-consumer_name_or_id","The consumer groups endpoint for removing a consumer from a specified consumer group.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"2b5601ccc1bbe","929eb9fa4d5fe","204",[],[],"HTTP/1.1 204 No Content\n","ba8ebbbff6528","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"50","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},"43a425e9a1b6f","group_name_or_id","simple",[],"The name or UUID of the consumer group.",{"anyOf":"77","type":"78","examples":"79","$schema":"80","x-stoplight":"81"},["82","83","84","85","86","87"],"39787188718db","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"78","examples":"88","$schema":"80","x-stoplight":"89"},["82","83","84","85","86","87"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95"},{"default":"96","description":"97","enum":"98"},"6f2356d3fc05e","application/json",["99","100","101"],[],{"type":"102","properties":"103","required":"104","title":"105","$schema":"80","x-stoplight":"106"},["107","108"],"string",["109"],"http://json-schema.org/draft-07/schema#",{"id":"110"},"name","in","required","schema","description","title",["111"],{"id":"112"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["96","113"],{"id":"114","key":"115","value":"116","summary":"117"},{"id":"118","key":"119","value":"120","summary":"121"},{"id":"122","key":"123","value":"124","summary":"125"},"object",{"status":"126","message":"127"},["128","129"],"UnauthorizedError",{"id":"130"},{"type":"78","examples":"131"},{"type":"78","examples":"132"},"my_group","3aad36893415c","my-username","8d20e8986febf","https","3fa46c2e3ebfb","DuplicateApiKey",{"message":"117","status":401},"Duplicate API key found","708eb61691e8e","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","9cedef066029f","NoAPIKey",{"message":"133","status":401},"No API key found",{"type":"134"},{"type":"78"},"status","message","470b68e5f0549",["109"],["135"],"No API key found in request","integer","84a73fb8-50fc-44a7-a4d5-aa17728ee83f"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/put-consumer_groups-group_name_or_id-overrides-plugins-rate-limiting-advanced",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Configure rate limiting for a consumer group.",["18"],"7a6b48a2be84f","put","/consumer_groups/{group_name_or_id}/overrides/plugins/rate-limiting-advanced",["19"],{},"put-consumer_groups-group_name_or_id-overrides-plugins-rate-limiting-advanced","Define custom rate limiting settings for a consumer group. This endpoint overrides the settings of the Rate Limiting Advanced plugin. As of Kong Gateway 3.4, you can scope plugins to consumer groups using only the `/consumer_groups` endpoint. Using `overrides` is deprecated, and no longer recommended.\n'401': \n $ref: '#/components/responses/HTTP401Error'\n","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35","description":"36"},[],[],[],["37"],["38"],{"id":"39","url":"40","name":"41","description":"42","variables":"43"},"2b5601ccc1bbe","a67aeb8b60062","201",[],["44"],"Created","6b2ab91119d88",["45"],"Request Body\n",{"id":"46","name":"47","style":"48","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},{"id":"64","mediaType":"65","examples":"66","encodings":"67","schema":"68"},{"id":"69","mediaType":"65","examples":"70","encodings":"71","schema":"72"},"fd642f5a13ed8","group_name_or_id","simple",[],"The name or UUID of the consumer group.",{"anyOf":"73","type":"74","examples":"75","$schema":"76","x-stoplight":"77"},["78","79","80","81","82","83"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"84","description":"85"},{"default":"86","description":"87"},{"default":"88","description":"89"},{"default":"90","description":"91","enum":"92"},"606a30ae31d1d","application/json",["93"],[],{"type":"94","x-examples":"95","properties":"96","$schema":"76","x-stoplight":"97"},"f240c880b6ecb",["98"],[],{"type":"94","properties":"99","required":"100","$schema":"76","x-stoplight":"101"},["102","103"],"string",["104"],"http://json-schema.org/draft-07/schema#",{"id":"105"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["90","106"],{"id":"107","key":"108","value":"109"},"object",{"Example 1":"110"},{"config":"111","group":"112","plugin":"113"},{"id":"114"},{"id":"115","key":"116","value":"117"},{"config.limit":"118","config.window_size":"119","config.window_type":"120","config.retry_after_jitter_max":"121"},["122","123"],{"id":"124"},{"type":"74","examples":"125"},{"type":"74","examples":"126"},"my_group","08fac6987767b","https","24452c8263ca3","Example ",{"config":"127","group":"128","plugin":"129"},{"config":"130","group":"128","plugin":"129"},{"type":"94","properties":"131"},{"type":"74","description":"132","examples":"133"},{"type":"74","description":"134","examples":"135"},"6bc778b4a31ca","742b3410f23e2","Request body",{"config.limit":"74","config.window_size":"136","config.window_type":"137","config.retry_after_jitter_max":"74"},{"type":"74","description":"138"},{"type":"74","description":"139","examples":"140"},{"type":"74","description":"141","default":"137","enum":"142"},{"type":"74","description":"143"},"config.limit","config.window_size","a9641c0a54b5f",["104"],["144"],{"limit":"145","retry_after_jitter_max":0,"window_size":"146","window_type":"137"},"test-group","rate-limiting-advanced",{"limit":"147","retry_after_jitter_max":0,"window_size":"148","window_type":"137"},{"limit":"149","retry_after_jitter_max":"150","window_size":"151","window_type":"152"},"The consumer group",["128"],"The name of the plugin",["129"]," 10","sliding","An array of one or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.\n","An array of one or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.\n",["136"],"Set the time window type to either sliding (default) or fixed.\n",["137","153"],"The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.","84a73fb8-50fc-44a7-a4d5-aa17728ee83f",[10],[10],[10],[10],{"type":"154","description":"155","items":"156"},{"type":"157","description":"158"},{"type":"154","description":"139","items":"159"},{"type":"74","description":"141","examples":"160"},"fixed","array","An array of one or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified. \n",{"type":"157","examples":"161"},"integer","The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.\n",{"type":"157","examples":"162"},["137"],[10],[10]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-consumer_groups-group_name_or_id-overrides-plugins-rate-limiting-advanced",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete the configurations for a consumer group",["18"],"15428e3dc04b1","delete","/consumer_groups/{group_name_or_id}/overrides/plugins/rate-limiting-advanced",["19"],{},"delete-consumer_groups-group_name_or_id-overrides-plugins-rate-limiting-advanced","Delete custom rate limiting settings for a consumer group. As of Kong Gateway 3.4, you can scope plugins to consumer groups using only the `/consumer_groups` endpoint. Using `overrides` is deprecated, and no longer recommended.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"2b5601ccc1bbe","0784ec93682ac","204",[],[],"HTTP/1.1 204 No Content\n","4254ebeadf46a","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},{"id":"65","mediaType":"66","examples":"67","encodings":"68","schema":"69"},"410c1f7fd15f5","group_name_or_id","simple",[],"The name or UUID of the consumer group.",{"anyOf":"70","type":"71","examples":"72","$schema":"73","x-stoplight":"74"},["75","76","77","78","79","80"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88","enum":"89"},"a5c4e135e2af1","application/json",["90","91","92"],[],{"type":"93","properties":"94","required":"95","title":"96","$schema":"73","x-stoplight":"97"},["98","99"],"string",["100"],"http://json-schema.org/draft-07/schema#",{"id":"101"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["87","102"],{"id":"103","key":"104","value":"105","summary":"106"},{"id":"107","key":"108","value":"109","summary":"110"},{"id":"111","key":"112","value":"113","summary":"114"},"object",{"status":"115","message":"116"},["117","118"],"UnauthorizedError",{"id":"119"},{"type":"71","examples":"120"},{"type":"71","examples":"121"},"my_group","416c1361c2215","https","5c6d9aa82660e","DuplicateApiKey",{"message":"106","status":401},"Duplicate API key found","8aafc7973cfe0","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","f4a0be8d78c73","NoAPIKey",{"message":"122","status":401},"No API key found",{"type":"123"},{"type":"71"},"status","message","470b68e5f0549",["100"],["124"],"No API key found in request","integer","84a73fb8-50fc-44a7-a4d5-aa17728ee83f"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-consumer_groups_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List consumer groups",["18"],"ac0962ac22d2a","get","/{workspace}/consumer_groups",["19"],{},"get-consumer_groups_with_workspace","List all consumer groups\n\nUse consumer groups to manage consumer affiliation.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"2b5601ccc1bbe","13ed56200420c","200",[],["46"],"The consumer group response body","7e7d558e943bd","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","key":"56","extensions":"57","description":"58","type":"59","name":"60","in":"61"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"62","path":"63","port":"64","protocol":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},"7bffe4b40efc7","workspace","simple",[],"Name or ID of workspace",{"type":"75","examples":"76","$schema":"77","x-stoplight":"78"},["79","80","81","82","83","84"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"85","description":"86"},{"default":"87","description":"88"},{"default":"89","description":"90"},{"default":"91","description":"92","enum":"93"},"3d48064bf2d45","application/json",[],[],{"type":"94","properties":"95","x-examples":"96","$schema":"77","x-stoplight":"97"},"6a3674bc8c19e",["98","99","100"],[],{"type":"94","properties":"101","required":"102","title":"103","$schema":"77","x-stoplight":"104"},"string",["105"],"http://json-schema.org/draft-07/schema#",{"id":"106"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["91","107"],"object",{"data":"108","next":"109"},{"Example 1":"110","Consumer group example":"111"},{"id":"112"},{"id":"113","key":"114","value":"115","summary":"116"},{"id":"117","key":"118","value":"119","summary":"120"},{"id":"121","key":"122","value":"123","summary":"124"},{"status":"125","message":"126"},["127","128"],"UnauthorizedError",{"id":"129"},"team-a","8f928bbda9957","https",{"type":"130","description":"131","items":"132"},{"type":"75","description":"133","examples":"134"},{"data":"135","next":null},{"data":"136","next":null},"0953fe2bd7e24","305a133bf7b66","DuplicateApiKey",{"message":"116","status":401},"Duplicate API key found","2deeaa6a08d05","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","24f2323bbb82d","NoAPIKey",{"message":"137","status":401},"No API key found",{"type":"138"},{"type":"75"},"status","message","470b68e5f0549","array","The data array contains consumer group objects",{"type":"94","properties":"139"},"Link to the next page of results, if applicable",[null],["140","141","142"],["143"],"No API key found in request","integer",{"created_at":"144","id":"145","name":"146","tags":"147","updated_at":"148"},{"created_at":1719859003,"id":"149","name":"150","tags":"151","updated_at":1719859003},{"created_at":1719858982,"id":"152","name":"153","tags":"154","updated_at":1719858982},{"created_at":1719859346,"id":"155","name":"156","tags":null,"updated_at":1719859346},{"created_at":1719859003,"id":"149","name":"150","tags":"157","updated_at":1719859003},{"type":"138","description":"158","examples":"159"},{"type":"75","description":"160","examples":"161"},{"type":"75","description":"162","examples":"163"},{"type":"130","description":"164","items":"165"},{"type":"138","description":"166","examples":"167"},"0d8f5353-8dd2-4013-859a-21510b970a64","group2",[],"7012a570-e372-4280-92db-7fbbe4af80bb","group1",[],"9faf2f1b-2110-4690-8b64-c70dc14aa51a","group3",[],"Unix epoch when the resource was created.",[1719859003],"The UUID of the consumer group",["149"],"The name of the consumer group",["150"],"An optional set of strings associated with the consumer group for grouping and filtering.",{"type":"75","examples":"168"},"Unix epoch when the resource was last updated.",[1719859003],["169"],"example_tag"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-consumer_groups_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create a consumer group",["18"],"a6dbd700b3956","post","/{workspace}/consumer_groups",["19"],{},"post-consumer_groups_with_workspace","Create a new consumer group.","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"consumer_groups",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],["43"],["44"],{"id":"45","url":"46","name":"47","description":"48","variables":"49"},"2b5601ccc1bbe","140370f7f6500","201",[],["50"],"The consumer group response body","1163719abfb4a","401",[],["51"],"Unauthorized","f9d762b13a1b0",["52"],"The consumer groups request body for creating new consumer groups.",{"id":"53","name":"54","style":"55","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","key":"61","extensions":"62","description":"63","type":"64","name":"65","in":"66"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"67","path":"68","port":"69","protocol":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},{"id":"76","mediaType":"72","examples":"77","encodings":"78","schema":"79"},{"id":"80","mediaType":"72","examples":"81","encodings":"82","schema":"83"},"ae8b0008a9b16","workspace","simple",[],"Name or ID of workspace",{"type":"84","examples":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92","93"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"94","description":"95"},{"default":"96","description":"97"},{"default":"98","description":"99"},{"default":"100","description":"101","enum":"102"},"cc58ad6c57f22","application/json",[],[],{"type":"103","properties":"104","x-examples":"105","$schema":"86","x-stoplight":"106"},"746ab0a84354c",["107","108","109"],[],{"type":"103","properties":"110","required":"111","title":"112","$schema":"86","x-stoplight":"113"},"f280bb951eda4",["114"],[],{"type":"103","x-examples":"115","properties":"116","required":"117","$schema":"86","x-stoplight":"118"},"string",["119"],"http://json-schema.org/draft-07/schema#",{"id":"120"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["100","121"],"object",{"data":"122","next":"123"},{"Example 1":"124","Consumer group example":"125"},{"id":"126"},{"id":"127","key":"128","value":"129","summary":"130"},{"id":"131","key":"132","value":"133","summary":"134"},{"id":"135","key":"136","value":"137","summary":"138"},{"status":"139","message":"140"},["141","142"],"UnauthorizedError",{"id":"143"},{"id":"144","key":"145","value":"146"},{"Example 1":"147"},{"name":"148","tags":"149"},["88"],{"id":"150"},"team-a","08d18ced27e24","https",{"type":"151","description":"152","items":"153"},{"type":"84","description":"154","examples":"155"},{"data":"156","next":null},{"data":"157","next":null},"0953fe2bd7e24","239dfcfb8144b","DuplicateApiKey",{"message":"130","status":401},"Duplicate API key found","2132942992820","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","932ee6c5ce6af","NoAPIKey",{"message":"158","status":401},"No API key found",{"type":"159"},{"type":"84"},"status","message","470b68e5f0549","376068cb94668","example consumer group request body",{"name":"160","tags":"161"},{"created_at":1557522650,"id":"162","name":"163","tags":"164"},{"type":"84","description":"165","examples":"166"},{"type":"151","description":"167","items":"168"},"1598c3a7bbe87","array","The data array contains consumer group objects",{"type":"103","properties":"169"},"Link to the next page of results, if applicable",[null],["170","171","172"],["173"],"No API key found in request","integer","my_group",["84"],"fa6881b2-f49f-4007-9475-577cd21d34f4","JL",["174","175"],"A unique name for the consumer group you want to create.",["160"],"An optional set of strings associated with the consumer group for grouping and filtering.",{"type":"84"},{"created_at":"176","id":"177","name":"178","tags":"179","updated_at":"180"},{"created_at":1719859003,"id":"181","name":"182","tags":"183","updated_at":1719859003},{"created_at":1719858982,"id":"184","name":"185","tags":"186","updated_at":1719858982},{"created_at":1719859346,"id":"187","name":"188","tags":null,"updated_at":1719859346},{"created_at":1719859003,"id":"181","name":"182","tags":"189","updated_at":1719859003},"tag1","tag2",{"type":"159","description":"190","examples":"191"},{"type":"84","description":"192","examples":"193"},{"type":"84","description":"194","examples":"195"},{"type":"151","description":"167","items":"196"},{"type":"159","description":"197","examples":"198"},"0d8f5353-8dd2-4013-859a-21510b970a64","group2",[],"7012a570-e372-4280-92db-7fbbe4af80bb","group1",[],"9faf2f1b-2110-4690-8b64-c70dc14aa51a","group3",[],"Unix epoch when the resource was created.",[1719859003],"The UUID of the consumer group",["181"],"The name of the consumer group",["182"],{"type":"84","examples":"199"},"Unix epoch when the resource was last updated.",[1719859003],["200"],"example_tag"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-consumer_groups-group_name_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List a specific consumer group",["18"],"63b6f704647f1","get","/{workspace}/consumer_groups/{group_name_or_id}",["19"],{},"get-consumer_groups-group_name_with_workspace","Returns a consumer group by passing either the `group_name` or `group_id` as a path parameter.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"2b5601ccc1bbe","9092943da10c8","200",[],["47"],"The consumer group response body","38629260df727","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","required":true,"schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","key":"63","extensions":"64","description":"65","type":"66","name":"67","in":"68"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"69","path":"70","port":"71","protocol":"72"},{"id":"73","mediaType":"74","examples":"75","encodings":"76","schema":"77"},{"id":"78","mediaType":"74","examples":"79","encodings":"80","schema":"81"},"84c679c9802fe","workspace","simple",[],"Name or ID of workspace",{"type":"82","examples":"83","$schema":"84","x-stoplight":"85"},["86","87","88","89","90","91"],"d30bb41763559","group_name_or_id",[],"The name or UUID of the consumer group.",{"anyOf":"92","type":"82","examples":"93","$schema":"84","x-stoplight":"94"},["86","87","88","89","90","91"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"95","description":"96"},{"default":"97","description":"98"},{"default":"99","description":"100"},{"default":"101","description":"102","enum":"103"},"4b792192cefd7","application/json",[],[],{"type":"104","properties":"105","x-examples":"106","$schema":"84","x-stoplight":"107"},"7138e1da8b924",["108","109","110"],[],{"type":"104","properties":"111","required":"112","title":"113","$schema":"84","x-stoplight":"114"},"string",["115"],"http://json-schema.org/draft-07/schema#",{"id":"116"},"name","in","required","schema","description","title",["117","118"],["119"],{"id":"120"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["101","121"],"object",{"data":"122","next":"123"},{"Example 1":"124","Consumer group example":"125"},{"id":"126"},{"id":"127","key":"128","value":"129","summary":"130"},{"id":"131","key":"132","value":"133","summary":"134"},{"id":"135","key":"136","value":"137","summary":"138"},{"status":"139","message":"140"},["141","142"],"UnauthorizedError",{"id":"143"},"team-a","b0992447e9bda",{"type":"82","examples":"144"},{"type":"82","examples":"145"},"my_group","a15acd95ce957","https",{"type":"146","description":"147","items":"148"},{"type":"82","description":"149","examples":"150"},{"data":"151","next":null},{"data":"152","next":null},"0953fe2bd7e24","0f154b7723268","DuplicateApiKey",{"message":"130","status":401},"Duplicate API key found","3df22d1938ea4","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","e11c6cf986e95","NoAPIKey",{"message":"153","status":401},"No API key found",{"type":"154"},{"type":"82"},"status","message","470b68e5f0549",["119"],["155"],"array","The data array contains consumer group objects",{"type":"104","properties":"156"},"Link to the next page of results, if applicable",[null],["157","158","159"],["160"],"No API key found in request","integer","84a73fb8-50fc-44a7-a4d5-aa17728ee83f",{"created_at":"161","id":"162","name":"163","tags":"164","updated_at":"165"},{"created_at":1719859003,"id":"166","name":"167","tags":"168","updated_at":1719859003},{"created_at":1719858982,"id":"169","name":"170","tags":"171","updated_at":1719858982},{"created_at":1719859346,"id":"172","name":"173","tags":null,"updated_at":1719859346},{"created_at":1719859003,"id":"166","name":"167","tags":"174","updated_at":1719859003},{"type":"154","description":"175","examples":"176"},{"type":"82","description":"177","examples":"178"},{"type":"82","description":"179","examples":"180"},{"type":"146","description":"181","items":"182"},{"type":"154","description":"183","examples":"184"},"0d8f5353-8dd2-4013-859a-21510b970a64","group2",[],"7012a570-e372-4280-92db-7fbbe4af80bb","group1",[],"9faf2f1b-2110-4690-8b64-c70dc14aa51a","group3",[],"Unix epoch when the resource was created.",[1719859003],"The UUID of the consumer group",["166"],"The name of the consumer group",["167"],"An optional set of strings associated with the consumer group for grouping and filtering.",{"type":"82","examples":"185"},"Unix epoch when the resource was last updated.",[1719859003],["186"],"example_tag"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/put-consumer_groups-group_name_or_id_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create consumer group",["18"],"93f4f40f64db1","put","/{workspace}/consumer_groups/{group_name_or_id}",["19"],{},"put-consumer_groups-group_name_or_id_with_workspace","Create a consumer group by passing a new group name as the path parameter","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"consumer_groups",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],["43","44"],["45"],{"id":"46","url":"47","name":"48","description":"49","variables":"50"},"2b5601ccc1bbe","25d3f1d80f353","200",[],["51"],"The consumer group response body","f343f263bf26a","401",[],["52"],"Unauthorized","1a2352d27b542",["53"],"The consumer groups request body for creating new consumer groups.",{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","name":"62","style":"56","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"79","examples":"84","encodings":"85","schema":"86"},{"id":"87","mediaType":"79","examples":"88","encodings":"89","schema":"90"},"044f92cfbada1","workspace","simple",[],"Name or ID of workspace",{"type":"91","examples":"92","$schema":"93","x-stoplight":"94"},["95","96","97","98","99","100"],"7441545a0a0af","group_name_or_id",[],"The name or UUID of the consumer group.",{"anyOf":"101","type":"91","examples":"102","$schema":"93","x-stoplight":"103"},["95","96","97","98","99","100"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"104","description":"105"},{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111","enum":"112"},"c42c291974f0b","application/json",[],[],{"type":"113","properties":"114","x-examples":"115","$schema":"93","x-stoplight":"116"},"53a5e983c8e34",["117","118","119"],[],{"type":"113","properties":"120","required":"121","title":"122","$schema":"93","x-stoplight":"123"},"a51f2a4c262a3",["124"],[],{"type":"113","x-examples":"125","properties":"126","required":"127","$schema":"93","x-stoplight":"128"},"string",["129"],"http://json-schema.org/draft-07/schema#",{"id":"130"},"name","in","required","schema","description","title",["131","132"],["133"],{"id":"134"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["110","135"],"object",{"data":"136","next":"137"},{"Example 1":"138","Consumer group example":"139"},{"id":"140"},{"id":"141","key":"142","value":"143","summary":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"id":"149","key":"150","value":"151","summary":"152"},{"status":"153","message":"154"},["155","156"],"UnauthorizedError",{"id":"157"},{"id":"158","key":"159","value":"160"},{"Example 1":"161"},{"name":"162","tags":"163"},["95"],{"id":"164"},"team-a","ea8d71c80ee7e",{"type":"91","examples":"165"},{"type":"91","examples":"166"},"my_group","96b24d0bb9513","https",{"type":"167","description":"168","items":"169"},{"type":"91","description":"170","examples":"171"},{"data":"172","next":null},{"data":"173","next":null},"0953fe2bd7e24","2fb1b6c19443b","DuplicateApiKey",{"message":"144","status":401},"Duplicate API key found","dc78296b08576","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","3a33119619575","NoAPIKey",{"message":"174","status":401},"No API key found",{"type":"175"},{"type":"91"},"status","message","470b68e5f0549","081aa7c82bbf0","example consumer group request body",{"name":"133","tags":"176"},{"created_at":1557522650,"id":"177","name":"178","tags":"179"},{"type":"91","description":"180","examples":"181"},{"type":"167","description":"182","items":"183"},"1598c3a7bbe87",["133"],["184"],"array","The data array contains consumer group objects",{"type":"113","properties":"185"},"Link to the next page of results, if applicable",[null],["186","187","188"],["189"],"No API key found in request","integer",["91"],"fa6881b2-f49f-4007-9475-577cd21d34f4","JL",["190","191"],"A unique name for the consumer group you want to create.",["133"],"An optional set of strings associated with the consumer group for grouping and filtering.",{"type":"91"},"84a73fb8-50fc-44a7-a4d5-aa17728ee83f",{"created_at":"192","id":"193","name":"194","tags":"195","updated_at":"196"},{"created_at":1719859003,"id":"197","name":"198","tags":"199","updated_at":1719859003},{"created_at":1719858982,"id":"200","name":"201","tags":"202","updated_at":1719858982},{"created_at":1719859346,"id":"203","name":"204","tags":null,"updated_at":1719859346},{"created_at":1719859003,"id":"197","name":"198","tags":"205","updated_at":1719859003},"tag1","tag2",{"type":"175","description":"206","examples":"207"},{"type":"91","description":"208","examples":"209"},{"type":"91","description":"210","examples":"211"},{"type":"167","description":"182","items":"212"},{"type":"175","description":"213","examples":"214"},"0d8f5353-8dd2-4013-859a-21510b970a64","group2",[],"7012a570-e372-4280-92db-7fbbe4af80bb","group1",[],"9faf2f1b-2110-4690-8b64-c70dc14aa51a","group3",[],"Unix epoch when the resource was created.",[1719859003],"The UUID of the consumer group",["197"],"The name of the consumer group",["198"],{"type":"91","examples":"215"},"Unix epoch when the resource was last updated.",[1719859003],["216"],"example_tag"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-consumer_groups-group_name_or_id_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a consumer group",["18"],"ed12741347ea8","delete","/{workspace}/consumer_groups/{group_name_or_id}",["19"],{},"delete-consumer_groups-group_name_or_id_with_workspace","Delete a consumer group. Deleting a consumer group removes all consumers from that group. This operation does not delete existing consuemrs.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"2b5601ccc1bbe","4a19340c7e2a7","204",[],[],"HTTP/1.1 204 No Content\n","df29349ded195","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"50","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},"718741371751d","workspace","simple",[],"Name or ID of workspace",{"type":"77","examples":"78","$schema":"79","x-stoplight":"80"},["81","82","83","84","85","86"],"36aaab0a2835f","group_name_or_id",[],"The name or UUID of the consumer group.",{"anyOf":"87","type":"77","examples":"88","$schema":"79","x-stoplight":"89"},["81","82","83","84","85","86"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95"},{"default":"96","description":"97","enum":"98"},"ded57074cd7e5","application/json",["99","100","101"],[],{"type":"102","properties":"103","required":"104","title":"105","$schema":"79","x-stoplight":"106"},"string",["107"],"http://json-schema.org/draft-07/schema#",{"id":"108"},"name","in","required","schema","description","title",["109","110"],["111"],{"id":"112"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["96","113"],{"id":"114","key":"115","value":"116","summary":"117"},{"id":"118","key":"119","value":"120","summary":"121"},{"id":"122","key":"123","value":"124","summary":"125"},"object",{"status":"126","message":"127"},["128","129"],"UnauthorizedError",{"id":"130"},"team-a","3e54a3c8f5931",{"type":"77","examples":"131"},{"type":"77","examples":"132"},"my_group","8bc8af8078231","https","240d61cdc52cc","DuplicateApiKey",{"message":"117","status":401},"Duplicate API key found","ed7677b3e46c4","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","d3c78c17454fb","NoAPIKey",{"message":"133","status":401},"No API key found",{"type":"134"},{"type":"77"},"status","message","470b68e5f0549",["111"],["135"],"No API key found in request","integer","84a73fb8-50fc-44a7-a4d5-aa17728ee83f"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-consumers-consumer_name_or_id-consumer_groups_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List consumer groups for a consumer",["18"],"36b32195e137d","get","/{workspace}/consumers/{consumer_username_or_id}/consumer_groups",["19"],{},"get-consumers-consumer_name_or_id-consumer_groups_with_workspace","View all consumer groups that a consumer is assigned to.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40"],[],["41","42"],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"2b5601ccc1bbe","e8e15fe7d76f2","200",[],["49"],"The consumer group response body","491161c4a79cc","401",[],["50"],"Unauthorized",{"id":"51","name":"52","style":"53","examples":"54","description":"55","schema":"56","explicitProperties":"57"},{"id":"58","name":"59","style":"53","examples":"60","description":"61","schema":"62","explicitProperties":"63"},{"id":"64","name":"65","style":"66","examples":"67","description":"68","required":true,"schema":"69","explicitProperties":"70"},{"id":"71","name":"72","style":"66","examples":"73","description":"74","required":true,"schema":"75","explicitProperties":"76"},{"id":"77","key":"78","extensions":"79","description":"80","type":"81","name":"82","in":"83"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"84","path":"85","port":"86","protocol":"87"},{"id":"88","mediaType":"89","examples":"90","encodings":"91","schema":"92"},{"id":"93","mediaType":"89","examples":"94","encodings":"95","schema":"96"},"12e9a1c0cb661","offset","form",[],"Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources",{"type":"97","$schema":"98","x-stoplight":"99"},["100","101","102","103","104"],"93faa9ea09eda","size",[],"Number of resources to be returned.",{"default":100,"maximum":1000,"minimum":1,"type":"105","$schema":"98","x-stoplight":"106"},["100","101","102","103","104"],"b88c5988ff75e","workspace","simple",[],"Name or ID of workspace",{"type":"97","examples":"107","$schema":"98","x-stoplight":"108"},["102","101","109","103","100","104"],"3aedbc67cab93","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"97","examples":"110","$schema":"98","x-stoplight":"111"},["102","101","109","103","100","104"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"112","description":"113"},{"default":"114","description":"115"},{"default":"116","description":"117"},{"default":"118","description":"119","enum":"120"},"ef34f8b468268","application/json",[],[],{"type":"121","properties":"122","x-examples":"123","$schema":"98","x-stoplight":"124"},"727a8b4ad251f",["125","126","127"],[],{"type":"121","properties":"128","required":"129","title":"130","$schema":"98","x-stoplight":"131"},"string","http://json-schema.org/draft-07/schema#",{"id":"132"},"description","in","name","schema","title","integer",{"id":"133"},["134"],{"id":"135"},"required",["136"],{"id":"137"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["118","138"],"object",{"data":"139","next":"140"},{"Example 1":"141","Consumer group example":"142"},{"id":"143"},{"id":"144","key":"145","value":"146","summary":"147"},{"id":"148","key":"149","value":"150","summary":"151"},{"id":"152","key":"153","value":"154","summary":"155"},{"status":"156","message":"157"},["158","159"],"UnauthorizedError",{"id":"160"},"ea1f446773e72","7e5c135279712","team-a","7113b8687e0be","my-username","9825d0fddb9f1","https",{"type":"161","description":"162","items":"163"},{"type":"97","description":"164","examples":"165"},{"data":"166","next":null},{"data":"167","next":null},"0953fe2bd7e24","c6ac994410430","DuplicateApiKey",{"message":"147","status":401},"Duplicate API key found","23d46e7271d6b","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","51e3d7c064d5b","NoAPIKey",{"message":"168","status":401},"No API key found",{"type":"105"},{"type":"97"},"status","message","470b68e5f0549","array","The data array contains consumer group objects",{"type":"121","properties":"169"},"Link to the next page of results, if applicable",[null],["170","171","172"],["173"],"No API key found in request",{"created_at":"174","id":"175","name":"176","tags":"177","updated_at":"178"},{"created_at":1719859003,"id":"179","name":"180","tags":"181","updated_at":1719859003},{"created_at":1719858982,"id":"182","name":"183","tags":"184","updated_at":1719858982},{"created_at":1719859346,"id":"185","name":"186","tags":null,"updated_at":1719859346},{"created_at":1719859003,"id":"179","name":"180","tags":"187","updated_at":1719859003},{"type":"105","description":"188","examples":"189"},{"type":"97","description":"190","examples":"191"},{"type":"97","description":"192","examples":"193"},{"type":"161","description":"194","items":"195"},{"type":"105","description":"196","examples":"197"},"0d8f5353-8dd2-4013-859a-21510b970a64","group2",[],"7012a570-e372-4280-92db-7fbbe4af80bb","group1",[],"9faf2f1b-2110-4690-8b64-c70dc14aa51a","group3",[],"Unix epoch when the resource was created.",[1719859003],"The UUID of the consumer group",["179"],"The name of the consumer group",["180"],"An optional set of strings associated with the consumer group for grouping and filtering.",{"type":"97","examples":"198"},"Unix epoch when the resource was last updated.",[1719859003],["199"],"example_tag"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-consumers-consumer_username_or_id-consumer_groups_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Add a consumer to a specific consumer group.",["18"],"b9d2ff4bbd063","post","/{workspace}/consumers/{consumer_username_or_id}/consumer_groups",["19"],{},"post-consumers-consumer_username_or_id-consumer_groups_with_workspace","Add a consumer to a specific consumer group.\n\nIf you add a consumer to multiple groups:\n\nIf all groups are allowed by the Rate Limiting Advanced plugin, only the first group's settings will apply.\nOtherwise, whichever group is specified in the Rate Limiting Advanced plugin will be active.\n","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"consumer_groups",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],["43","44"],["45"],{"id":"46","url":"47","name":"48","description":"49","variables":"50"},"2b5601ccc1bbe","9e3e14479d7db","200",[],["51"],"The object returns information about the consumer and the group","6b8e14f0341b9","401",[],["52"],"Unauthorized","f5b1a512a8924",["53"],"The request body contains the group ID for the group that you are adding a consumer into.",{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","name":"62","style":"56","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},{"id":"83","mediaType":"79","examples":"84","encodings":"85","schema":"86"},{"id":"87","mediaType":"79","examples":"88","encodings":"89","schema":"90"},"9aea671cf15ab","workspace","simple",[],"Name or ID of workspace",{"type":"91","examples":"92","$schema":"93","x-stoplight":"94"},["95","96","97","98","99","100"],"d148bb21d72c9","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"91","examples":"101","$schema":"93","x-stoplight":"102"},["95","96","97","98","99","100"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"103","description":"104"},{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110","enum":"111"},"e4fb0598e7085","application/json",["112"],[],{"type":"113","x-examples":"114","properties":"115","$schema":"93","x-stoplight":"116"},"20cd6c61de91b",["117","118","119"],[],{"type":"113","properties":"120","required":"121","title":"122","$schema":"93","x-stoplight":"123"},"b5dd814c5e02f",["124"],[],{"type":"113","properties":"125","required":"126","$schema":"93","x-stoplight":"127"},"string",["128"],"http://json-schema.org/draft-07/schema#",{"id":"129"},"name","in","required","schema","description","title",["130"],{"id":"131"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["109","132"],{"id":"133","key":"134","value":"135"},"object",{"Example 1":"136"},{"consumer":"137","consumer_groups":"138"},{"id":"139"},{"id":"140","key":"141","value":"142","summary":"143"},{"id":"144","key":"145","value":"146","summary":"147"},{"id":"148","key":"149","value":"150","summary":"151"},{"status":"152","message":"153"},["154","155"],"UnauthorizedError",{"id":"156"},{"id":"157","key":"158","value":"159"},{"group":"160"},["161"],{"id":"162"},"team-a","86c4c8bbd3f9e","my-username","cdc93d29d233a","https","8ee46b3071320","Example",{"consumer":"163","consumer_groups":"164"},{"consumer":"165","consumer_groups":"166"},{"type":"113","properties":"167"},{"type":"168","items":"169"},"23d895bd3f81a","147ac7614d8a2","DuplicateApiKey",{"message":"143","status":401},"Duplicate API key found","e1dee3c35f83c","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","29ad774193faf","NoAPIKey",{"message":"170","status":401},"No API key found",{"type":"171"},{"type":"91"},"status","message","470b68e5f0549","ba71d9b100ca5","Example request body",{"group":"172"},{"type":"91","description":"173","examples":"174"},"group","4a751be86f3f0",{"created_at":0,"custom_id":null,"id":"91","tags":null,"type":0,"username":"91","username_lower":"91"},["175"],{"created_at":1638918560,"custom_id":null,"id":"172","tags":null,"type":0,"username":"176","username_lower":"177"},["178"],{"created_at":"179","custom_id":"180","id":"181","tags":"182","type":"183","username":"184","username_lower":"185"},"array",{"type":"113","properties":"186"},"No API key found in request","integer","288f2bfc-04e2-4ec3-b6f3-40408dff5417","The name or ID of the group to add the consumer to.\n",["172"],{"created_at":0,"id":"91","name":"91","tags":"187"},"BarryAllen","barryallen",{"created_at":1638918476,"id":"188","name":"189","tags":null},{"type":"171","description":"190","examples":"191"},{"type":"192","description":"193"},{"type":"91","description":"194"},{"type":"195","description":"196"},{"type":"171","default":0,"examples":"197"},{"type":"91","description":"198"},{"type":"91","description":"199"},{"created_at":"200","id":"201","name":"202","tags":"203"},{"red":null},"e2c3f16e-22c7-4ef4-b6e4-ab25c522b339","JL","Unix epoch when the resource was created.",[1638918560],["91","204"],"Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or `username` with the request.","The UUID for the consumer",["113","204"],"An optional set of strings associated with consumer group for grouping and filtering.",[0],"The unique username of the Consumer. You must send either this field or `custom_id` with the request.","A lowercase representation of the username",{"type":"171","description":"190"},{"type":"91","description":"205"},{"type":"91","description":"206"},{"type":"207","description":"196"},"null","The UUID for the consumer group","The name of the consumer group",["113","204"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-consumers-consumer_username_or_id-consumer_groups_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Remove a consumer from all groups",["18"],"eaca8fbf1f411","delete","/{workspace}/consumers/{consumer_username_or_id}/consumer_groups",["19"],{},"delete-consumers-consumer_username_or_id-consumer_groups_with_workspace","Remove a consumer from all groups.","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"consumer_groups",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33","34"],["35"],{"id":"36","url":"37","name":"38","description":"39","variables":"40"},"2b5601ccc1bbe","0e6b77006c8b0","204",[],[],"HTTP/1.1 204 No Content\n",{"id":"41","name":"42","style":"43","examples":"44","description":"45","required":true,"schema":"46","explicitProperties":"47"},{"id":"48","name":"49","style":"43","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},"5d92a6a09fd2a","workspace","simple",[],"Name or ID of workspace",{"type":"65","examples":"66","$schema":"67","x-stoplight":"68"},["69","70","71","72","73","74"],"c0f651f87b0b7","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"65","examples":"75","$schema":"67","x-stoplight":"76"},["69","70","71","72","73","74"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"77","description":"78"},{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84","enum":"85"},"string",["86"],"http://json-schema.org/draft-07/schema#",{"id":"87"},"name","in","required","schema","description","title",["88"],{"id":"89"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["83","90"],"team-a","4681874a38ab5","my-username","c166ab5bec595","https"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-consumer_groups-group_name_or_id-consumers_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List all consumers in a consumer group",["17"],"a77072aba3fcd","get","/{workspace}/consumer_groups/{group_name_or_id}/consumers",["18"],{},"get-consumer_groups-group_name_or_id-consumers_with_workspace","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"consumer_groups",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],["38"],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"2b5601ccc1bbe","ad4ed5aca1f4e","200",[],["47"],"A consumer response object","7a9ed65537516","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"58","examples":"59","description":"60","required":true,"schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"58","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","key":"70","extensions":"71","description":"72","type":"73","name":"74","in":"75"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"76","path":"77","port":"78","protocol":"79"},{"id":"80","mediaType":"81","examples":"82","encodings":"83","schema":"84"},{"id":"85","mediaType":"81","examples":"86","encodings":"87","schema":"88"},"a404ed009b7a3","tags","form",["89"],"A list of tags to filter the list of resources on. Multiple tags can be concatenated using `,` to mean AND or using `/` to mean OR.",{"type":"90","examples":"91","x-stoplight":"92","$schema":"93"},["94","95","96","97","98","99"],"0d9aff7139835","workspace","simple",[],"Name or ID of workspace",{"type":"90","examples":"100","$schema":"93","x-stoplight":"101"},["97","96","102","98","94","99"],"356f0692ac58a","group_name_or_id",[],"The name or UUID of the consumer group.",{"anyOf":"103","type":"90","examples":"104","$schema":"93","x-stoplight":"105"},["97","96","102","98","94","99"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"106","description":"107"},{"default":"108","description":"109"},{"default":"110","description":"111"},{"default":"112","description":"113","enum":"114"},"555defbcf8c4b","application/json",[],[],{"type":"115","properties":"116","x-examples":"117","$schema":"93","x-stoplight":"118"},"332096b6d750d",["119","120","121"],[],{"type":"115","properties":"122","required":"123","title":"124","$schema":"93","x-stoplight":"125"},{"id":"126","value":"127","key":"128"},"string",["127"],{"explicitProperties":"129","id":"130"},"http://json-schema.org/draft-07/schema#","description","example","in","name","schema","title",["131"],{"id":"132"},"required",["133","134"],["135"],{"id":"136"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["112","137"],"object",{"data":"138","next":"139"},{"Example 1":"140","One consumer":"141","Multiple consumers":"142"},{"id":"143"},{"id":"144","key":"145","value":"146","summary":"147"},{"id":"148","key":"149","value":"150","summary":"151"},{"id":"152","key":"153","value":"154","summary":"155"},{"status":"156","message":"157"},["158","159"],"UnauthorizedError",{"id":"160"},"d9d3ac874cc99","tag1,tag2","default",["161","162","163"],"dd6c49df163cd","team-a","6f33e51acec93",{"type":"90","examples":"164"},{"type":"90","examples":"165"},"my_group","2b0acc2e65fff","https",{"type":"166","description":"167","items":"168"},{"type":"90","description":"169","examples":"170"},{"data":"171","next":null},{"data":"172","next":null},{"data":"173","next":null},"ab70985368bb5","8e7d0e67051a9","DuplicateApiKey",{"message":"147","status":401},"Duplicate API key found","5cc077d7385ac","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","d8788d1863476","NoAPIKey",{"message":"174","status":401},"No API key found",{"type":"175"},{"type":"90"},"status","message","470b68e5f0549","type","nullable","examples",["135"],["176"],"array","The data array contains consumer objects",{"type":"115","properties":"177"},"Link to the next page of results, if applicable",[null],["178","179","180"],["181"],["182","183","184"],"No API key found in request","integer","84a73fb8-50fc-44a7-a4d5-aa17728ee83f",{"created_at":"185","custom_id":"186","id":"187","tags":"188","type":"189","updated_at":"190","username":"191","username_lower":"192"},{"created_at":1719859293,"custom_id":"193","id":"194","tags":null,"type":0,"updated_at":1719859293,"username":"195","username_lower":"195"},{"created_at":1719858943,"custom_id":"196","id":"197","tags":null,"type":0,"updated_at":1719858943,"username":"198","username_lower":"198"},{"created_at":1719858965,"custom_id":"199","id":"200","tags":null,"type":0,"updated_at":1719858965,"username":"201","username_lower":"201"},{"created_at":1719859293,"custom_id":"193","id":"194","tags":null,"type":0,"updated_at":1719859293,"username":"195","username_lower":"195"},{"created_at":1719859293,"custom_id":"193","id":"194","tags":null,"type":0,"updated_at":1719859293,"username":"195","username_lower":"195"},{"created_at":1719858943,"custom_id":"196","id":"197","tags":null,"type":0,"updated_at":1719858943,"username":"198","username_lower":"198"},{"created_at":1719858965,"custom_id":"199","id":"200","tags":null,"type":0,"updated_at":1719858965,"username":"201","username_lower":"201"},{"type":"175","description":"202","examples":"203"},{"type":"90","description":"204","examples":"205"},{"type":"90","description":"206","examples":"207"},{"type":"166","description":"208","items":"209"},{"type":"175","default":0,"examples":"210"},{"type":"175","description":"211","examples":"212"},{"type":"90","description":"213","examples":"214"},{"type":"90","description":"215","examples":"216"},"consumer_id3","1cf590ba-4b23-46fa-9e8d-4296213e2ac6","consumer3","consumer_id","73b74f15-5185-4b16-a2fc-3c2fd834ba6c","consumer","consumer_id2","f9383372-7bf4-4275-8bbc-4f89d7a38a23","consumer2","Unix epoch when the resource was created.",[1719859293],"Custom ID of the consumer",["193"],"The consumer ID",["194"],"Tags associated with the consumer",{"type":"90","examples":"217"},[0],"Unix epoch when the resource was last updated.",[1719859293],"The username of the consumer",["195"],"Lowercase representation of the consumer username.",["195"],["218"],"test"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-consumer_groups-group_name_or_id-consumers_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Add a consumer to a group",["18"],"b5251156ab112","post","/{workspace}/consumer_groups/{group_name_or_id}/consumers",["19"],{},"post-consumer_groups-group_name_or_id-consumers_with_workspace","Add a consumer to a specific consumer group.\n\nIf you add a consumer to multiple groups:\n\nIf all groups are allowed by the Rate Limiting Advanced plugin, only the first group's settings will apply.\nOtherwise, whichever group is specified in the Rate Limiting Advanced plugin will be active.","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"consumer_groups",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41"},[],[],[],["42","43"],["44"],{"id":"45","url":"46","name":"47","description":"48","variables":"49"},"2b5601ccc1bbe","ca6d1645f14e4","200",[],["50"],"The object returns information about the consumer and the group","5fbd16d7612f9","401",[],["51"],"Unauthorized","f560884cde803",["52"],{"id":"53","name":"54","style":"55","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","name":"61","style":"55","examples":"62","description":"63","required":true,"schema":"64","explicitProperties":"65"},{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},{"id":"86","mediaType":"78","examples":"87","encodings":"88","schema":"89"},"75dd7f49135a3","workspace","simple",[],"Name or ID of workspace",{"type":"90","examples":"91","$schema":"92","x-stoplight":"93"},["94","95","96","97","98","99"],"d5fb2b185a36e","group_name_or_id",[],"The name or UUID of the consumer group.",{"anyOf":"100","type":"90","examples":"101","$schema":"92","x-stoplight":"102"},["94","95","96","97","98","99"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"103","description":"104"},{"default":"105","description":"106"},{"default":"107","description":"108"},{"default":"109","description":"110","enum":"111"},"5b34509b76c01","application/json",["112"],[],{"type":"113","x-examples":"114","properties":"115","$schema":"92","x-stoplight":"116"},"71217c22328a5",["117","118","119"],[],{"type":"113","properties":"120","required":"121","title":"122","$schema":"92","x-stoplight":"123"},"92f115ec1cfec",[],[],{"type":"113","properties":"124","$schema":"92","x-stoplight":"125"},"string",["126"],"http://json-schema.org/draft-07/schema#",{"id":"127"},"name","in","required","schema","description","title",["128","129"],["130"],{"id":"131"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["109","132"],{"id":"133","key":"134","value":"135"},"object",{"Example 1":"136"},{"consumer":"137","consumer_groups":"138"},{"id":"139"},{"id":"140","key":"141","value":"142","summary":"143"},{"id":"144","key":"145","value":"146","summary":"147"},{"id":"148","key":"149","value":"150","summary":"151"},{"status":"152","message":"153"},["154","155"],"UnauthorizedError",{"id":"156"},{"consumer":"157"},{"id":"158"},"team-a","59f31655ea102",{"type":"90","examples":"159"},{"type":"90","examples":"160"},"my_group","68731454ca579","https","38d719cb0b2ac","Example",{"consumer":"161","consumer_groups":"162"},{"consumer":"163","consumer_groups":"164"},{"type":"113","properties":"165"},{"type":"166","items":"167"},"23d895bd3f81a","4400a77a56324","DuplicateApiKey",{"message":"143","status":401},"Duplicate API key found","779043980e4d1","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","ea89703924f3d","NoAPIKey",{"message":"168","status":401},"No API key found",{"type":"169"},{"type":"90"},"status","message","470b68e5f0549",{"type":"90","description":"170","examples":"171"},"a63437b153ef6",["130"],["172"],{"created_at":0,"custom_id":null,"id":"90","tags":null,"type":0,"username":"90","username_lower":"90"},["173"],{"created_at":1638918560,"custom_id":null,"id":"174","tags":null,"type":0,"username":"175","username_lower":"176"},["177"],{"created_at":"178","custom_id":"179","id":"180","tags":"181","type":"182","username":"183","username_lower":"184"},"array",{"type":"113","properties":"185"},"No API key found in request","integer","The name or ID of the consumer to add to this group.\n",["186"],"84a73fb8-50fc-44a7-a4d5-aa17728ee83f",{"created_at":0,"id":"90","name":"90","tags":"187"},"288f2bfc-04e2-4ec3-b6f3-40408dff5417","BarryAllen","barryallen",{"created_at":1638918476,"id":"188","name":"189","tags":null},{"type":"169","description":"190","examples":"191"},{"type":"192","description":"193"},{"type":"90","description":"194"},{"type":"195","description":"196"},{"type":"169","default":0,"examples":"197"},{"type":"90","description":"198"},{"type":"90","description":"199"},{"created_at":"200","id":"201","name":"202","tags":"203"},"8a4bba3c-7f82-45f0-8121-ed4d2847c4a4",{"red":null},"e2c3f16e-22c7-4ef4-b6e4-ab25c522b339","JL","Unix epoch when the resource was created.",[1638918560],["90","204"],"Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or `username` with the request.","The UUID for the consumer",["113","204"],"An optional set of strings associated with consumer group for grouping and filtering.",[0],"The unique username of the Consumer. You must send either this field or `custom_id` with the request.","A lowercase representation of the username",{"type":"169","description":"190"},{"type":"90","description":"205"},{"type":"90","description":"206"},{"type":"207","description":"196"},"null","The UUID for the consumer group","The name of the consumer group",["113","204"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-consumer_groups-group_name_or_id-consumers_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Remove all consumers from a consumer group",["18"],"bdc14b4ffd064","delete","/{workspace}/consumer_groups/{group_name_or_id}/consumers",["19"],{},"delete-consumer_groups-group_name_or_id-consumers_with_workspace","Removes all consumers from a specified consumer group.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"2b5601ccc1bbe","4e748c39d9c59","204",[],[],"HTTP/1.1 204 No Content\n","f6848a5d17269","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"50","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},"4556650d3bcf8","workspace","simple",[],"Name or ID of workspace",{"type":"77","examples":"78","$schema":"79","x-stoplight":"80"},["81","82","83","84","85","86"],"cf20392a81501","group_name_or_id",[],"The name or UUID of the consumer group.",{"anyOf":"87","type":"77","examples":"88","$schema":"79","x-stoplight":"89"},["81","82","83","84","85","86"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95"},{"default":"96","description":"97","enum":"98"},"ce729abcbcf22","application/json",["99","100","101"],[],{"type":"102","properties":"103","required":"104","title":"105","$schema":"79","x-stoplight":"106"},"string",["107"],"http://json-schema.org/draft-07/schema#",{"id":"108"},"name","in","required","schema","description","title",["109","110"],["111"],{"id":"112"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["96","113"],{"id":"114","key":"115","value":"116","summary":"117"},{"id":"118","key":"119","value":"120","summary":"121"},{"id":"122","key":"123","value":"124","summary":"125"},"object",{"status":"126","message":"127"},["128","129"],"UnauthorizedError",{"id":"130"},"team-a","9dcbdf55c879a",{"type":"77","examples":"131"},{"type":"77","examples":"132"},"my_group","8140c13ad3e5a","https","6c33bf40f825d","DuplicateApiKey",{"message":"117","status":401},"Duplicate API key found","61fa7f05ad526","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","5ceeccb457ee3","NoAPIKey",{"message":"133","status":401},"No API key found",{"type":"134"},{"type":"77"},"status","message","470b68e5f0549",["111"],["135"],"No API key found in request","integer","84a73fb8-50fc-44a7-a4d5-aa17728ee83f"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-consumers-consumer_name_or_id-consumer_groups-group_name_or_id_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Remove a consumer from a consumer group",["18"],"90af367ce8d91","delete","/{workspace}/consumers/{consumer_name_or_id}/consumer_groups/{group_name_or_id}",["19"],{},"delete-consumers-consumer_name_or_id-consumer_groups-group_name_or_id_with_workspace","Removes a consumer from a consumer group. This operation does not delete the consumer group.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40","41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"2b5601ccc1bbe","169b3822b21bc","204",[],[],"HTTP/1.1 204 No Content\n","beab3645f0e0e","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","required":true,"schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"51","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},"00dd2db1f2078","workspace","simple",[],"Name or ID of workspace",{"type":"84","examples":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92","93"],"d29a07ca2dd19","consumer_name_or_id",[],"The name or UUID of the consumer to remove.",{"type":"84","$schema":"86","x-stoplight":"94"},["88","89","90","91","92","93"],"9b4e785e7cbc9","group_name_or_id",[],"The name or UUID of the consumer group.",{"anyOf":"95","type":"84","examples":"96","$schema":"86","x-stoplight":"97"},["88","89","90","91","92","93"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"98","description":"99"},{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105","enum":"106"},"2a4b0a256e233","application/json",["107","108","109"],[],{"type":"110","properties":"111","required":"112","title":"113","$schema":"86","x-stoplight":"114"},"string",["115"],"http://json-schema.org/draft-07/schema#",{"id":"116"},"name","in","required","schema","description","title",{"id":"117"},["118","119"],["120"],{"id":"121"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["104","122"],{"id":"123","key":"124","value":"125","summary":"126"},{"id":"127","key":"128","value":"129","summary":"130"},{"id":"131","key":"132","value":"133","summary":"134"},"object",{"status":"135","message":"136"},["137","138"],"UnauthorizedError",{"id":"139"},"team-a","72b5938adf94e","f731e2b71dc8b",{"type":"84","examples":"140"},{"type":"84","examples":"141"},"my_group","ddf5d51561f35","https","5d7c90baa26f0","DuplicateApiKey",{"message":"126","status":401},"Duplicate API key found","c56d6fc5209c8","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","2a956ed0ac386","NoAPIKey",{"message":"142","status":401},"No API key found",{"type":"143"},{"type":"84"},"status","message","470b68e5f0549",["120"],["144"],"No API key found in request","integer","84a73fb8-50fc-44a7-a4d5-aa17728ee83f"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-consumer_groups-group_name_or_id-consumers-consumer_name_or_id_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Remove a consumer from a consumer group",["18"],"c4ca8cc4a7128","delete","/{workspace}/consumer_groups/{group_name_or_id}/consumers/{consumer_username_or_id}",["19"],{},"delete-consumer_groups-group_name_or_id-consumers-consumer_name_or_id_with_workspace","The consumer groups endpoint for removing a consumer from a specified consumer group.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40","41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"2b5601ccc1bbe","02fa0c8ad9c14","204",[],[],"HTTP/1.1 204 No Content\n","d00a0d336fb3f","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","required":true,"schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"51","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},"438dce4b358a7","workspace","simple",[],"Name or ID of workspace",{"type":"84","examples":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92","93"],"34c4a7ce5e51d","group_name_or_id",[],"The name or UUID of the consumer group.",{"anyOf":"94","type":"84","examples":"95","$schema":"86","x-stoplight":"96"},["88","89","90","91","92","93"],"b769fdb9592c2","consumer_username_or_id",[],"The unique identifier or the username of the Consumer to retrieve.",{"type":"84","examples":"97","$schema":"86","x-stoplight":"98"},["88","89","90","91","92","93"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"99","description":"100"},{"default":"101","description":"102"},{"default":"103","description":"104"},{"default":"105","description":"106","enum":"107"},"13876874026b0","application/json",["108","109","110"],[],{"type":"111","properties":"112","required":"113","title":"114","$schema":"86","x-stoplight":"115"},"string",["116"],"http://json-schema.org/draft-07/schema#",{"id":"117"},"name","in","required","schema","description","title",["118","119"],["120"],{"id":"121"},["122"],{"id":"123"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["105","124"],{"id":"125","key":"126","value":"127","summary":"128"},{"id":"129","key":"130","value":"131","summary":"132"},{"id":"133","key":"134","value":"135","summary":"136"},"object",{"status":"137","message":"138"},["139","140"],"UnauthorizedError",{"id":"141"},"team-a","b5c807297a753",{"type":"84","examples":"142"},{"type":"84","examples":"143"},"my_group","0ab0fc1c445ca","my-username","aa04e56fb1e08","https","2f6f80da1f2a7","DuplicateApiKey",{"message":"128","status":401},"Duplicate API key found","a08bf3758e220","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","ce684a5bb29bd","NoAPIKey",{"message":"144","status":401},"No API key found",{"type":"145"},{"type":"84"},"status","message","470b68e5f0549",["120"],["146"],"No API key found in request","integer","84a73fb8-50fc-44a7-a4d5-aa17728ee83f"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/put-consumer_groups-group_name_or_id-overrides-plugins-rate-limiting-advanced_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Configure rate limiting for a consumer group.",["18"],"50f5c956d94bd","put","/{workspace}/consumer_groups/{group_name_or_id}/overrides/plugins/rate-limiting-advanced",["19"],{},"put-consumer_groups-group_name_or_id-overrides-plugins-rate-limiting-advanced_with_workspace","Define custom rate limiting settings for a consumer group. This endpoint overrides the settings of the Rate Limiting Advanced plugin. As of Kong Gateway 3.4, you can scope plugins to consumer groups using only the `/consumer_groups` endpoint. Using `overrides` is deprecated, and no longer recommended.\n'401': \n $ref: '#/components/responses/HTTP401Error'\n","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35","description":"36"},[],[],[],["37","38"],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"2b5601ccc1bbe","13141ab4124ca","201",[],["45"],"Created","e2bb6d0962ae3",["46"],"Request Body\n",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","name":"55","style":"49","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","key":"61","extensions":"62","description":"63","type":"64","name":"65","in":"66"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"67","path":"68","port":"69","protocol":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},{"id":"76","mediaType":"72","examples":"77","encodings":"78","schema":"79"},"559ca9fcec584","workspace","simple",[],"Name or ID of workspace",{"type":"80","examples":"81","$schema":"82","x-stoplight":"83"},["84","85","86","87","88","89"],"b114294e9cbb4","group_name_or_id",[],"The name or UUID of the consumer group.",{"anyOf":"90","type":"80","examples":"91","$schema":"82","x-stoplight":"92"},["84","85","86","87","88","89"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98"},{"default":"99","description":"100","enum":"101"},"b5802b44b0ba5","application/json",["102"],[],{"type":"103","x-examples":"104","properties":"105","$schema":"82","x-stoplight":"106"},"4420482883db5",["107"],[],{"type":"103","properties":"108","required":"109","$schema":"82","x-stoplight":"110"},"string",["111"],"http://json-schema.org/draft-07/schema#",{"id":"112"},"name","in","required","schema","description","title",["113","114"],["115"],{"id":"116"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["99","117"],{"id":"118","key":"119","value":"120"},"object",{"Example 1":"121"},{"config":"122","group":"123","plugin":"124"},{"id":"125"},{"id":"126","key":"127","value":"128"},{"config.limit":"129","config.window_size":"130","config.window_type":"131","config.retry_after_jitter_max":"132"},["133","134"],{"id":"135"},"team-a","9814b1f01d82d",{"type":"80","examples":"136"},{"type":"80","examples":"137"},"my_group","f1701f2bb3c50","https","951ae2fa00453","Example ",{"config":"138","group":"139","plugin":"140"},{"config":"141","group":"139","plugin":"140"},{"type":"103","properties":"142"},{"type":"80","description":"143","examples":"144"},{"type":"80","description":"145","examples":"146"},"e4fd464be204f","c407815d7e6d1","Request body",{"config.limit":"80","config.window_size":"147","config.window_type":"148","config.retry_after_jitter_max":"80"},{"type":"80","description":"149"},{"type":"80","description":"150","examples":"151"},{"type":"80","description":"152","default":"148","enum":"153"},{"type":"80","description":"154"},"config.limit","config.window_size","48454285dac69",["115"],["155"],{"limit":"156","retry_after_jitter_max":0,"window_size":"157","window_type":"148"},"test-group","rate-limiting-advanced",{"limit":"158","retry_after_jitter_max":0,"window_size":"159","window_type":"148"},{"limit":"160","retry_after_jitter_max":"161","window_size":"162","window_type":"163"},"The consumer group",["139"],"The name of the plugin",["140"]," 10","sliding","An array of one or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.\n","An array of one or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.\n",["147"],"Set the time window type to either sliding (default) or fixed.\n",["148","164"],"The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.","84a73fb8-50fc-44a7-a4d5-aa17728ee83f",[10],[10],[10],[10],{"type":"165","description":"166","items":"167"},{"type":"168","description":"169"},{"type":"165","description":"150","items":"170"},{"type":"80","description":"152","examples":"171"},"fixed","array","An array of one or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified. \n",{"type":"168","examples":"172"},"integer","The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.\n",{"type":"168","examples":"173"},["148"],[10],[10]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-consumer_groups-group_name_or_id-overrides-plugins-rate-limiting-advanced_with_workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete the configurations for a consumer group",["18"],"f608d9057c406","delete","/{workspace}/consumer_groups/{group_name_or_id}/overrides/plugins/rate-limiting-advanced",["19"],{},"delete-consumer_groups-group_name_or_id-overrides-plugins-rate-limiting-advanced_with_workspace","Delete custom rate limiting settings for a consumer group. As of Kong Gateway 3.4, you can scope plugins to consumer groups using only the `/consumer_groups` endpoint. Using `overrides` is deprecated, and no longer recommended.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"consumer_groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"2b5601ccc1bbe","7049283b187df","204",[],[],"HTTP/1.1 204 No Content\n","db1927a9a9f42","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"50","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},"da675a6e434cd","workspace","simple",[],"Name or ID of workspace",{"type":"77","examples":"78","$schema":"79","x-stoplight":"80"},["81","82","83","84","85","86"],"52ada8f7c4157","group_name_or_id",[],"The name or UUID of the consumer group.",{"anyOf":"87","type":"77","examples":"88","$schema":"79","x-stoplight":"89"},["81","82","83","84","85","86"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95"},{"default":"96","description":"97","enum":"98"},"686df76820ebd","application/json",["99","100","101"],[],{"type":"102","properties":"103","required":"104","title":"105","$schema":"79","x-stoplight":"106"},"string",["107"],"http://json-schema.org/draft-07/schema#",{"id":"108"},"name","in","required","schema","description","title",["109","110"],["111"],{"id":"112"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["96","113"],{"id":"114","key":"115","value":"116","summary":"117"},{"id":"118","key":"119","value":"120","summary":"121"},{"id":"122","key":"123","value":"124","summary":"125"},"object",{"status":"126","message":"127"},["128","129"],"UnauthorizedError",{"id":"130"},"team-a","23bc0f2105e6c",{"type":"77","examples":"131"},{"type":"77","examples":"132"},"my_group","dce02d8e815e6","https","bfa0d2882dfe1","DuplicateApiKey",{"message":"117","status":401},"Duplicate API key found","e4ef4c132c16f","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","b813bde4fe316","NoAPIKey",{"message":"133","status":401},"No API key found",{"type":"134"},{"type":"77"},"status","message","470b68e5f0549",["111"],["135"],"No API key found in request","integer","84a73fb8-50fc-44a7-a4d5-aa17728ee83f"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/geInfo",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Get Kong's instance information",["18"],"588efafda9946","get","/",["19"],{},"geInfo","Returns detailed information about the Kong gateway instance, including the full Kong configuration, available and unavailable plugins, version, edition (enterprise or community), a tagline, the unique node identifier, and other metadata.\n","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Information",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],[],["45"],{"id":"46","url":"47","name":"48","description":"49","variables":"50"},"851391bf560a6","adc5e0a6a2a05","200",[],["51"],"Success","05d5e2836485f","401",[],["52"],"Unauthorized","0595e2836330b","405",["53"],["54"],"Method Not Allowed",{"id":"55","key":"56","extensions":"57","description":"58","type":"59","name":"60","in":"61"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"62","path":"63","port":"64","protocol":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},{"id":"75","name":"76","style":"77","schema":"78","description":"79","encodings":"80","examples":"81"},{"id":"82","mediaType":"67","examples":"83","encodings":"84","schema":"74"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"85","description":"86"},{"default":"8","description":"87"},{"default":"88","description":"89"},{"default":"90","description":"91","enum":"92"},"24c4c7ef3c775","application/json",["93"],[],{"type":"94","properties":"95","$schema":"96","x-stoplight":"97"},"630fd3ba62f0e",["98","99","100"],[],{"type":"94","properties":"101","required":"102","title":"103","$schema":"96","x-stoplight":"104"},"1ddff310ed691","Server","simple",{"type":"105","examples":"106","$schema":"96","x-stoplight":"107"},"Kong's server tokens.",[],[],"36f34fe585af6",[],[],"localhost","Hostname for Kong's Admin API","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["90","108"],{"id":"109","key":"110","value":"111","summary":"112"},"object",{"version":"113","edition":"114","tagline":"115","node_id":"116","hostname":"117","timers":"118","plugins":"119","lua_version":"120","configuration":"121","pids":"122"},"http://json-schema.org/draft-07/schema#",{"id":"123"},{"id":"124","key":"125","value":"126","summary":"127"},{"id":"128","key":"129","value":"130","summary":"131"},{"id":"132","key":"133","value":"134","summary":"135"},{"status":"136","message":"137"},["138","139"],"UnauthorizedError",{"id":"140"},"string",["141"],{"id":"142"},"https","1fef8decbeed0","fullExample",{"configuration":"143","edition":"144","hostname":"145","lua_version":"146","node_id":"147","pids":"148","plugins":"149","tagline":"150","timers":"151","version":"152"},"Example response",{"type":"105","description":"153","examples":"154"},{"type":"105","description":"155","examples":"156"},{"type":"105","description":"157","examples":"158"},{"type":"105","description":"159","format":"160","examples":"161"},{"type":"105","description":"162","examples":"163"},{"type":"94","description":"164","properties":"165"},{"type":"94","description":"166","properties":"167"},{"type":"105","description":"168","examples":"169"},{"type":"94","description":"170","additionalProperties":true},{"type":"94","description":"171","properties":"172"},"59151b88e5786","7ad26637220ff","DuplicateApiKey",{"message":"127","status":401},"Duplicate API key found","761a377ee84ba","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","d1a236d1b8a63","NoAPIKey",{"message":"173","status":401},"No API key found",{"type":"174"},{"type":"105"},"status","message","470b68e5f0549","kong/2.3.3","365169ade1b6c",{"_debug_pg_ttl_cleanup_interval":300,"admin_acc_logs":"175","admin_access_log":"176","admin_approved_email":"177","admin_emails_from":"178","admin_error_log":"179","admin_gui_access_log":"180","admin_gui_auth_header":"181","admin_gui_auth_login_attempts":0,"admin_gui_error_log":"182","admin_gui_flags":"183","admin_gui_listen":"184","admin_gui_origin":"185"},"enterprise","8a487998603b","LuaJIT 2.1.0-20231117","1f257156-5e44-46e2-a618-767f5c7529e3",{"master":1,"workers":"186"},{"available_on_server":"187","disabled_on_server":"188","enabled_in_cluster":"189"},"Welcome to kong",{"pending":1,"running":1128},"3.6.0.0","The version number of the Kong instance.",["190"],"Indicates whether the Kong instance is the Community or Enterprise edition.",["144"],"A tagline or slogan for the Kong instance.",["191"],"A unique identifier for the node, in UUID format.","uuid",["192"],"The hostname of the Kong node.",["193"],"Information about running and pending timers.",{"running":"194","pending":"195"},"Information about plugins.",{"available_on_server":"196","enabled_in_cluster":"197"},"The version of Lua used by the Kong instance.",["198"],"A sanitized version of the Kong configuration, excluding sensitive values.","Process IDs for the master process and worker processes.",{"master":"199","workers":"200"},"No API key found in request","integer","/usr/local/kong/logs/admin_access.log","/dev/stdout","true","\"\"","/dev/stderr","logs/admin_gui_access.log","******","logs/admin_gui_error.log","{}",["201","202"],"http://localhost:8002",[2382,2383],{"acl":true,"acme":true},{"application-registration":true},[],"2.3.3","Welcome to Kong","a74d7c4f-ef83-4bbe-a5e7-3f5409f4a0b9","kong-node.example.com",{"type":"174","description":"203","examples":"204"},{"type":"174","description":"205","examples":"206"},{"type":"94","additionalProperties":"207"},{"type":"208","items":"209","description":"210","examples":"211"},"LuaJIT 2.1.0-beta3",{"type":"174","description":"212","examples":"213"},{"type":"208","items":"214","description":"215","examples":"216"},"0.0.0.0:8002","0.0.0.0:8445 ssl","The number of running timers.",[5],"The number of pending timers.",[2],{"type":"94","properties":"217"},"array",{"type":"105"},"A list of distinct plugin names enabled in the cluster.",["218"],"The PID of the master process.",[4321],{"type":"174"},"An array of worker process PIDs.",["219"],{"version":"220","priority":"221"},["222","223"],[1234,5678],{"type":"105","description":"224"},{"type":"174","description":"225"},"jwt","acl","The version of the plugin.","The priority of the plugin."]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-endpoints",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all endpoints",["18"],"53ab218a88c13","get","/endpoints",["19"],{},"get-endpoints","List all available endpoints provided by the Admin API.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Information",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"851391bf560a6","45cc959fdebaa","200",[],["45"],"Example response","ed9c93c31b7d8","401",[],["46"],"Unauthorized",{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},{"id":"63","mediaType":"59","examples":"64","encodings":"65","schema":"66"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"2482c10b274c4","application/json",["76"],[],{"type":"77","properties":"78","x-examples":"79","$schema":"80","x-stoplight":"81"},"76a235fdc83e2",["82","83","84"],[],{"type":"77","properties":"85","required":"86","title":"87","$schema":"80","x-stoplight":"88"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","89"],{"id":"90","key":"91","value":"92"},"object",{"data":"93"},{"Example 1":"94"},"http://json-schema.org/draft-07/schema#",{"id":"95"},{"id":"96","key":"97","value":"98","summary":"99"},{"id":"100","key":"101","value":"102","summary":"103"},{"id":"104","key":"105","value":"106","summary":"107"},{"status":"108","message":"109"},["110","111"],"UnauthorizedError",{"id":"112"},"https","b267ec4e6985c","Get all endpoints",{"data":"113"},{"type":"114","items":"115"},{"data":"116"},"d7c3175cec25e","ef2d52f57c38f","DuplicateApiKey",{"message":"99","status":401},"Duplicate API key found","cad39d3cffb2e","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","ce375cdf71f98","NoAPIKey",{"message":"117","status":401},"No API key found",{"type":"118"},{"type":"119"},"status","message","470b68e5f0549",["69","120","121","122","123","124","125","126","127","128","129","130","131","132","133","134","135","136","137","138","139","140","141","142","143","144","145","146","147","148","149","150","151","152","153","154","155","156","157","158","159","160","161","162","163","164","165","166","167","168","169","170","171","172","173","174","175","176","177","178","179","180","181","182","183","184","185","186","187","188","189","190","191","192","193","194","195","196","197","198","199","200","201","202","203","204","205","206","207","208","209","210","211","212","213","214","215","216","217","218","219","220","221","222","223","224","225","226","227","228","229","230","231","232","233","234","235","8","236","237","238","239","240","241","242","243","244","245","246","247","248","249","250","251","252","253","254","255","256","257","258","259","260","261","262","263","264","265","266","267","268","269","270","271","272","273","274","275","276","277","278","279","280","281","282","283","284","285","286","287","288","289","290","291","292","293","294","295","296","297","298","299","300","301","302","303","304","305","306","307","308","309","310","311","312","313","314","315","316","317","318","319","320","321","322","323","324","325","326","327","328","329","330","331","332","333","334","335","336","337","338","339","340","341","342","343","344","345","346","347","348","349","350","351","352","353","354","355","356","357","358","359","360","361","362","363","364","365","366","367","368","369","370","371","372","373","374","375","376","377","378","379","380","381","382","383","384","385","386","387","388","389","390","391","392","393","394","395","396","397","398","399","400","401","402","403","404","405","406","407","408","409","410","411","412","413","414","415","416","417","418","419","420","421","422","423","424","425","426","427","428","429","430","431","432","433","434","435","436","437","438","439","440","441","442","443","444","445","446","447","448","449","450","451","452","453","454","455","456","457","458","459","460","461","462","463","464","465","466","467","468","469","470","471","472","473","474","475","476","477","478","479","480","481","482","483","484","485","486","487","488","489","490","491","492","493","494","495","496","497","498","499","500","501","502","503","504","505","506","507","508","509","510","511","512","513","514","515","516","517","518","519","520","521","522","523","524","525","526","527","528","529","530","531","532","533","534","535","536","537","538","539","540","541","542","543","544","545","546","547","548","549","550","551","552","553","554","555","556","557","558","559","560","561","562","563","564","565","566","567","568","569","570","571","572","573","574","575","576","577","578","579","580","581","582","583","584","585","586","587","588","589","590","591","592","593","594","595","596","597","598","599","600","601","602","603","604","605","606","607","608","609","610","611","612","613","614","615","616","617","618","619","620","621","622","623","624","625","626","627","628","629","630","631","632","633","634","635","636","637","638","639","640","641","642","643","644","645","646","647","648","649","650","651","652","653","654","655","656","657","658","659","660","661","662","663","664","665","666","667","668","669","670","671","672","673","674","675","676","677","678","679","680","681","682","683","684","685","686","687","688","689","690","691","692","693","694","695","696","697","698","699","700","701","702","703","704","705","706","707","708","709","710","711","712","713","714","715","716","717","718","719","720","721","722","723","724","725","726","727","728","729","730","731","732","733","734","735","736","737","738","739","740","741","742","743","744","745","746","747","748","749","750","751","752","753"],"array",{"type":"119"},["69","120","121","122","123","124","125","126","127","128","129","130","131","132","133","134","135","136","137","138","139","140","141","142","143","144","145","146","147","148","149","150","151","152","153","154","155","156","157","158","159","160","161","162","163","164","165","166","167","168","169","170","171","172","173","174","175","176","177","178","179","180","181","182","183","184","185","186","187","188","189","190","191","192","193","194","195","196","197","198","199","200","201","202","203","204","205","206","207","208","209","210","211","212","213","214","215","216","217","218","219","220","221","222","223","224","225","226","227","228","229","230","231","232","233","234","235","8","236","237","238","239","240","241","242","243","244","245","246","247","248","249","250","251","252","253","254","255","256","257","258","259","260","261","262","263","264","265","266","267","268","269","270","271","272","273","274","275","276","277","278","279","280","281","282","283","284","285","286","287","288","289","290","291","292","293","294","295","296","297","298","299","300","301","302","303","304","305","306","307","308","309","310","311","312","313","314","315","316","317","318","319","320","321","322","323","324","325","326","327","328","329","330","331","332","333","334","335","336","337","338","339","340","341","342","343","344","345","346","347","348","349","350","351","352","353","354","355","356","357","358","359","360","361","362","363","364","365","366","367","368","369","370","371","372","373","374","375","376","377","378","379","380","381","382","383","384","385","386","387","388","389","390","391","392","393","394","395","396","397","398","399","400","401","402","403","404","405","406","407","408","409","410","411","412","413","414","415","416","417","418","419","420","421","422","423","424","425","426","427","428","429","430","431","432","433","434","435","436","437","438","439","440","441","442","443","444","445","446","447","448","449","450","451","452","453","454","455","456","457","458","459","460","461","462","463","464","465","466","467","468","469","470","471","472","473","474","475","476","477","478","479","480","481","482","483","484","485","486","487","488","489","490","491","492","493","494","495","496","497","498","499","500","501","502","503","504","505","506","507","508","509","510","511","512","513","514","515","516","517","518","519","520","521","522","523","524","525","526","527","528","529","530","531","532","533","534","535","536","537","538","539","540","541","542","543","544","545","546","547","548","549","550","551","552","553","554","555","556","557","558","559","560","561","562","563","564","565","566","567","568","569","570","571","572","573","574","575","576","577","578","579","580","581","582","583","584","585","586","587","588","589","590","591","592","593","594","595","596","597","598","599","600","601","602","603","604","605","606","607","608","609","610","611","612","613","614","615","616","617","618","619","620","621","622","623","624","625","626","627","628","629","630","631","632","633","634","635","636","637","638","639","640","641","642","643","644","645","646","647","648","649","650","651","652","653","654","655","656","657","658","659","660","661","662","663","664","665","666","667","668","669","670","671","672","673","674","675","676","677","678","679","680","681","682","683","684","685","686","687","688","689","690","691","692","693","694","695","696","697","698","699","700","701","702","703","704","705","706","707","708","709","710","711","712","713","714","715","716","717","718","719","720","721","722","723","724","725","726","727","728","729","730","731","732","733","734","735","736","737","738","739","740","741","742","743","744","745","746","747","748","749","750","751","752","753"],"No API key found in request","integer","string","/acls","/acls/{acls}","/acls/{acls}/consumer","/acme","/acme/certificates","/acme/certificates/{certificates}","/acme_storage","/acme_storage/{acme_storage}","/admins","/admins/password_resets","/admins/register","/admins/self/password","/admins/self/token","/admins/{admins}","/admins/{admins}/consumer","/admins/{admins}/rbac_user","/admins/{admin}/roles","/admins/{admin}/workspaces","/applications","/applications/{applications}","/applications/{applications}/application_instances","/applications/{applications}/application_instances/{application_instances}","/applications/{applications}/consumer","/applications/{applications}/credentials/{plugin}","/applications/{applications}/credentials/{plugin}/{credential_id}","/applications/{applications}/developer","/auth","/basic-auths","/basic-auths/{basicauth_credentials}","/basic-auths/{basicauth_credentials}/consumer","/ca_certificates","/ca_certificates/{ca_certificates}","/ca_certificates/{ca_certificates}/mtls_auth_credentials","/ca_certificates/{ca_certificates}/mtls_auth_credentials/{mtls_auth_credentials}","/cache","/cache/{key}","/certificates","/certificates/{certificates}","/certificates/{certificates}/services","/certificates/{certificates}/services/{services}","/certificates/{certificates}/snis","/certificates/{certificates}/snis/{snis}","/certificates/{certificates}/upstreams","/certificates/{certificates}/upstreams/{upstreams}","/clustering/data-planes","/clustering/status","/config","/consumer_groups","/consumer_groups/{consumer_groups}","/consumer_groups/{consumer_groups}/consumers","/consumer_groups/{consumer_groups}/consumers/{consumers}","/consumer_groups/{consumer_groups}/overrides/plugins/rate-limiting-advanced","/consumer_groups/{consumer_groups}/plugins","/consumer_groups/{consumer_groups}/plugins/{plugins}","/consumers","/consumers/{consumers}","/consumers/{consumers}/acls","/consumers/{consumers}/acls/{acls}","/consumers/{consumers}/admins","/consumers/{consumers}/admins/{admins}","/consumers/{consumers}/applications","/consumers/{consumers}/applications/{applications}","/consumers/{consumers}/basic-auth","/consumers/{consumers}/basic-auth/{basicauth_credentials}","/consumers/{consumers}/consumer_groups","/consumers/{consumers}/consumer_groups/{consumer_groups}","/consumers/{consumers}/developers","/consumers/{consumers}/developers/{developers}","/consumers/{consumers}/hmac-auth","/consumers/{consumers}/hmac-auth/{hmacauth_credentials}","/consumers/{consumers}/jwt","/consumers/{consumers}/jwt/{jwt_secrets}","/consumers/{consumers}/key-auth","/consumers/{consumers}/key-auth/{keyauth_credentials}","/consumers/{consumers}/key-auth-enc","/consumers/{consumers}/key-auth-enc/{keyauth_enc_credentials}","/consumers/{consumers}/login_attempts","/consumers/{consumers}/login_attempts/{login_attempts}","/consumers/{consumers}/mtls-auth","/consumers/{consumers}/mtls-auth/{mtls_auth_credentials}","/consumers/{consumers}/mtls_auth_credentials","/consumers/{consumers}/mtls_auth_credentials/{mtls_auth_credentials}","/consumers/{consumers}/oauth2","/consumers/{consumers}/oauth2/{oauth2_credentials}","/consumers/{consumers}/plugins","/consumers/{consumers}/plugins/{plugins}","/debug/cluster/log-level/{log_level}","/debug/node/log-level","/debug/node/log-level/{log_level}","/debug/profiling/cpu","/debug/profiling/gc-snapshot","/debug/profiling/memory","/degraphql_routes","/degraphql_routes/{degraphql_routes}","/degraphql_routes/{degraphql_routes}/service","/developers","/developers/export","/developers/invite","/developers/roles","/developers/roles/{rbac_roles}","/developers/{developers}","/developers/{developers}/applications","/developers/{developers}/applications/{applications}","/developers/{developers}/applications/{applications}/application_instances","/developers/{developers}/applications/{applications}/application_instances/{application_instances}","/developers/{developers}/applications/{applications}/credentials/{plugin}","/developers/{developers}/applications/{applications}/credentials/{plugin}/{credential_id}","/developers/{developers}/consumer","/developers/{developers}/credentials/{plugin}","/developers/{developers}/credentials/{plugin}/{credential_id}","/developers/{developers}/rbac_user","/developers/{email_or_id}/plugins/","/developers/{email_or_id}/plugins/{id}","/document_objects","/document_objects/{document_objects}","/document_objects/{document_objects}/service","/entities/migrate","/event-hooks","/event-hooks/sources","/event-hooks/sources/{source}","/event-hooks/sources/{source}/{event}","/event-hooks/{event_hooks}","/event-hooks/{event_hooks}/ping","/event-hooks/{event_hooks}/test","/files","/files/*","/files/partials/*","/files/{files}","/filter-chains","/filter-chains/{filter_chains}","/filter-chains/{filter_chains}/route","/filter-chains/{filter_chains}/service","/graphql-proxy-cache-advanced","/graphql-proxy-cache-advanced/{cache_key}","/graphql-proxy-cache-advanced/{plugin_id}/caches/{cache_key}","/graphql-rate-limiting-advanced/costs","/graphql-rate-limiting-advanced/costs/{graphql_ratelimiting_advanced_cost_decoration}","/graphql_ratelimiting_advanced_cost_decoration","/graphql_ratelimiting_advanced_cost_decoration/{graphql_ratelimiting_advanced_cost_decoration}","/graphql_ratelimiting_advanced_cost_decoration/{graphql_ratelimiting_advanced_cost_decoration}/service","/groups","/groups/{groups}","/groups/{groups}/roles","/hmac-auths","/hmac-auths/{hmacauth_credentials}","/hmac-auths/{hmacauth_credentials}/consumer","/jwt-signer/jwks","/jwt-signer/jwks/{jwt_signer_jwks}","/jwt-signer/jwks/{jwt_signer_jwks}/rotate","/jwts","/jwts/{jwt_secrets}","/jwts/{jwt_secrets}/consumer","/key-auths","/key-auths/{keyauth_credentials}","/key-auths/{keyauth_credentials}/consumer","/key-auths-enc","/key-auths-enc/{keyauth_enc_credentials}","/key-auths-enc/{keyauth_enc_credentials}/consumer","/key-sets","/key-sets/{key_sets}","/key-sets/{key_sets}/keys","/key-sets/{key_sets}/keys/{keys}","/keyring","/keyring/activate","/keyring/active","/keyring/export","/keyring/generate","/keyring/import","/keyring/import/raw","/keyring/recover","/keyring/remove","/keyring/vault/sync","/keys","/keys/{keys}","/keys/{keys}/set","/konnect_applications","/konnect_applications/{konnect_applications}","/license/report","/licenses","/licenses/{licenses}","/login_attempts","/login_attempts/{login_attempts}","/login_attempts/{login_attempts}/consumer","/metrics","/mtls-auths","/mtls-auths/{mtls_auth_credentials}/consumer","/mtls_auth_credentials","/mtls_auth_credentials/{mtls_auth_credentials}","/mtls_auth_credentials/{mtls_auth_credentials}/ca_certificate","/mtls_auth_credentials/{mtls_auth_credentials}/consumer","/oauth2","/oauth2/{oauth2_credentials}","/oauth2/{oauth2_credentials}/consumer","/oauth2/{oauth2_credentials}/oauth2_tokens","/oauth2/{oauth2_credentials}/oauth2_tokens/{oauth2_tokens}","/oauth2_tokens","/oauth2_tokens/{oauth2_tokens}","/oauth2_tokens/{oauth2_tokens}/credential","/oauth2_tokens/{oauth2_tokens}/service","/openid-connect/issuers","/openid-connect/issuers/{oic_issuers}","/openid-connect/jwks","/plugins","/plugins/enabled","/plugins/schema/{name}","/plugins/{plugins}","/plugins/{plugins}/consumer","/plugins/{plugins}/consumer_group","/plugins/{plugins}/route","/plugins/{plugins}/service","/proxy-cache","/proxy-cache/{cache_key}","/proxy-cache/{plugin_id}/caches/{cache_key}","/proxy-cache-advanced","/proxy-cache-advanced/{cache_key}","/proxy-cache-advanced/{plugin_id}/caches/{cache_key}","/rbac/roles","/rbac/roles/{rbac_roles}","/rbac/roles/{rbac_roles}/endpoints","/rbac/roles/{rbac_roles}/endpoints/permissions","/rbac/roles/{rbac_roles}/endpoints/{workspace}/*","/rbac/roles/{rbac_roles}/entities","/rbac/roles/{rbac_roles}/entities/permissions","/rbac/roles/{rbac_roles}/entities/{entity_id}","/rbac/roles/{rbac_roles}/permissions","/rbac/users","/rbac/users/{rbac_users}","/rbac/users/{rbac_users}/admins","/rbac/users/{rbac_users}/admins/{admins}","/rbac/users/{rbac_users}/developers","/rbac/users/{rbac_users}/developers/{developers}","/rbac/users/{rbac_users}/permissions","/rbac/users/{rbac_users}/roles","/routes","/routes/{routes}","/routes/{routes}/filter-chains","/routes/{routes}/filter-chains/{filter_chains}","/routes/{routes}/filters/all","/routes/{routes}/filters/disabled","/routes/{routes}/filters/enabled","/routes/{routes}/plugins","/routes/{routes}/plugins/{plugins}","/routes/{routes}/service","/schemas/plugins/validate","/schemas/plugins/{name}","/schemas/{db_entity_name}/validate","/schemas/{name}","/services","/services/{services}","/services/{services}/application_instances","/services/{services}/application_instances/{application_instances}","/services/{services}/applications","/services/{services}/client_certificate","/services/{services}/degraphql/routes","/services/{services}/degraphql/routes/{degraphql_routes}","/services/{services}/degraphql_routes","/services/{services}/degraphql_routes/{degraphql_routes}","/services/{services}/document_objects","/services/{services}/document_objects/{document_objects}","/services/{services}/filter-chains","/services/{services}/filter-chains/{filter_chains}","/services/{services}/graphql-rate-limiting-advanced/costs","/services/{services}/graphql_ratelimiting_advanced_cost_decoration","/services/{services}/graphql_ratelimiting_advanced_cost_decoration/{graphql_ratelimiting_advanced_cost_decoration}","/services/{services}/oauth2_tokens","/services/{services}/oauth2_tokens/{oauth2_tokens}","/services/{services}/plugins","/services/{services}/plugins/{plugins}","/services/{services}/routes","/services/{services}/routes/{routes}","/sessions","/sessions/{sessions}","/snis","/snis/{snis}","/snis/{snis}/certificate","/status","/tags","/tags/{tags}","/targets","/targets/{targets}","/targets/{targets}/upstream","/timers","/upstreams","/upstreams/{upstreams}","/upstreams/{upstreams}/client_certificate","/upstreams/{upstreams}/health","/upstreams/{upstreams}/targets","/upstreams/{upstreams}/targets/all","/upstreams/{upstreams}/targets/{targets}","/upstreams/{upstreams}/targets/{targets}/healthy","/upstreams/{upstreams}/targets/{targets}/unhealthy","/upstreams/{upstreams}/targets/{targets}/{address}/healthy","/upstreams/{upstreams}/targets/{targets}/{address}/unhealthy","/userinfo","/vault-auth","/vault-auth/{vault_auth_vaults}","/vault-auth/{vault}/credentials","/vault-auth/{vault}/credentials/token/{access_token}","/vault-auth/{vault}/credentials/{consumer}","/vaults","/vaults/{vaults}","/vitals/","/vitals/cluster","/vitals/cluster/status_codes","/vitals/consumers/{consumer_id}/cluster","/vitals/nodes/","/vitals/nodes/{node_id}","/vitals/reports/{entity_type}","/vitals/status_code_classes","/vitals/status_codes/by_consumer","/vitals/status_codes/by_consumer_and_route","/vitals/status_codes/by_route","/vitals/status_codes/by_service","/workspaces","/workspaces/{workspaces}","/workspaces/{workspaces}/meta","/{workspace_name}/kong","workspace_/acls","workspace_/acls/{acls}","workspace_/acls/{acls}/consumer","workspace_/acme","workspace_/acme/certificates","workspace_/acme/certificates/{certificates}","workspace_/acme_storage","workspace_/acme_storage/{acme_storage}","workspace_/admins","workspace_/admins/password_resets","workspace_/admins/register","workspace_/admins/self/password","workspace_/admins/self/token","workspace_/admins/{admins}","workspace_/admins/{admins}/consumer","workspace_/admins/{admins}/rbac_user","workspace_/admins/{admin}/roles","workspace_/admins/{admin}/workspaces","workspace_/applications","workspace_/applications/{applications}","workspace_/applications/{applications}/application_instances","workspace_/applications/{applications}/application_instances/{application_instances}","workspace_/applications/{applications}/consumer","workspace_/applications/{applications}/credentials/{plugin}","workspace_/applications/{applications}/credentials/{plugin}/{credential_id}","workspace_/applications/{applications}/developer","workspace_/auth","workspace_/basic-auths","workspace_/basic-auths/{basicauth_credentials}","workspace_/basic-auths/{basicauth_credentials}/consumer","workspace_/ca_certificates","workspace_/ca_certificates/{ca_certificates}","workspace_/ca_certificates/{ca_certificates}/mtls_auth_credentials","workspace_/ca_certificates/{ca_certificates}/mtls_auth_credentials/{mtls_auth_credentials}","workspace_/cache","workspace_/cache/{key}","workspace_/certificates","workspace_/certificates/{certificates}","workspace_/certificates/{certificates}/services","workspace_/certificates/{certificates}/services/{services}","workspace_/certificates/{certificates}/snis","workspace_/certificates/{certificates}/snis/{snis}","workspace_/certificates/{certificates}/upstreams","workspace_/certificates/{certificates}/upstreams/{upstreams}","workspace_/clustering/data-planes","workspace_/clustering/status","workspace_/config","workspace_/consumer_groups","workspace_/consumer_groups/{consumer_groups}","workspace_/consumer_groups/{consumer_groups}/consumers","workspace_/consumer_groups/{consumer_groups}/consumers/{consumers}","workspace_/consumer_groups/{consumer_groups}/overrides/plugins/rate-limiting-advanced","workspace_/consumer_groups/{consumer_groups}/plugins","workspace_/consumer_groups/{consumer_groups}/plugins/{plugins}","workspace_/consumers","workspace_/consumers/{consumers}","workspace_/consumers/{consumers}/acls","workspace_/consumers/{consumers}/acls/{acls}","workspace_/consumers/{consumers}/admins","workspace_/consumers/{consumers}/admins/{admins}","workspace_/consumers/{consumers}/applications","workspace_/consumers/{consumers}/applications/{applications}","workspace_/consumers/{consumers}/basic-auth","workspace_/consumers/{consumers}/basic-auth/{basicauth_credentials}","workspace_/consumers/{consumers}/consumer_groups","workspace_/consumers/{consumers}/consumer_groups/{consumer_groups}","workspace_/consumers/{consumers}/developers","workspace_/consumers/{consumers}/developers/{developers}","workspace_/consumers/{consumers}/hmac-auth","workspace_/consumers/{consumers}/hmac-auth/{hmacauth_credentials}","workspace_/consumers/{consumers}/jwt","workspace_/consumers/{consumers}/jwt/{jwt_secrets}","workspace_/consumers/{consumers}/key-auth","workspace_/consumers/{consumers}/key-auth/{keyauth_credentials}","workspace_/consumers/{consumers}/key-auth-enc","workspace_/consumers/{consumers}/key-auth-enc/{keyauth_enc_credentials}","workspace_/consumers/{consumers}/login_attempts","workspace_/consumers/{consumers}/login_attempts/{login_attempts}","workspace_/consumers/{consumers}/mtls-auth","workspace_/consumers/{consumers}/mtls-auth/{mtls_auth_credentials}","workspace_/consumers/{consumers}/mtls_auth_credentials","workspace_/consumers/{consumers}/mtls_auth_credentials/{mtls_auth_credentials}","workspace_/consumers/{consumers}/oauth2","workspace_/consumers/{consumers}/oauth2/{oauth2_credentials}","workspace_/consumers/{consumers}/plugins","workspace_/consumers/{consumers}/plugins/{plugins}","workspace_/debug/cluster/log-level/{log_level}","workspace_/debug/node/log-level","workspace_/debug/node/log-level/{log_level}","workspace_/debug/profiling/cpu","workspace_/debug/profiling/gc-snapshot","workspace_/debug/profiling/memory","workspace_/degraphql_routes","workspace_/degraphql_routes/{degraphql_routes}","workspace_/degraphql_routes/{degraphql_routes}/service","workspace_/developers","workspace_/developers/export","workspace_/developers/invite","workspace_/developers/roles","workspace_/developers/roles/{rbac_roles}","workspace_/developers/{developers}","workspace_/developers/{developers}/applications","workspace_/developers/{developers}/applications/{applications}","workspace_/developers/{developers}/applications/{applications}/application_instances","workspace_/developers/{developers}/applications/{applications}/application_instances/{application_instances}","workspace_/developers/{developers}/applications/{applications}/credentials/{plugin}","workspace_/developers/{developers}/applications/{applications}/credentials/{plugin}/{credential_id}","workspace_/developers/{developers}/consumer","workspace_/developers/{developers}/credentials/{plugin}","workspace_/developers/{developers}/credentials/{plugin}/{credential_id}","workspace_/developers/{developers}/rbac_user","workspace_/developers/{email_or_id}/plugins/","workspace_/developers/{email_or_id}/plugins/{id}","workspace_/document_objects","workspace_/document_objects/{document_objects}","workspace_/document_objects/{document_objects}/service","workspace_/endpoints","workspace_/entities/migrate","workspace_/event-hooks","workspace_/event-hooks/sources","workspace_/event-hooks/sources/{source}","workspace_/event-hooks/sources/{source}/{event}","workspace_/event-hooks/{event_hooks}","workspace_/event-hooks/{event_hooks}/ping","workspace_/event-hooks/{event_hooks}/test","workspace_/files","workspace_/files/*","workspace_/files/partials/*","workspace_/files/{files}","workspace_/filter-chains","workspace_/filter-chains/{filter_chains}","workspace_/filter-chains/{filter_chains}/route","workspace_/filter-chains/{filter_chains}/service","workspace_/graphql-proxy-cache-advanced","workspace_/graphql-proxy-cache-advanced/{cache_key}","workspace_/graphql-proxy-cache-advanced/{plugin_id}/caches/{cache_key}","workspace_/graphql-rate-limiting-advanced/costs","workspace_/graphql-rate-limiting-advanced/costs/{graphql_ratelimiting_advanced_cost_decoration}","workspace_/graphql_ratelimiting_advanced_cost_decoration","workspace_/graphql_ratelimiting_advanced_cost_decoration/{graphql_ratelimiting_advanced_cost_decoration}","workspace_/graphql_ratelimiting_advanced_cost_decoration/{graphql_ratelimiting_advanced_cost_decoration}/service","workspace_/groups","workspace_/groups/{groups}","workspace_/groups/{groups}/roles","workspace_/hmac-auths","workspace_/hmac-auths/{hmacauth_credentials}","workspace_/hmac-auths/{hmacauth_credentials}/consumer","workspace_/jwt-signer/jwks","workspace_/jwt-signer/jwks/{jwt_signer_jwks}","workspace_/jwt-signer/jwks/{jwt_signer_jwks}/rotate","workspace_/jwts","workspace_/jwts/{jwt_secrets}","workspace_/jwts/{jwt_secrets}/consumer","workspace_/key-auths","workspace_/key-auths/{keyauth_credentials}","workspace_/key-auths/{keyauth_credentials}/consumer","workspace_/key-auths-enc","workspace_/key-auths-enc/{keyauth_enc_credentials}","workspace_/key-auths-enc/{keyauth_enc_credentials}/consumer","workspace_/key-sets","workspace_/key-sets/{key_sets}","workspace_/key-sets/{key_sets}/keys","workspace_/key-sets/{key_sets}/keys/{keys}","workspace_/keyring","workspace_/keyring/activate","workspace_/keyring/active","workspace_/keyring/export","workspace_/keyring/generate","workspace_/keyring/import","workspace_/keyring/import/raw","workspace_/keyring/recover","workspace_/keyring/remove","workspace_/keyring/vault/sync","workspace_/keys","workspace_/keys/{keys}","workspace_/keys/{keys}/set","workspace_/konnect_applications","workspace_/konnect_applications/{konnect_applications}","workspace_/license/report","workspace_/licenses","workspace_/licenses/{licenses}","workspace_/login_attempts","workspace_/login_attempts/{login_attempts}","workspace_/login_attempts/{login_attempts}/consumer","workspace_/metrics","workspace_/mtls-auths","workspace_/mtls-auths/{mtls_auth_credentials}/consumer","workspace_/mtls_auth_credentials","workspace_/mtls_auth_credentials/{mtls_auth_credentials}","workspace_/mtls_auth_credentials/{mtls_auth_credentials}/ca_certificate","workspace_/mtls_auth_credentials/{mtls_auth_credentials}/consumer","workspace_/oauth2","workspace_/oauth2/{oauth2_credentials}","workspace_/oauth2/{oauth2_credentials}/consumer","workspace_/oauth2/{oauth2_credentials}/oauth2_tokens","workspace_/oauth2/{oauth2_credentials}/oauth2_tokens/{oauth2_tokens}","workspace_/oauth2_tokens","workspace_/oauth2_tokens/{oauth2_tokens}","workspace_/oauth2_tokens/{oauth2_tokens}/credential","workspace_/oauth2_tokens/{oauth2_tokens}/service","workspace_/openid-connect/issuers","workspace_/openid-connect/issuers/{oic_issuers}","workspace_/openid-connect/jwks","workspace_/plugins","workspace_/plugins/enabled","workspace_/plugins/schema/{name}","workspace_/plugins/{plugins}","workspace_/plugins/{plugins}/consumer","workspace_/plugins/{plugins}/consumer_group","workspace_/plugins/{plugins}/route","workspace_/plugins/{plugins}/service","workspace_/proxy-cache","workspace_/proxy-cache/{cache_key}","workspace_/proxy-cache/{plugin_id}/caches/{cache_key}","workspace_/proxy-cache-advanced","workspace_/proxy-cache-advanced/{cache_key}","workspace_/proxy-cache-advanced/{plugin_id}/caches/{cache_key}","workspace_/rbac/roles","workspace_/rbac/roles/{rbac_roles}","workspace_/rbac/roles/{rbac_roles}/endpoints","workspace_/rbac/roles/{rbac_roles}/endpoints/permissions","workspace_/rbac/roles/{rbac_roles}/endpoints/{workspace}/*","workspace_/rbac/roles/{rbac_roles}/entities","workspace_/rbac/roles/{rbac_roles}/entities/permissions","workspace_/rbac/roles/{rbac_roles}/entities/{entity_id}","workspace_/rbac/roles/{rbac_roles}/permissions","workspace_/rbac/users","workspace_/rbac/users/{rbac_users}","workspace_/rbac/users/{rbac_users}/admins","workspace_/rbac/users/{rbac_users}/admins/{admins}","workspace_/rbac/users/{rbac_users}/developers","workspace_/rbac/users/{rbac_users}/developers/{developers}","workspace_/rbac/users/{rbac_users}/permissions","workspace_/rbac/users/{rbac_users}/roles","workspace_/routes","workspace_/routes/{routes}","workspace_/routes/{routes}/filter-chains","workspace_/routes/{routes}/filter-chains/{filter_chains}","workspace_/routes/{routes}/filters/all","workspace_/routes/{routes}/filters/disabled","workspace_/routes/{routes}/filters/enabled","workspace_/routes/{routes}/plugins","workspace_/routes/{routes}/plugins/{plugins}","workspace_/routes/{routes}/service","workspace_/schemas/plugins/validate","workspace_/schemas/plugins/{name}","workspace_/schemas/{db_entity_name}/validate","workspace_/schemas/{name}","workspace_/services","workspace_/services/{services}","workspace_/services/{services}/application_instances","workspace_/services/{services}/application_instances/{application_instances}","workspace_/services/{services}/applications","workspace_/services/{services}/client_certificate","workspace_/services/{services}/degraphql/routes","workspace_/services/{services}/degraphql/routes/{degraphql_routes}","workspace_/services/{services}/degraphql_routes","workspace_/services/{services}/degraphql_routes/{degraphql_routes}","workspace_/services/{services}/document_objects","workspace_/services/{services}/document_objects/{document_objects}","workspace_/services/{services}/filter-chains","workspace_/services/{services}/filter-chains/{filter_chains}","workspace_/services/{services}/graphql-rate-limiting-advanced/costs","workspace_/services/{services}/graphql_ratelimiting_advanced_cost_decoration","workspace_/services/{services}/graphql_ratelimiting_advanced_cost_decoration/{graphql_ratelimiting_advanced_cost_decoration}","workspace_/services/{services}/oauth2_tokens","workspace_/services/{services}/oauth2_tokens/{oauth2_tokens}","workspace_/services/{services}/plugins","workspace_/services/{services}/plugins/{plugins}","workspace_/services/{services}/routes","workspace_/services/{services}/routes/{routes}","workspace_/sessions","workspace_/sessions/{sessions}","workspace_/snis","workspace_/snis/{snis}","workspace_/snis/{snis}/certificate","workspace_/status","workspace_/tags","workspace_/tags/{tags}","workspace_/targets","workspace_/targets/{targets}","workspace_/targets/{targets}/upstream","workspace_/timers","workspace_/upstreams","workspace_/upstreams/{upstreams}","workspace_/upstreams/{upstreams}/client_certificate","workspace_/upstreams/{upstreams}/health","workspace_/upstreams/{upstreams}/targets","workspace_/upstreams/{upstreams}/targets/all","workspace_/upstreams/{upstreams}/targets/{targets}","workspace_/upstreams/{upstreams}/targets/{targets}/healthy","workspace_/upstreams/{upstreams}/targets/{targets}/unhealthy","workspace_/upstreams/{upstreams}/targets/{targets}/{address}/healthy","workspace_/upstreams/{upstreams}/targets/{targets}/{address}/unhealthy","workspace_/userinfo","workspace_/vault-auth","workspace_/vault-auth/{vault_auth_vaults}","workspace_/vault-auth/{vault}/credentials","workspace_/vault-auth/{vault}/credentials/token/{access_token}","workspace_/vault-auth/{vault}/credentials/{consumer}","workspace_/vaults","workspace_/vaults/{vaults}","workspace_/vitals/","workspace_/vitals/cluster","workspace_/vitals/cluster/status_codes","workspace_/vitals/consumers/{consumer_id}/cluster","workspace_/vitals/nodes/","workspace_/vitals/nodes/{node_id}","workspace_/vitals/reports/{entity_type}","workspace_/vitals/status_code_classes","workspace_/vitals/status_codes/by_consumer","workspace_/vitals/status_codes/by_consumer_and_route","workspace_/vitals/status_codes/by_route","workspace_/vitals/status_codes/by_service","workspace_/workspaces","workspace_/workspaces/{workspaces}","workspace_/workspaces/{workspaces}/meta"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/head-endpoints",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Check endpoint or entity existence",["18"],"be635e3143239","head","/{endpoint}",["19"],{},"head-endpoints","Similar to `HTTP` GET, but does not return the body. Returns HTTP 200 when the endpoint exits or HTTP 404 when it does not. Other status codes are possible.\n","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Information",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45"],["46"],{"id":"47","url":"48","name":"49","description":"50","variables":"51"},"851391bf560a6","ccf2fde3e67c8","204",["52","53","54","55","56","57","58"],[],"No Content","9222fe8c6f2b2","401",[],["59"],"Unauthorized","91d2fe8c6facd","404",[],[],"Endpoint does not exist",{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","name":"79","style":"62","schema":"80","description":"81","encodings":"82","examples":"83"},{"id":"84","name":"85","style":"62","schema":"86","description":"87","encodings":"88","examples":"89"},{"id":"90","name":"91","style":"62","schema":"92","description":"93","encodings":"94","examples":"95"},{"id":"96","name":"97","style":"62","schema":"98","description":"99","encodings":"100","examples":"101"},{"id":"102","name":"103","style":"62","schema":"104","description":"105","encodings":"106","examples":"107"},{"id":"108","name":"109","style":"62","schema":"110","description":"111","encodings":"112","examples":"113"},{"id":"114","name":"115","style":"62","schema":"116","description":"117","encodings":"118","examples":"119"},{"id":"120","mediaType":"121","examples":"122","encodings":"123","schema":"124"},"456b3205c04c8","endpoint","simple",[],"Any available endpoint",{"type":"125","examples":"126","$schema":"127","x-stoplight":"128"},["129","130","131","132","133"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"134","description":"135"},{"default":"136","description":"137"},{"default":"138","description":"139"},{"default":"140","description":"141","enum":"142"},"53a429c07cd0d","Date",{"type":"125","$schema":"127","x-stoplight":"143"},"The date and time at which the message was originated",[],["144"],"e68edd2edb657","Content-Type",{"type":"125","examples":"145","$schema":"127","x-stoplight":"146"},"The media type of the message content",[],[],"eabc7b431fae6","Connection",{"type":"125","enum":"147","$schema":"127","x-stoplight":"148"},"Indicates whether the connection will be closed after the message is completed",[],["149"],"317f15b6784b4","Access-Control-Allow-Origin",{"type":"125","examples":"150","$schema":"127","x-stoplight":"151"},"Indicates whether the resource can be accessed by any origin",[],[],"d91fd326a91db","X-Kong-Admin-Request-ID",{"type":"125","examples":"152","$schema":"127","x-stoplight":"153"},"A unique identifier for the request, generated by Kong",[],[],"aeb8bac5bf23a","X-Kong-Admin-Latency",{"type":"154","examples":"155","$schema":"127","x-stoplight":"156"},"The time taken to process the request on the server, in milliseconds",[],[],"873a8e05aec4c","Server",{"type":"125","examples":"157","$schema":"127","x-stoplight":"158"},"The software used by the origin server to handle the request",[],[],"259d813f537f8","application/json",["159","160","161"],[],{"type":"162","properties":"163","required":"164","title":"165","$schema":"127","x-stoplight":"166"},"string",["167"],"http://json-schema.org/draft-07/schema#",{"id":"168"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["140","169"],{"id":"170"},{"id":"171","value":"172","key":"173"},["174"],{"id":"175"},["176","177"],{"id":"178"},{"id":"179","value":"176","key":"173"},["180"],{"id":"181"},["182"],{"id":"183"},"integer",[5],{"id":"184"},["185"],{"id":"186"},{"id":"187","key":"188","value":"189","summary":"190"},{"id":"191","key":"192","value":"193","summary":"194"},{"id":"195","key":"196","value":"197","summary":"198"},"object",{"status":"199","message":"200"},["201","202"],"UnauthorizedError",{"id":"203"},"key","0e565da1f5cd1","https","aaa554b56d6a1","457effa682a35","Fri, 14 Apr 2023 17:38:29 GMT","__default","text/html; charset=UTF-8","fbf97d76db7d4","keep-alive","close","3a3f16953ff02","9925b500d8a80","*","43020d3d7100b","aqETeVmkeiGnAMzdUT2JRWroB2myY1lB","dfe34bdb0527c","1ae334e515de5","kong/3.2.2.0-enterprise-edition","293e69f397b5f","e49a396c4e452","DuplicateApiKey",{"message":"190","status":401},"Duplicate API key found","76a5f5e075180","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","5a9010f866430","NoAPIKey",{"message":"204","status":401},"No API key found",{"type":"154"},{"type":"125"},"status","message","470b68e5f0549","No API key found in request"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/options-endpoint",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List method by endpoint",["18"],"040df4f7b8b71","options","/{endpoint}",["19"],{},"options-endpoint","List all the supported HTTP methods by an endpoint. This can also be used with a CORS preflight request.\n","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Information",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45"],["46"],{"id":"47","url":"48","name":"49","description":"50","variables":"51"},"851391bf560a6","3bd7963a5fa0e","204",["52","53","54","55","56","57","58","59","60"],[],"No Content","9bb798172f5ca","400",[],[],"Bad Request","9bc798172f27d","401",[],["61"],"Unauthorized",{"id":"62","name":"63","style":"64","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","key":"70","extensions":"71","description":"72","type":"73","name":"74","in":"75"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"76","path":"77","port":"78","protocol":"79"},{"id":"80","name":"81","style":"64","schema":"82","description":"83","encodings":"84","examples":"85"},{"id":"86","name":"87","style":"64","schema":"88","description":"89","encodings":"90","examples":"91"},{"id":"92","name":"93","style":"64","schema":"94","description":"95","encodings":"96","examples":"97"},{"id":"98","name":"99","style":"64","schema":"100","description":"101","encodings":"102","examples":"103"},{"id":"104","name":"105","style":"64","schema":"106","description":"107","encodings":"108","examples":"109"},{"id":"110","name":"111","style":"64","schema":"112","description":"113","encodings":"114","examples":"115"},{"id":"116","name":"117","style":"64","schema":"118","description":"119","encodings":"120","examples":"121"},{"id":"122","name":"123","style":"64","schema":"124","description":"125","encodings":"126","examples":"127"},{"id":"128","name":"129","style":"64","schema":"130","description":"131","encodings":"132","examples":"133"},{"id":"134","mediaType":"135","examples":"136","encodings":"137","schema":"138"},"6321de1d12eb5","endpoint","simple",[],"Any available endpoint",{"type":"139","examples":"140","$schema":"141","x-stoplight":"142"},["143","144","145","146","147"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"148","description":"149"},{"default":"150","description":"151"},{"default":"152","description":"153"},{"default":"154","description":"155","enum":"156"},"c3f7ec21acd9a","Date",{"type":"139","$schema":"141","x-stoplight":"157"},"The date and time at which the message was originated",[],["158"],"9e050a0c648d3","Connection",{"type":"139","enum":"159","$schema":"141","x-stoplight":"160"},"Indicates whether the connection will be closed after the message is completed",[],["161"],"e48a8ba3ff45e","Access-Control-Allow-Origin",{"type":"139","examples":"162","$schema":"141","x-stoplight":"163"},"Indicates whether the resource can be accessed by any origin",[],[],"20b0175112099","Access-Control-Allow-Headers",{"type":"139","examples":"164","$schema":"141","x-stoplight":"165"},"Used in response to a preflight request to indicate which HTTP headers can be used during the actual request",[],[],"dac3c9e85410e","X-Kong-Admin-Request-ID",{"type":"139","examples":"166","$schema":"141","x-stoplight":"167"},"A unique identifier for the request, generated by Kong",[],[],"bbc34245d59e4","Allow",{"type":"139","examples":"168","$schema":"141","x-stoplight":"169"},"Lists the HTTP methods that are supported for the resource",[],[],"25c9e284233ef","Access-Control-Allow-Methods",{"type":"139","examples":"170","$schema":"141","x-stoplight":"171"},"Indicates the methods allowed when accessing the resource in response to a preflight request",[],[],"1e8c0878fe4ee","X-Kong-Admin-Latency",{"type":"172","examples":"173","$schema":"141","x-stoplight":"174"},"The time taken to process the request on the server, in milliseconds",[],[],"d54313438c1f8","Server",{"type":"139","examples":"175","$schema":"141","x-stoplight":"176"},"The software used by the origin server to handle the request",[],[],"20cf3ba417dee","application/json",["177","178","179"],[],{"type":"180","properties":"181","required":"182","title":"183","$schema":"141","x-stoplight":"184"},"string",["185"],"http://json-schema.org/draft-07/schema#",{"id":"186"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["154","187"],{"id":"188"},{"id":"189","value":"190","key":"191"},["192","193"],{"id":"194"},{"id":"195","value":"192","key":"191"},["196"],{"id":"197"},["198"],{"id":"199"},["200"],{"id":"201"},["202"],{"id":"203"},["202"],{"id":"204"},"integer",[5],{"id":"205"},["206"],{"id":"207"},{"id":"208","key":"209","value":"210","summary":"211"},{"id":"212","key":"213","value":"214","summary":"215"},{"id":"216","key":"217","value":"218","summary":"219"},"object",{"status":"220","message":"221"},["222","223"],"UnauthorizedError",{"id":"224"},"key","366af09aecc48","https","ff7eca4a3c0f5","7aeb4e3459588","Fri, 14 Apr 2023 17:24:17 GMT","__default","keep-alive","close","8e93294c5e4cb","f53db1ace368b","*","b7e7e3d36e215","Content-Type, Kong-Admin-Token, Kong-Request-Type, Cache-Control","039e24084c952","gDP1cF3OsNbrgcKPhRNE0RXRNfS7NcoG","b711dcc2ec1f4","OPTIONS, PATCH, POST","9a56531004a26","dc3caf1364509","1458c553261ee","kong/3.2.2.0-enterprise-edition","48b5680a2a8b8","c0ca4a91c603f","DuplicateApiKey",{"message":"211","status":401},"Duplicate API key found","f472305b71e42","InvalidAuthCred",{"message":"44","status":401},"Invalid authentication credentials","61a71a85df1d1","NoAPIKey",{"message":"225","status":401},"No API key found",{"type":"172"},{"type":"139"},"status","message","470b68e5f0549","No API key found in request"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-schemas-entity",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Retrieve entity schema",["18"],"bf0308e488d43","get","/schemas/{entity}/validate",["19"],{},"get-schemas-entity","Retrieve the schema of an entity. This is useful to understand what fields an entity accepts, and can be used for building third-party integrations with Kong.","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Information",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33"],["34"],{"id":"35","url":"36","name":"37","description":"38","variables":"39"},"851391bf560a6","5c0929d5a427d","200",[],["40"],"OK",{"id":"41","name":"42","style":"43","examples":"44","required":true,"schema":"45","explicitProperties":"46"},{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},"216e0a0646931","entity","simple",[],{"type":"63","$schema":"64","x-stoplight":"65"},["66","67","68","69"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"70","description":"71"},{"default":"72","description":"73"},{"default":"74","description":"75"},{"default":"76","description":"77","enum":"78"},"73be762cd4680","application/json",["79"],[],{"type":"80","x-examples":"81","properties":"82","$schema":"64","x-stoplight":"83"},"string","http://json-schema.org/draft-07/schema#",{"id":"84"},"schema","name","in","required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["76","85"],{"id":"86","key":"87","value":"88"},"object",{"Example 1":"89"},{"fields":"90"},{"id":"91"},"20c536c54929e","https","30d08f5100ee0","A mock schema",{"fields":"92"},{"fields":"93"},{"type":"94","description":"95","items":"96"},"3bb0fd3eba204",["97","98"],["99"],"array","A value of a schema",{"type":"80","properties":"100"},{"id":"101"},{"created_at":"102"},{"id":"103"},{"id":"104"},{"auto":true,"type":"63","uuid":true},{"auto":true,"timestamp":true,"type":"105"},{"auto":true,"type":"63","uuid":true},{"type":"80","description":"95","properties":"106"},"integer",{"auto":"107","type":"108","uuid":"109"},{"type":"110","description":"95"},{"type":"63","description":"95"},{"type":"110","description":"95"},"boolean"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-schemas-entity-validate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Validate a configuration against a schema",["18"],"98f3a907dfc10","post","/schemas/{entity}/validate",["19"],{},"post-schemas-entity-validate","Check validity of a configuration against its entity schema. This allows you to test your input before submitting a request to the entity endpoints of the Admin API.\n\nA requests to the entity endpoint using the given configuration may still fail due to other reasons, such as invalid foreign key relationships or uniqueness check failures against the contents of the data store.\n'401': \n $ref: '#/components/responses/HTTP401Error'","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Information",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33"],["34"],{"id":"35","url":"36","name":"37","description":"38","variables":"39"},"851391bf560a6","52c556bb84774","200",[],["40"],"OK",{"id":"41","name":"42","style":"43","examples":"44","required":true,"schema":"45","explicitProperties":"46"},{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},"99a9fa194f3c0","entity","simple",[],{"type":"63","$schema":"64","x-stoplight":"65"},["66","67","68","69"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"70","description":"71"},{"default":"72","description":"73"},{"default":"74","description":"75"},{"default":"76","description":"77","enum":"78"},"2941109875ffa","application/json",["79"],[],{"type":"80","properties":"81","$schema":"64","x-stoplight":"82"},"string","http://json-schema.org/draft-07/schema#",{"id":"83"},"schema","name","in","required","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["76","84"],{"id":"85","key":"86","value":"87"},"object",{"Message":"88"},{"id":"89"},"f2d47e9ab611d","https","f9bd52d0b2b1d","schema validation successful",{"Message":"86"},{"type":"63","description":"90","examples":"91"},"ebeb064166a10","A success message",["86"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-schemas-plugins-plugin_name",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Retrieve Plugin Schema",["18"],"9dfd5e39df33e","get","/schemas/plugins/{plugin_name}",["19"],{},"get-schemas-plugins-plugin_name","Retrieve the schema of a plugin's configuration. This is useful to understand what fields a plugin accepts, and can be used for building third-party integrations to the Kong's plugin system.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Information",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"851391bf560a6","8db667c844e67","200",[],[],"OK","b5c6698dedb9d","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},{"id":"65","mediaType":"66","examples":"67","encodings":"68","schema":"69"},"292a79c87219e","plugin_name","simple",[],"The name of a Kong plugin",{"type":"70","examples":"71","$schema":"72","x-stoplight":"73"},["74","75","76","77","78"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86","enum":"87"},"46f9e2642f4f2","application/json",["88","89","90"],[],{"type":"91","properties":"92","required":"93","title":"94","$schema":"72","x-stoplight":"95"},"string",["96"],"http://json-schema.org/draft-07/schema#",{"id":"97"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["85","98"],{"id":"99","key":"100","value":"101","summary":"102"},{"id":"103","key":"104","value":"105","summary":"106"},{"id":"107","key":"108","value":"109","summary":"110"},"object",{"status":"111","message":"112"},["113","114"],"UnauthorizedError",{"id":"115"},"basic-auth","62c028b43e07a","https","148bb9f5af374","DuplicateApiKey",{"message":"102","status":401},"Duplicate API key found","756941846b9b7","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","ec6f93a3c9560","NoAPIKey",{"message":"116","status":401},"No API key found",{"type":"117"},{"type":"70"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-schemas-plugins-validate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Validate plugin schema",["18"],"44242d6fbce81","post","/schemas/plugins/validate",["19"],{},"post-schemas-plugins-validate","Check validity of a plugin configuration against the plugins entity schema. This allows you to test your input before submitting a request to the entity endpoints of the Admin API.\n\n\nThis only performs the schema validation checks, checking that the input configuration is well-formed. A requests to the entity endpoint using the given configuration may still fail due to other reasons, such as invalid foreign key relationships or uniqueness check failures against the contents of the data store\n'401': \n $ref: '#/components/responses/HTTP401Error'","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"Information",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],[],["33"],{"id":"34","url":"35","name":"36","description":"37","variables":"38"},"851391bf560a6","2e9fbfd716f64","200",[],["39"],"OK",{"id":"40","key":"41","extensions":"42","description":"43","type":"44","name":"45","in":"46"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"47","path":"48","port":"49","protocol":"50"},{"id":"51","mediaType":"52","examples":"53","encodings":"54","schema":"55"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"56","description":"57"},{"default":"58","description":"59"},{"default":"60","description":"61"},{"default":"62","description":"63","enum":"64"},"9d5f51650e158","application/json",["65"],[],{"type":"66","x-examples":"67","properties":"68","$schema":"69","x-stoplight":"70"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["62","71"],{"id":"72","key":"73","value":"74"},"object",{"Example 1":"75"},{"message":"76"},"http://json-schema.org/draft-07/schema#",{"id":"77"},"https","fa47526570408","schema validation successful",{"message":"73"},{"message":"73"},{"type":"78","description":"79","examples":"80"},"456b8cfa1e9dd","string","A successful message",["73"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-timers",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Retrieve Runtime Debugging Info of Kong's Timers",["18"],"51af388fcc066","get","/timers",["19"],{},"get-timers","Retrieve runtime stats data from [lua-resty-timer-ng](https://github.com/Kong/lua-resty-timer-ng).","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Information",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"851391bf560a6","487c31989e5f1","200",[],["45"],"OK","ddcc322a0edf3","401",[],["46"],"Unauthorized",{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},{"id":"63","mediaType":"59","examples":"64","encodings":"65","schema":"66"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"f40e7498f2afe","application/json",[],[],{"type":"76","x-examples":"77","properties":"78","$schema":"79","x-stoplight":"80"},"05947b578d6f6",["81","82","83"],[],{"type":"76","properties":"84","required":"85","title":"86","$schema":"79","x-stoplight":"87"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","88"],"object",{"Example 1":"89"},{"stats":"90","worker":"91"},"http://json-schema.org/draft-07/schema#",{"id":"92"},{"id":"93","key":"94","value":"95","summary":"96"},{"id":"97","key":"98","value":"99","summary":"100"},{"id":"101","key":"102","value":"103","summary":"104"},{"status":"105","message":"106"},["107","108"],"UnauthorizedError",{"id":"109"},"https",{"stats":"110","worker":"111"},{"type":"76","description":"112","properties":"113"},{"type":"76","properties":"114"},"f9afefd3d43a8","ac1d3b7ced19f","DuplicateApiKey",{"message":"96","status":401},"Duplicate API key found","860a3e6ff0e45","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","04fd2bc247cd3","NoAPIKey",{"message":"115","status":401},"No API key found",{"type":"116"},{"type":"117"},"status","message","470b68e5f0549",{"sys":"118","flamegraph":"119","timers":"120"},{"id":0,"count":5},"Statistics about the worker",{"sys":"121","flamegraph":"122","timers":"123"},{"id":"124","count":"125"},"No API key found in request","integer","string",{"total":13,"waiting":12,"runs":6771,"pending":0,"running":1},{"pending":"126","running":"126","elapsed_time":"126"},{"router-rebuild":"127","unix_timestamp=1681492692484.000000;counter=7:meta=debug off":"128"},{"type":"76","description":"129","properties":"130"},{"type":"76","description":"131","properties":"132"},{"description":"133","type":"76","properties":"134"},{"type":"116","description":"135"},{"type":"116","description":"136"},"",{"is_running":false,"name":"137","stats":"138","meta":"139"},{"is_running":false,"name":"140","stats":"141","meta":"142"},"List of the number of different type of timers",{"total":"143","waiting":"144","runs":"145","pending":"146","running":"147"},"String-encoded timer-related flamegraph data",{"pending":"148","running":"149","elapsed_time":"150"},"Timer statistics for the worker",{"meta":"151"},"The ordinal number of the current Nginx worker processes (starting from number 0).","The total number of the Nginx worker processes.","router-rebuild",{"runs":464,"elapsed_time":"152","finish":464,"last_err_msg":"126"},{"callstack":"153","name":"153"},"unix_timestamp=1681492692484.000000;counter=7:meta=debug off",{"runs":3,"elapsed_time":"154","finish":3,"last_err_msg":"126"},{"callstack":"153","name":"153"},{"description":"155","type":"116","default":7,"examples":"156"},{"description":"157","type":"116","default":7,"examples":"158"},{"description":"159","type":"116","default":7,"examples":"160"},{"description":"161","type":"116","default":0,"examples":"162"},{"description":"163","type":"116","default":0,"examples":"164"},{"description":"165","type":"117","examples":"166"},{"description":"167","type":"117","examples":"168"},{"description":"169","type":"117","examples":"170"},{"description":"171","type":"76","properties":"172"},{"avg":0,"min":9999999,"max":-1,"variance":0},"debug off",{"avg":0,"min":9999999,"max":-1,"variance":0},"The total number of timers (running + pending + waiting)",[7],"The number of unexpired timers",[7],"The total number of runs for the timers",[7],"The number of pending timers",[0],"The number of running timers",[0],"The number of pending timers for the flamegraph",["173"],"The number of running timers for the flamegraph",["173"],"The elapsed time for the flamegraph",["174"],"Program callstack of created timers",{"name":"175"},"@./kong/init.lua:706:init_worker();@./kong/runloop/handler.lua:1086:before() 0\n","@./kong/init.lua:706:init_worker();@./kong/runloop/handler.lua:1086:before() 17\n",{"description":"176","type":"117","examples":"177"},"The name of the timer's metadata",["178"],"@/build/luarocks/share/lua/5.1/resty/counter.lua:71:new()"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-status",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Health Routes",["18"],"c78903cca73f6","get","/status",["19"],{},"get-status","Retrieve usage information about a node, with some basic information about the connections being processed by the underlying nginx process, the status of the database connection, and node's memory usage.\n\n`status_listen` listens on port `8007` by default, however `8001` can be used for status checks as well. The status endpoint provides detailed metrics regarding memory usage, worker process stats, database connection status, and server connection metrics.\n\nIf you want to monitor the Kong process, since Kong is built on top of nginx, every existing nginx monitoring tool or agent can be used.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Information",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"851391bf560a6","15e554e9ea4d0","200",[],["45"],"OK","209554472e359","401",[],["46"],"Unauthorized",{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},{"id":"63","mediaType":"59","examples":"64","encodings":"65","schema":"66"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"782b694d77e00","application/json",["76"],[],{"type":"77","x-examples":"78","properties":"79","$schema":"80","x-stoplight":"81"},"8b468b10e8226",["82","83","84"],[],{"type":"77","properties":"85","required":"86","title":"87","$schema":"80","x-stoplight":"88"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","89"],{"id":"90","key":"91","value":"92"},"object",{"Example 1":"93"},{"memory":"94","database":"95","server":"96"},"http://json-schema.org/draft-07/schema#",{"id":"97"},{"id":"98","key":"99","value":"100","summary":"101"},{"id":"102","key":"103","value":"104","summary":"105"},{"id":"106","key":"107","value":"108","summary":"109"},{"status":"110","message":"111"},["112","113"],"UnauthorizedError",{"id":"114"},"https","d19c46868bc9a","Status endpoint response",{"memory":"115","database":"116","server":"117"},{"memory":"118","database":"119","server":"120"},{"type":"77","description":"121","properties":"122"},{"type":"77","description":"123","properties":"124"},{"type":"77","description":"125","properties":"126"},"c66406e3a9dd4","68c26446eaa04","DuplicateApiKey",{"message":"101","status":401},"Duplicate API key found","a5022e49ee9e4","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","e13db8e9e39bb","NoAPIKey",{"message":"127","status":401},"No API key found",{"type":"128"},{"type":"129"},"status","message","470b68e5f0549",{"lua_shared_dicts":"130","workers_lua_vms":"131"},{"reachable":true},{"connections_reading":0,"connections_writing":6,"total_requests":28,"connections_waiting":0,"connections_handled":15,"connections_active":6,"connections_accepted":15},{"lua_shared_dicts":"132","workers_lua_vms":"133"},{"reachable":true},{"connections_reading":0,"connections_writing":6,"total_requests":28,"connections_waiting":0,"connections_handled":15,"connections_active":6,"connections_accepted":15},"Metrics about the memory usage.",{"lua_shared_dicts":"134","workers_lua_vms":"135"},"Metrics about the database",{"reachable":"136"},"Metrics about the nginx HTTP/S server",{"connections_reading":"137","connections_writing":"138","total_requests":"139","connections_waiting":"140","connections_handled":"141","connections_active":"142","connections_accepted":"143"},"No API key found in request","integer","string",{"kong_core_db_cache":"144","kong_core_db_cache_miss":"145","kong_db_cache":"146","kong_db_cache_miss":"147","kong_vitals_counters":"148","kong_vitals_lists":"149","kong_vitals":"150","kong_counters":"151","kong_reports_consumers":"152","kong_reports_routes":"153","kong_reports_services":"154","kong_reports_workspaces":"155","kong_keyring":"156","kong_profiling_state":"157","prometheus_metrics":"158","kong":"159","kong_locks":"160","kong_healthchecks":"161","kong_process_events":"162","kong_cluster_events":"163","kong_rate_limiting_counters":"164"},["165","166","167","168","169"],{"kong_core_db_cache":"170","kong_core_db_cache_miss":"171","kong_db_cache":"172","kong_db_cache_miss":"173","kong_vitals_counters":"174","kong_vitals_lists":"175","kong_vitals":"176","kong_counters":"177","kong_reports_consumers":"178","kong_reports_routes":"179","kong_reports_services":"180","kong_reports_workspaces":"181","kong_keyring":"182","kong_profiling_state":"183","prometheus_metrics":"184","kong":"185","kong_locks":"186","kong_healthchecks":"187","kong_process_events":"188","kong_cluster_events":"189","kong_rate_limiting_counters":"190"},["191","192","193","194","195"],{"type":"77","description":"196","properties":"197"},{"type":"198","description":"199","items":"200"},{"type":"201","description":"202"},{"type":"128","description":"203","examples":"204"},{"type":"128","description":"205","examples":"206"},{"type":"128","description":"207","examples":"208"},{"type":"128","description":"209","examples":"210"},{"type":"128","description":"211","examples":"212"},{"type":"128","description":"213","examples":"214"},{"type":"128","description":"215","examples":"216"},{"capacity":"217","allocated_slabs":"218"},{"capacity":"219","allocated_slabs":"220"},{"capacity":"217","allocated_slabs":"221"},{"capacity":"219","allocated_slabs":"220"},{"capacity":"222","allocated_slabs":"223"},{"capacity":"224","allocated_slabs":"225"},{"capacity":"224","allocated_slabs":"225"},{"capacity":"224","allocated_slabs":"225"},{"capacity":"226","allocated_slabs":"227"},{"capacity":"224","allocated_slabs":"225"},{"capacity":"224","allocated_slabs":"225"},{"capacity":"224","allocated_slabs":"225"},{"capacity":"228","allocated_slabs":"229"},{"capacity":"230","allocated_slabs":"225"},{"capacity":"228","allocated_slabs":"229"},{"capacity":"228","allocated_slabs":"229"},{"capacity":"231","allocated_slabs":"232"},{"capacity":"228","allocated_slabs":"229"},{"capacity":"228","allocated_slabs":"229"},{"capacity":"228","allocated_slabs":"229"},{"capacity":"219","allocated_slabs":"220"},{"http_allocated_gc":"233","pid":2323},{"http_allocated_gc":"234","pid":2324},{"http_allocated_gc":"234","pid":2325},{"http_allocated_gc":"234","pid":2326},{"http_allocated_gc":"234","pid":2327},{"capacity":"217","allocated_slabs":"218"},{"capacity":"219","allocated_slabs":"220"},{"capacity":"217","allocated_slabs":"221"},{"capacity":"219","allocated_slabs":"220"},{"capacity":"222","allocated_slabs":"223"},{"capacity":"224","allocated_slabs":"225"},{"capacity":"224","allocated_slabs":"225"},{"capacity":"224","allocated_slabs":"225"},{"capacity":"226","allocated_slabs":"227"},{"capacity":"224","allocated_slabs":"225"},{"capacity":"224","allocated_slabs":"225"},{"capacity":"224","allocated_slabs":"225"},{"capacity":"228","allocated_slabs":"229"},{"capacity":"230","allocated_slabs":"225"},{"capacity":"228","allocated_slabs":"229"},{"capacity":"228","allocated_slabs":"229"},{"capacity":"231","allocated_slabs":"232"},{"capacity":"228","allocated_slabs":"229"},{"capacity":"228","allocated_slabs":"229"},{"capacity":"228","allocated_slabs":"229"},{"capacity":"219","allocated_slabs":"220"},{"http_allocated_gc":"233","pid":2323},{"http_allocated_gc":"234","pid":2324},{"http_allocated_gc":"234","pid":2325},{"http_allocated_gc":"234","pid":2326},{"http_allocated_gc":"234","pid":2327},"An array of dictionary objects that are shared with all workers in a Kong node, where each array node contains how much memory is dedicated for the specific shared dictionary (`capacity`) and how much of said memory is in use (`allocated_slabs`).",{"kong_core_db_cache":"235"},"array","An array with all workers of the Kong node, each entry contains a `http_allocated_gc` string and a `pid`.",{"type":"77","properties":"236"},"boolean","A boolean value reflecting the state of the database connection. Please note that this flag does not reflect the health of the database itself.","The current number of connections where Kong is reading the request header.",[3],"The current number of connections where nginx is writing the response back to the client.",[1],"The total number of client requests.",[1],"The current number of idle client connections waiting for a request.",[1],"The total number of handled connections. Generally, the parameter value is the same as the `connections_accepted` parameter unless some resource limits have been reached.",[1],"The current number of active client connections including waiting connections.",[1],"The total number of accepted client connections.",[1],"128.00 MiB","0.76 MiB","12.00 MiB","0.08 MiB","0.78 MiB","50.00 MiB","0.30 MiB","1.00 MiB","0.02 MiB","10.00 MiB","0.07 MiB","5.00 MiB","0.04 MiB","1.50 MiB","8.00 MiB","0.06 MiB","51.92 MiB","51.48 MiB",{"type":"77","properties":"237"},{"http_allocated_gc":"238","pid":"239"},{"capacity":"240","allocated_slabs":"241"},{"type":"129","description":"242"},{"type":"128","description":"243","examples":"244"},{"type":"129","description":"245","examples":"246"},{"type":"129","description":"247","examples":"248"},"HTTP submodule's Lua virtual machine's memory usage information.\n","A worker's process identification number.",[18478],"Memory capacity",["217"],"Total allocated memory",["217"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/getDnsStatus",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"DNS Status",["18"],"d8b79d5cba92f","get","/status/dns",["19"],{},"getDnsStatus","Retrieve DNS worker and stats information. If the legacy DNS client is in use, it returns a 501 status with a message.\n","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Information",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],[],["45"],{"id":"46","url":"47","name":"48","description":"49","variables":"50"},"851391bf560a6","86f0edf6b9cae","200",[],["51"],"DNS worker and stats information","2ec0ec19f7675","401",[],["52"],"Unauthorized","cd30ebc5b4318","501",[],["53"],"Legacy DNS client in use",{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},{"id":"65","mediaType":"66","examples":"67","encodings":"68","schema":"69"},{"id":"70","mediaType":"66","examples":"71","encodings":"72","schema":"73"},{"id":"74","mediaType":"66","examples":"75","encodings":"76","schema":"77"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"78","description":"79"},{"default":"80","description":"81"},{"default":"82","description":"83"},{"default":"84","description":"85","enum":"86"},"ddc7014c192a9","application/json",[],[],{"type":"87","properties":"88","$schema":"89","x-stoplight":"90"},"44926545a7dc7",["91","92","93"],[],{"type":"87","properties":"94","required":"95","title":"96","$schema":"89","x-stoplight":"97"},"ccb55620391de",[],[],{"type":"87","properties":"98","$schema":"89","x-stoplight":"99"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["84","100"],"object",{"worker":"101","stats":"102"},"http://json-schema.org/draft-07/schema#",{"id":"103"},{"id":"104","key":"105","value":"106","summary":"107"},{"id":"108","key":"109","value":"110","summary":"111"},{"id":"112","key":"113","value":"114","summary":"115"},{"status":"116","message":"117"},["118","119"],"UnauthorizedError",{"id":"120"},{"message":"121"},{"id":"122"},"https",{"type":"87","description":"123","properties":"124"},{"type":"87","description":"125"},"4c4953d837a94","2da51d2372fca","DuplicateApiKey",{"message":"107","status":401},"Duplicate API key found","c302c3cf7b010","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","267167ff49877","NoAPIKey",{"message":"126","status":401},"No API key found",{"type":"127"},{"type":"128"},"status","message","470b68e5f0549",{"type":"128","description":"129","examples":"130"},"6f01e5f0bbdce","Worker information.",{"id":"131","count":"132"},"DNS stats information (specific details depend on the Kong instance).","No API key found in request","integer","string","Message indicating that the endpoint is not implemented with the legacy DNS client.",["133"],{"type":"127","description":"134","examples":"135"},{"type":"127","description":"136","examples":"137"},"not implemented with the legacy DNS client","The worker ID.",[1],"The total number of workers.",[4]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-schemas-vaults-vault_name",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Retrieve Vault Schema",["18"],"7c19530c72001","get","/schemas/vaults/{vault_name}",["19"],{},"get-schemas-vaults-vault_name","Retrieve the schema of a vault.","inheritedFromService",["20","21","22"],{"headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Information",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},[],[],[],["45"],["46"],{"id":"47","url":"48","name":"49","description":"50","variables":"51"},"851391bf560a6","981d65c245a10","200",[],["52"],"OK","f04d679f077e3","401",[],["53"],"Unauthorized","effd679f07f60","404",[],[],"No vault named",{"id":"54","name":"55","style":"56","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},{"id":"77","mediaType":"73","examples":"78","encodings":"79","schema":"80"},"23043c6817b23","vault_name","simple",[],"The vault schema to be returned",{"type":"81","$schema":"82","x-stoplight":"83"},["84","85","86","87","88"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"89","description":"90"},{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96","enum":"97"},"51dd7d8dfdc69","application/json",["98"],[],{"description":"99","type":"100","properties":"101","additionalProperties":false,"required":"102","title":"103","examples":"104"},"304e28bb5354b",["105","106","107"],[],{"type":"100","properties":"108","required":"109","title":"110","$schema":"82","x-stoplight":"111"},"string","http://json-schema.org/draft-07/schema#",{"id":"112"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["95","113"],{"id":"114","value":"115","key":"116"},"Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, HashiCorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.","object",{"config":"117","created_at":"118","description":"119","id":"120","name":"121","prefix":"122","tags":"123","updated_at":"124"},["85","125","126"],"Vault",["115"],{"id":"127","key":"128","value":"129","summary":"130"},{"id":"131","key":"132","value":"133","summary":"134"},{"id":"135","key":"136","value":"137","summary":"138"},{"status":"139","message":"140"},["141","142"],"UnauthorizedError",{"id":"143"},"87ad77cf80516","https","185009dbd9250",{"config":"144","description":"145","id":"146","name":"147","prefix":"147","tags":"148"},"default",{"description":"149","type":"100","additionalProperties":true},{"description":"150","type":"151","readOnly":true},{"description":"152","type":"153"},{"type":"154"},{"description":"155","type":"81"},{"description":"156","type":"81"},{"description":"157","type":"158","items":"159"},{"description":"160","type":"151","readOnly":true},"prefix","config","c0624c6cc00ba","DuplicateApiKey",{"message":"130","status":401},"Duplicate API key found","97c631dfb0ef9","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","554a95e5c3048","NoAPIKey",{"message":"161","status":401},"No API key found",{"type":"151"},{"type":"81"},"status","message","470b68e5f0549",{"prefix":"162"},"environment variable based vault","2747d1e5-8246-4f65-a939-b392f1ee17f8","env",["163","164"],"The configuration properties for the Vault which can be found on the vaults' documentation page.","Unix epoch when the resource was created.","integer","The description of the Vault entity.",["81","165"],["81","165"],"The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.","The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.","An optional set of strings associated with the Vault for grouping and filtering.","array",{"type":"81"},"Unix epoch when the resource was last updated.","No API key found in request","ENV_PREFIX","foo","bar","null"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-admins",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List Admins",["18"],"83c4ef1ed50de","get","/admins",["19"],{},"get-admins","Returns a list of admins. To query all admins, add a parameter `all_workspaces=true` to the `/admins` endpoint. The `status` field in the response indicates the state of the admins invitation. `0`= Approved, `1`= Pending, `2`= Rejected, `3`= Revoked, `4` = Invited, `5`= Unverified.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"admins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"3cf7f63d03d5a","5d36e875eca28","200",[],["45"],"Example response","8fe6e7ea3c48a","401",[],["46"],"Unauthorized",{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},{"id":"63","mediaType":"59","examples":"64","encodings":"65","schema":"66"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"290b1c3a15e77","application/json",[],[],{"type":"76","x-examples":"77","properties":"78","$schema":"79","x-stoplight":"80"},"01c5449608e7b",["81","82","83"],[],{"type":"76","properties":"84","required":"85","title":"86","$schema":"79","x-stoplight":"87"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","88"],"object",{"Example 1":"89"},{"data":"90","next":"91"},"http://json-schema.org/draft-07/schema#",{"id":"92"},{"id":"93","key":"94","value":"95","summary":"96"},{"id":"97","key":"98","value":"99","summary":"100"},{"id":"101","key":"102","value":"103","summary":"104"},{"status":"105","message":"106"},["107","108"],"UnauthorizedError",{"id":"109"},"https",{"data":"110","next":null},{"type":"111","items":"112"},{"nullable":true},"68930209917d5","b5d35b7b8e2ff","DuplicateApiKey",{"message":"96","status":401},"Duplicate API key found","1fb5f9c9fc97d","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","72990af8c4a9e","NoAPIKey",{"message":"113","status":401},"No API key found",{"type":"114"},{"type":"115"},"status","message","470b68e5f0549",["116","117"],"array",{"type":"76","properties":"118"},"No API key found in request","integer","string",{"created_at":1556638385,"id":"119","updated_at":1556638385,"status":4,"username":"120","email":"121","rbac_token_enabled":true},{"created_at":1556563122,"id":"122","updated_at":1556563122,"status":0,"username":"123","rbac_token_enabled":false},{"created_at":"124","id":"125","updated_at":"126","status":"127","username":"128","email":"129","rbac_token_enabled":"130"},"665b4070-541f-48bf-82c1-53030babaa81","test-admin","test@test.com","a93ff120-9e6c-4198-b47e-f779104c7eac","kong_admin",{"type":"114"},{"type":"115"},{"type":"114"},{"type":"114","description":"131"},{"type":"115"},{"type":"115"},{"type":"132"},"The status field indicates the state of the invitation.","boolean"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-admins",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Invite an Admin",["18"],"709a1752bb975","post","/admins",["19"],{},"post-admins","Invite an admin to your organization.","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"admins",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41"},[],[],[],[],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"3cf7f63d03d5a","6589ec9e07a95","200",[],["48"],"OK","3cf9ead85db97","409",[],["49"],"Conflict","c2848ef901074",["50"],{"id":"51","key":"52","extensions":"53","description":"54","type":"55","name":"56","in":"57"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"58","path":"59","port":"60","protocol":"61"},{"id":"62","mediaType":"63","examples":"64","encodings":"65","schema":"66"},{"id":"67","mediaType":"63","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"63","examples":"72","encodings":"73","schema":"74"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"75","description":"76"},{"default":"77","description":"78"},{"default":"79","description":"80"},{"default":"81","description":"82","enum":"83"},"e6c5b7e6d5ba5","application/json",["84"],[],{"type":"85","properties":"86","x-examples":"87","$schema":"88","x-stoplight":"89"},"fb3225c669ca8",["90"],[],{"type":"85","properties":"91","x-exmples":"92","$schema":"88","x-stoplight":"93"},"e4580fc6a9422",["94"],[],{"type":"85","properties":"95","$schema":"88","x-stoplight":"96"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["81","97"],{"id":"98","key":"99","value":"100"},"object",{"admin":"101"},{"Example 1":"102"},"http://json-schema.org/draft-07/schema#",{"id":"103"},{"id":"104","key":"105","value":"106"},{"message":"107"},{"Example 1":"108"},{"id":"109"},{"id":"110","key":"111","value":"112"},{"email":"113","username":"114","custom_id":"115","rbac_token_enabled":"116"},{"id":"117"},"https","1bbc8e9ae678d","Example admin response",{"admin":"118"},{"type":"85","properties":"119"},{"admin":"120"},"a54f9ed5d9ff0","8a76de8bddd04","Constraint violation",{"message":"121"},{"type":"122","description":"123","examples":"124"},{"message":"121"},"0b67213fb3a93","a06bc50db59df","Invite an admin",{"username":"125","email":"126","custom_id":"127","rbac_token_enabled":true},{"type":"122","description":"128","examples":"129"},{"type":"122","description":"130","examples":"131"},{"type":"122","description":"132"},{"type":"133","description":"134","default":true},"e310c88ba6663",{"created_at":0,"id":"122","updated_at":0,"status":0,"username":"122","email":"122","rbac_token_enabled":true},{"created_at":"135","id":"136","updated_at":"137","status":"138","username":"139","email":"140","rbac_token_enabled":"141"},{"created_at":1556638641,"id":"142","updated_at":1556638641,"status":4,"username":"125","email":"126","rbac_token_enabled":true},"user already exists with same username, email, or custom_id","string","Detail about the conflict",["121"],"test-case-3","test3@test.com","customId","The admin's email address.",["143"],"The admin's username",["144"],"The admin's custom ID","boolean","Allows the admin to use and reset their RBAC token.",{"type":"145"},{"type":"122"},{"type":"145"},{"type":"145"},{"type":"122"},{"type":"122"},{"type":"133"},"8f0a742f-07f3-49e0-90d7-4fc7eea7e6a4","email@example.com","myusername","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-admins-register",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Register an Admin’s Credentials",["18"],"f599fdd702d7e","post","/admins/register",["19"],{},"post-admins-register","Register an Admin's Credentials","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"admins",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41"},[],[],[],[],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"3cf7f63d03d5a","958c2f8737016","201",[],[],"Created","3d6c2daa744ae","401",[],["48"],"Unauthorized","ce378ae613ae7",["49"],{"id":"50","key":"51","extensions":"52","description":"53","type":"54","name":"55","in":"56"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"57","path":"58","port":"59","protocol":"60"},{"id":"61","mediaType":"62","examples":"63","encodings":"64","schema":"65"},{"id":"66","mediaType":"62","examples":"67","encodings":"68","schema":"69"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"70","description":"71"},{"default":"72","description":"73"},{"default":"74","description":"75"},{"default":"76","description":"77","enum":"78"},"3085576f32c21","application/json",["79","80","81"],[],{"type":"82","properties":"83","required":"84","title":"85","$schema":"86","x-stoplight":"87"},"c7689964003a2",["88"],[],{"type":"82","properties":"89","$schema":"86","x-stoplight":"90"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["76","91"],{"id":"92","key":"93","value":"94","summary":"95"},{"id":"96","key":"97","value":"98","summary":"99"},{"id":"100","key":"101","value":"102","summary":"103"},"object",{"status":"104","message":"105"},["106","107"],"UnauthorizedError","http://json-schema.org/draft-07/schema#",{"id":"108"},{"id":"109","key":"110","value":"111"},{"token":"112","username":"113","email":"114","password":"115"},{"id":"116"},"https","4f7f0a2cbb99b","DuplicateApiKey",{"message":"95","status":401},"Duplicate API key found","1e470b93b4ce2","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","33885947f7245","NoAPIKey",{"message":"117","status":401},"No API key found",{"type":"118"},{"type":"119"},"status","message","470b68e5f0549","d4743c051fb70","Example registration request",{"token":"119","username":"119","email":"120","password":"121"},{"type":"119"},{"type":"119"},{"type":"119","format":"122"},{"type":"119","format":"123"},"a9993e44d5738","No API key found in request","integer","string","user@example.com","pa$$word","email","password"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-admins-password_resets",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Send a Password Reset Email to an Admin",["18"],"05a84ced98d22","post","/admins/password_resets",["19"],{},"get-admins-password_resets","Using a registered admin's email address issue a password reset email to the admin.","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"admins",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41"},[],[],[],[],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"3cf7f63d03d5a","49799d8d4b161","201",[],[],"Created","0ed99e35d4eb4","401",[],["48"],"Unauthorized","1fd809b3915dc",["49"],{"id":"50","key":"51","extensions":"52","description":"53","type":"54","name":"55","in":"56"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"57","path":"58","port":"59","protocol":"60"},{"id":"61","mediaType":"62","examples":"63","encodings":"64","schema":"65"},{"id":"66","mediaType":"62","examples":"67","encodings":"68","schema":"69"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"70","description":"71"},{"default":"72","description":"73"},{"default":"74","description":"75"},{"default":"76","description":"77","enum":"78"},"17c058ddbf5dd","application/json",["79","80","81"],[],{"type":"82","properties":"83","required":"84","title":"85","$schema":"86","x-stoplight":"87"},"069f3efa0f14b",["88"],[],{"type":"82","properties":"89","$schema":"86","x-stoplight":"90"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["76","91"],{"id":"92","key":"93","value":"94","summary":"95"},{"id":"96","key":"97","value":"98","summary":"99"},{"id":"100","key":"101","value":"102","summary":"103"},"object",{"status":"104","message":"105"},["106","107"],"UnauthorizedError","http://json-schema.org/draft-07/schema#",{"id":"108"},{"id":"109","key":"110","value":"111"},{"email":"112"},{"id":"113"},"https","026806afefeeb","DuplicateApiKey",{"message":"95","status":401},"Duplicate API key found","860caf18bc5fb","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","05fef558006e5","NoAPIKey",{"message":"114","status":401},"No API key found",{"type":"115"},{"type":"116"},"status","message","470b68e5f0549","9bf00e38de275","Example reset body",{"email":"117"},{"type":"116","description":"118","examples":"119"},"b7c92736d9e6b","No API key found in request","integer","string","admin@example.com","The registered admin's email.",["117"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/patch-admins-password_resets",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Reset an Admin’s Password",["18"],"9d9322b19f24e","patch","/admins/password_resets",["19"],{},"patch-admins-password_resets","Reset an admin's password.","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"admins",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41"},[],[],[],[],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"3cf7f63d03d5a","fb2ad9f623c17","200",[],[],"OK","533adbd2e6279","401",[],["48"],"Unauthorized","997f1b490586a",["49"],{"id":"50","key":"51","extensions":"52","description":"53","type":"54","name":"55","in":"56"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"57","path":"58","port":"59","protocol":"60"},{"id":"61","mediaType":"62","examples":"63","encodings":"64","schema":"65"},{"id":"66","mediaType":"62","examples":"67","encodings":"68","schema":"69"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"70","description":"71"},{"default":"72","description":"73"},{"default":"74","description":"75"},{"default":"76","description":"77","enum":"78"},"d75abbb6ac388","application/json",["79","80","81"],[],{"type":"82","properties":"83","required":"84","title":"85","$schema":"86","x-stoplight":"87"},"4d5c62db44334",["88"],[],{"type":"82","properties":"89","$schema":"86","x-stoplight":"90"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["76","91"],{"id":"92","key":"93","value":"94","summary":"95"},{"id":"96","key":"97","value":"98","summary":"99"},{"id":"100","key":"101","value":"102","summary":"103"},"object",{"status":"104","message":"105"},["106","107"],"UnauthorizedError","http://json-schema.org/draft-07/schema#",{"id":"108"},{"id":"109","key":"110","value":"111"},{"email":"112","password":"113","token":"114"},{"id":"115"},"https","e5a3fa6150469","DuplicateApiKey",{"message":"95","status":401},"Duplicate API key found","aa9b5f0dc16c2","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","e5821b7033e0f","NoAPIKey",{"message":"116","status":401},"No API key found",{"type":"117"},{"type":"118"},"status","message","470b68e5f0549","59b81addf0fe9","Example 1",{"email":"118","password":"118","token":"118"},{"type":"118"},{"type":"118"},{"type":"118"},"509a4427abf1b","No API key found in request","integer","string"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-admins-name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Retrieve an Admin",["18"],"00c4cbbf04f4c","get","/admins/{name_or_id}",["19"],{},"get-admins-name_or_id","Retrieve an admin using their name or ID. Using `generate_register_url`, you can generate a unique registration URL if the admin's invitation status is `4`. `generate_register_url` overrides the previous registration URL for the particular admin each time it is requested.","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"admins",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33"],["34"],{"id":"35","url":"36","name":"37","description":"38","variables":"39"},"3cf7f63d03d5a","55c617698db6c","200",[],["40"],"OK",{"id":"41","name":"42","style":"43","examples":"44","description":"45","required":true,"schema":"46","explicitProperties":"47"},{"id":"48","key":"49","extensions":"50","description":"51","type":"52","name":"53","in":"54"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"55","path":"56","port":"57","protocol":"58"},{"id":"59","mediaType":"60","examples":"61","encodings":"62","schema":"63"},"e73dce076e46f","name_or_id","simple",[],"The admin’s username or ID.",{"type":"64","$schema":"65","x-stoplight":"66"},["67","68","69","70","71"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"72","description":"73"},{"default":"74","description":"75"},{"default":"76","description":"77"},{"default":"78","description":"79","enum":"80"},"950db53559c42","application/json",["81"],[],{"type":"82","properties":"83","x-examples":"84","$schema":"65","x-stoplight":"85"},"string","http://json-schema.org/draft-07/schema#",{"id":"86"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["78","87"],{"id":"88","key":"89","value":"90"},"object",{"created_at":"91","id":"92","updated_at":"93","status":"94","username":"95","email":"96","rbac_token_enabled":"97"},{"Example 1":"98"},{"id":"99"},"702b6eaed6ee2","https","02e6428398608","Example response body",{"created_at":1556638385,"id":"100","updated_at":1556638385,"status":4,"username":"101","email":"102","rbac_token_enabled":true},{"type":"103"},{"type":"64"},{"type":"103"},{"type":"103"},{"type":"64"},{"type":"64"},{"type":"104"},{"created_at":1556638385,"id":"100","updated_at":1556638385,"status":4,"username":"101","email":"102","rbac_token_enabled":true},"c1ff53bdf8e40","665b4070-541f-48bf-82c1-53030babaa81","test-admin","test@test.com","integer","boolean"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/patch-admins-name_or_id-generate_register_url",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update an Admin",["18"],"3494761300c15","patch","/admins/{name_or_id}",["19"],{},"patch-admins-name_or_id-generate_register_url","Update information about an admin","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"admins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35"},[],[],[],["36"],["37"],{"id":"38","url":"39","name":"40","description":"41","variables":"42"},"3cf7f63d03d5a","060509dea6e9f","200",[],[],"OK","674f067ab2d8e",["43"],{"id":"44","name":"45","style":"46","examples":"47","description":"48","required":true,"schema":"49","explicitProperties":"50"},{"id":"51","key":"52","extensions":"53","description":"54","type":"55","name":"56","in":"57"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"58","path":"59","port":"60","protocol":"61"},{"id":"62","mediaType":"63","examples":"64","encodings":"65","schema":"66"},"2d3f2c6bf1d71","name_or_id","simple",[],"The admin’s username or ID.",{"type":"67","$schema":"68","x-stoplight":"69"},["70","71","72","73","74"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"75","description":"76"},{"default":"77","description":"78"},{"default":"79","description":"80"},{"default":"81","description":"82","enum":"83"},"c1564b07df672","application/json",["84"],[],{"type":"85","properties":"86","x-examples":"87","$schema":"68","x-stoplight":"88"},"string","http://json-schema.org/draft-07/schema#",{"id":"89"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["81","90"],{"id":"91","key":"92","value":"93"},"object",{"name_or_id":"94","username":"95","email":"96","rbac_token_enabled":"97"},{"Example 1":"98"},{"id":"99"},"cbcde05e9938e","https","0b543d95539c3","Example 1",{"name_or_id":"67","username":"67","email":"67","rbac_token_enabled":true},{"type":"67"},{"type":"67"},{"type":"67"},{"type":"100"},{"name_or_id":"101","username":"102","email":"103","rbac_token_enabled":true},"f170127ac722c","boolean","665b4070-541f-48bf-82c1-53030babaa81","test-renamed","test@test.com"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-admins-name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete an Admin",["18"],"ed7c40700c330","delete","/admins/{name_or_id}",["19"],{},"delete-admins-name_or_id","Delete an admin by specifying the admin's username or ID.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"admins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"3cf7f63d03d5a","a0542b34708fe","204",[],[],"No Content","48842957aef71","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},{"id":"65","mediaType":"66","examples":"67","encodings":"68","schema":"69"},"2539dfd0e692c","name_or_id","simple",[],"The admin’s username or ID.",{"type":"70","$schema":"71","x-stoplight":"72"},["73","74","75","76","77"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"78","description":"79"},{"default":"80","description":"81"},{"default":"82","description":"83"},{"default":"84","description":"85","enum":"86"},"d78d455d28062","application/json",["87","88","89"],[],{"type":"90","properties":"91","required":"92","title":"93","$schema":"71","x-stoplight":"94"},"string","http://json-schema.org/draft-07/schema#",{"id":"95"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["84","96"],{"id":"97","key":"98","value":"99","summary":"100"},{"id":"101","key":"102","value":"103","summary":"104"},{"id":"105","key":"106","value":"107","summary":"108"},"object",{"status":"109","message":"110"},["111","112"],"UnauthorizedError",{"id":"113"},"7dd3369ff3902","https","6b52db1e43513","DuplicateApiKey",{"message":"100","status":401},"Duplicate API key found","eb53850eb766e","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","68a2da2a21937","NoAPIKey",{"message":"114","status":401},"No API key found",{"type":"115"},{"type":"70"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-admins-name_or_id-roles",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List an Admin’s Roles",["18"],"b6686e218ef13","get","/admins/{name_or_id}/roles",["19"],{},"get-admins-name_or_id-roles","List all roles related to a registered admin.","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"admins",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33"],["34"],{"id":"35","url":"36","name":"37","description":"38","variables":"39"},"3cf7f63d03d5a","893f0791dc2f4","200",[],["40"],"OK",{"id":"41","name":"42","style":"43","examples":"44","description":"45","required":true,"schema":"46","explicitProperties":"47"},{"id":"48","key":"49","extensions":"50","description":"51","type":"52","name":"53","in":"54"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"55","path":"56","port":"57","protocol":"58"},{"id":"59","mediaType":"60","examples":"61","encodings":"62","schema":"63"},"e2bbcc4500961","name_or_id","simple",[],"The admin’s username or ID",{"type":"64","$schema":"65","x-stoplight":"66"},["67","68","69","70","71"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"72","description":"73"},{"default":"74","description":"75"},{"default":"76","description":"77"},{"default":"78","description":"79","enum":"80"},"eb1437f03271c","application/json",["81"],[],{"type":"82","properties":"83","x-examples":"84","$schema":"65","x-stoplight":"85"},"string","http://json-schema.org/draft-07/schema#",{"id":"86"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["78","87"],{"id":"88","key":"89","value":"90"},"object",{"roles":"91"},{"Example 1":"92"},{"id":"93"},"52424866ee62f","https","ed3c89246de56","Example role list",{"roles":"94"},{"type":"95","items":"96"},{"roles":"97"},"9bc0f8ed92b12",["98","99"],"array",{"type":"82","properties":"100"},["101","102"],{"comment":"103","created_at":1556563122,"id":"104","name":"105","is_default":false},{"comment":"106","created_at":1556563122,"id":"107","name":"108","is_default":false},{"comment":"109","created_at":"110","id":"111","name":"112","is_default":"113"},{"comment":"103","created_at":1556563122,"id":"104","name":"105","is_default":false},{"comment":"106","created_at":1556563122,"id":"107","name":"108","is_default":false},"Read access to all endpoints, across all workspaces","7574eb1d-c9fa-46a9-bd3a-3f1b4b196287","read-only","Full access to all endpoints, across all workspaces—except RBAC Admin API","7fdea5c8-2bfa-4aa9-9c21-7bb9e607186d","admin",{"type":"64"},{"type":"114"},{"type":"64"},{"type":"64"},{"type":"115"},"integer","boolean"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-admins-name_or_id-roles",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create or Update an Admin’s Roles",["18"],"7d59940dae874","post","/admins/{name_or_id}/roles",["19"],{},"post-admins-name_or_id-roles","Create or update roles for an admin","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"admins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35","description":"36"},[],[],[],["37"],["38"],{"id":"39","url":"40","name":"41","description":"42","variables":"43"},"3cf7f63d03d5a","bd4aa1ff3ae63","201",[],["44"],"Created","3bd90e1c721af",["45"],"Comma-separated string of role names to create or update for an admin.",{"id":"46","name":"47","style":"48","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},{"id":"64","mediaType":"65","examples":"66","encodings":"67","schema":"68"},{"id":"69","mediaType":"65","examples":"70","encodings":"71","schema":"72"},"bf5a3506863aa","name_or_id","simple",[],"The admin’s username or ID",{"type":"73","$schema":"74","x-stoplight":"75"},["76","77","78","79","80"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88","enum":"89"},"a0c5869e8d593","application/json",["90"],[],{"type":"91","properties":"92","x-examples":"93","$schema":"74","x-stoplight":"94"},"9dda4a274e0e8",[],[],{"type":"91","properties":"95","x-examples":"96","$schema":"74","x-stoplight":"97"},"string","http://json-schema.org/draft-07/schema#",{"id":"98"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["87","99"],{"id":"100","key":"101","value":"102"},"object",{"roles":"103"},{"Example 1":"104"},{"id":"105"},{"roles":"106"},{"Example 1":"107"},{"id":"108"},"45a07195a84f7","https","b741a07648b6c","Example role assignment",{"roles":"109"},{"type":"110","items":"111"},{"roles":"112"},"10168237dadf5",{"type":"73"},{"roles":"113"},"d07d88a915995",["114","115","116"],"array",{"type":"91","properties":"117"},["118","119","120"],"read-only",{"comment":"121","created_at":1556563122,"id":"122","name":"113","is_default":false},{"comment":"123","created_at":1556563122,"id":"124","name":"125","is_default":false},{"comment":"126","created_at":1556563122,"id":"127","name":"128","is_default":false},{"comment":"129","created_at":"130","id":"131","name":"132","is_default":"133"},{"comment":"121","created_at":1556563122,"id":"122","name":"113","is_default":false},{"comment":"123","created_at":1556563122,"id":"124","name":"125","is_default":false},{"comment":"126","created_at":1556563122,"id":"127","name":"128","is_default":false},"Read access to all endpoints, across all workspaces","7574eb1d-c9fa-46a9-bd3a-3f1b4b196287","Full access to all endpoints, across all workspaces—except RBAC Admin API","7fdea5c8-2bfa-4aa9-9c21-7bb9e607186d","admin","Full access to all endpoints, across all workspaces","99bd8d18-f5b6-410e-aefe-d75f4252f13c","super-admin",{"type":"73"},{"type":"134"},{"type":"73"},{"type":"73"},{"type":"135"},"integer","boolean"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-admins-name_or_id-roles",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete an Admin’s Role",["18"],"3c0cbfcf2dfe9","delete","/admins/{name_or_id}/roles",["19"],{},"delete-admins-name_or_id-roles","Delete an admin's roles by passing a comma-separated string of names of specific roles to remove from an admin.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"admins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"3cf7f63d03d5a","3a3e681f898a5","204",[],[],"No Content","750e677700265","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},{"id":"65","mediaType":"66","examples":"67","encodings":"68","schema":"69"},"a2efbcb6c9e53","name_or_id","simple",[],"The admin’s username or ID",{"type":"70","$schema":"71","x-stoplight":"72"},["73","74","75","76","77"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"78","description":"79"},{"default":"80","description":"81"},{"default":"82","description":"83"},{"default":"84","description":"85","enum":"86"},"c5ca397213d10","application/json",["87","88","89"],[],{"type":"90","properties":"91","required":"92","title":"93","$schema":"71","x-stoplight":"94"},"string","http://json-schema.org/draft-07/schema#",{"id":"95"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["84","96"],{"id":"97","key":"98","value":"99","summary":"100"},{"id":"101","key":"102","value":"103","summary":"104"},{"id":"105","key":"106","value":"107","summary":"108"},"object",{"status":"109","message":"110"},["111","112"],"UnauthorizedError",{"id":"113"},"7324c1e9ef7fc","https","76265b292ba93","DuplicateApiKey",{"message":"100","status":401},"Duplicate API key found","7aac76d1aba34","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","4e8c16ba4a788","NoAPIKey",{"message":"114","status":401},"No API key found",{"type":"115"},{"type":"70"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-admins-name_or_id-workspaces",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List an Admin’s Workspaces",["18"],"bc0fda859fd9e","get","/admins/{name_or_id}/workspaces",["19"],{},"get-admins-name_or_id-workspaces","Return workspaces associated with an admin.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"admins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"3cf7f63d03d5a","a164cea600636","200",[],["46"],"The workspace response object.","d3f4cdfd693b0","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","key":"56","extensions":"57","description":"58","type":"59","name":"60","in":"61"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"62","path":"63","port":"64","protocol":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},"b9698a29fce6e","name_or_id","simple",[],"The admin’s username or ID",{"type":"75","$schema":"76","x-stoplight":"77"},["78","79","80","81","82"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88"},{"default":"89","description":"90","enum":"91"},"e42928d4c641d","application/json",[],[],{"type":"92","properties":"93","x-examples":"94","description":"95","title":"96"},"ed772e835ef47",["97","98","99"],[],{"type":"92","properties":"100","required":"101","title":"102","$schema":"76","x-stoplight":"103"},"string","http://json-schema.org/draft-07/schema#",{"id":"104"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["89","105"],"object",{"comment":"106","config":"107","created_at":"108","id":"109","meta":"110","name":"111"},{"Example 1":"112"},"Workspaces provide a way to segment Kong entities.","Workspace",{"id":"113","key":"114","value":"115","summary":"116"},{"id":"117","key":"118","value":"119","summary":"120"},{"id":"121","key":"122","value":"123","summary":"124"},{"status":"125","message":"126"},["127","128"],"UnauthorizedError",{"id":"129"},"cf8aa1e6b9f30","https",{"type":"75"},{"type":"92","properties":"130"},{"description":"131","type":"132"},{"type":"75","description":"133"},{"type":"92","properties":"134"},{"type":"75"},{"comment":"75","config":"135","created_at":0,"id":"75","meta":"136","name":"75"},"44ed7475eda47","DuplicateApiKey",{"message":"116","status":401},"Duplicate API key found","cd3f13c20730e","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","a792beb020f7e","NoAPIKey",{"message":"137","status":401},"No API key found",{"type":"132"},{"type":"75"},"status","message","470b68e5f0549",{"meta":"138","portal":"139","portal_access_request_email":"140","portal_application_request_email":"141","portal_application_status_email":"142","portal_approved_email":"143","portal_auth":"144","portal_auth_conf":"145","portal_auto_approve":"146","portal_cors_origins":"147","portal_developer_meta_fields":"148","portal_emails_from":"149","portal_emails_reply_to":"150","portal_invite_email":"151","portal_is_legacy":"152","portal_reset_email":"153","portal_reset_success_email":"154","portal_session_conf":"155","portal_smtp_admin_emails":"156","portal_token_exp":"157"},"Unix epoch when the resource was created.","integer","The unique UUID for this resource.",{"color":"158","thumbnail":"159"},{"meta":"160","portal":false,"portal_access_request_email":true,"portal_application_request_email":true,"portal_application_status_email":true,"portal_approved_email":true,"portal_auth":"75","portal_auth_conf":"75","portal_auto_approve":true,"portal_cors_origins":"161","portal_developer_meta_fields":"162","portal_emails_from":"75","portal_emails_reply_to":"75","portal_invite_email":true,"portal_is_legacy":true,"portal_reset_email":true,"portal_reset_success_email":true,"portal_session_conf":"75","portal_smtp_admin_emails":"163","portal_token_exp":0},{"color":"75","thumbnail":"75"},"No API key found in request",{"type":"92"},{"default":false,"type":"164","description":"165"},{"type":"164"},{"type":"164"},{"type":"164"},{"type":"164"},{"type":"75"},{"type":"75"},{"type":"164"},{"type":"166","items":"167"},{"default":"162","type":"75"},{"type":"75"},{"type":"75"},{"type":"164"},{"type":"164"},{"type":"164"},{"type":"164"},{"type":"75"},{"type":"166","items":"168"},{"type":"132"},{"type":"75"},{"type":"75"},{},["75"],"[{\"label\":\"Full Name\",\"title\":\"full_name\",\"validator\":{\"required\":true,\"type\":\"string\"}}]",["75"],"boolean","Portal enabled","array",{"type":"75"},{"type":"75"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/patch-admins-name_or_id-workspaces-workspace_name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update an Admin's Workspace",["18"],"d78f530e13d96","patch","/admins/{name_or_id}/workspaces/{workspace_name_or_id}",["19"],{},"patch-admins-name_or_id-workspaces-workspace_name_or_id","Change the `belong_workspace` property for the specified admin.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"admins",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"3cf7f63d03d5a","f764f9c185335","200",[],["47"],"OK","2a14f935d5790","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","required":true,"schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","key":"63","extensions":"64","description":"65","type":"66","name":"67","in":"68"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"69","path":"70","port":"71","protocol":"72"},{"id":"73","mediaType":"74","examples":"75","encodings":"76","schema":"77"},{"id":"78","mediaType":"74","examples":"79","encodings":"80","schema":"81"},"3aca9e75ead9d","name_or_id","simple",[],"The admin’s username or ID",{"type":"82","$schema":"83","x-stoplight":"84"},["85","86","87","88","89"],"264cbc46d8eb2","workspace_name_or_id",[],"The name or ID of the admin's new workspace.",{"type":"82","$schema":"83","x-stoplight":"90"},["85","86","87","88","89"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"c0d39d5b66cd6","application/json",["100"],[],{"type":"101","properties":"102","x-examples":"103","$schema":"83","x-stoplight":"104"},"9d792439066d7",["105","106","107"],[],{"type":"101","properties":"108","required":"109","title":"110","$schema":"83","x-stoplight":"111"},"string","http://json-schema.org/draft-07/schema#",{"id":"112"},"schema","name","in","required","description",{"id":"113"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","114"],{"id":"115","key":"116","value":"117"},"object",{"created_at":"118","id":"119","updated_at":"120","status":"121","username":"122","email":"123","rbac_token_enabled":"124"},{"Example 1":"125"},{"id":"126"},{"id":"127","key":"128","value":"129","summary":"130"},{"id":"131","key":"132","value":"133","summary":"134"},{"id":"135","key":"136","value":"137","summary":"138"},{"status":"139","message":"140"},["141","142"],"UnauthorizedError",{"id":"143"},"55c1db800ff2c","48cdaf9e4d0af","https","608e7f123f148","Example response body",{"created_at":1556638385,"id":"144","updated_at":1556638385,"status":4,"username":"145","email":"146","rbac_token_enabled":true},{"type":"147"},{"type":"82"},{"type":"147"},{"type":"147"},{"type":"82"},{"type":"82"},{"type":"148"},{"created_at":1556638385,"id":"144","updated_at":1556638385,"status":4,"username":"145","email":"146","rbac_token_enabled":true},"22e007ebf1c30","fa2908798f12b","DuplicateApiKey",{"message":"130","status":401},"Duplicate API key found","db027f8520bb5","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","489001d3bb982","NoAPIKey",{"message":"149","status":401},"No API key found",{"type":"147"},{"type":"82"},"status","message","470b68e5f0549","665b4070-541f-48bf-82c1-53030babaa81","test-admin","test@test.com","integer","boolean","No API key found in request"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-groups",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List Groups",["18"],"c71bc1bbfda2e","get","/groups",["19"],{},"get-groups","Returns a list of groups.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"f68063f3fc87c","792d4736c8c49","200",[],["45"],"Example response","d15d49138b7ba","401",[],["46"],"Unauthorized",{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},{"id":"63","mediaType":"59","examples":"64","encodings":"65","schema":"66"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"070f735963b33","application/json",[],[],{"type":"76","x-examples":"77","properties":"78","$schema":"79","x-stoplight":"80"},"b0502b32c7e48",["81","82","83"],[],{"type":"76","properties":"84","required":"85","title":"86","$schema":"79","x-stoplight":"87"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","88"],"object",{"Example 1":"89"},{"data":"90","next":"91"},"http://json-schema.org/draft-07/schema#",{"id":"92"},{"id":"93","key":"94","value":"95","summary":"96"},{"id":"97","key":"98","value":"99","summary":"100"},{"id":"101","key":"102","value":"103","summary":"104"},{"status":"105","message":"106"},["107","108"],"UnauthorizedError",{"id":"109"},"https",{"data":"110","next":null},{"type":"111","items":"112"},{"nullable":true},"96b20e3a530a7","01fca829f0a5a","DuplicateApiKey",{"message":"96","status":401},"Duplicate API key found","59b2eea3ca35e","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","1be13aab259c3","NoAPIKey",{"message":"113","status":401},"No API key found",{"type":"114"},{"type":"115"},"status","message","470b68e5f0549",["116","117"],"array",{"type":"76","properties":"118"},"No API key found in request","integer","string",{"created_at":1717123483,"id":"119","updated_at":1717123483,"name":"120","comment":"121"},{"created_at":1717123637,"id":"122","updated_at":1717123637,"name":"123","comment":"124"},{"created_at":"125","id":"126","updated_at":"127","name":"128","comment":"129"},"4844ded2-06d1-44f5-974a-03982696f889","group1","comment1","65b3d436-3c5b-4b0e-a2a5-ee188d526ad8","group2","comment2",{"type":"114"},{"type":"115"},{"type":"114"},{"type":"115"},{"type":"115"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-groups",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create a new group",["18"],"b3f0e9efe34d5","post","/groups",["19"],{},"post-groups","Create a group to your organization.","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35"},[],[],[],[],["36"],{"id":"37","url":"38","name":"39","description":"40","variables":"41"},"f68063f3fc87c","022e076448367","200",[],["42"],"OK","0a1d10c1cf5cf",["43"],{"id":"44","key":"45","extensions":"46","description":"47","type":"48","name":"49","in":"50"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"51","path":"52","port":"53","protocol":"54"},{"id":"55","mediaType":"56","examples":"57","encodings":"58","schema":"59"},{"id":"60","mediaType":"56","examples":"61","encodings":"62","schema":"63"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"64","description":"65"},{"default":"66","description":"67"},{"default":"68","description":"69"},{"default":"70","description":"71","enum":"72"},"de40c85c86d7d","application/json",["73"],[],{"type":"74","properties":"75","x-examples":"76","$schema":"77","x-stoplight":"78"},"7eadd5594ac91",["79"],[],{"type":"74","properties":"80","$schema":"77","x-stoplight":"81"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["70","82"],{"id":"83","key":"84","value":"85"},"object",{"created_at":"86","id":"87","updated_at":"88","name":"89","comment":"90"},{"Example 1":"91"},"http://json-schema.org/draft-07/schema#",{"id":"92"},{"id":"93","key":"94","value":"95"},{"name":"96"},{"id":"97"},"https","46c2287d3e1dc","Example group response",{"created_at":0,"id":"98","updated_at":0,"name":"98","comment":"98"},{"type":"99"},{"type":"98"},{"type":"99"},{"type":"98"},{"type":"98"},{"created_at":1556638641,"id":"100","updated_at":1556638641,"name":"101","comment":"102"},"2935b6ae6fd69","dc12fc58672a5","Create a group",{"name":"101","comment":"102"},{"type":"98","description":"103","examples":"104"},"5db16286f1ad8","string","integer","8f0a742f-07f3-49e0-90d7-4fc7eea7e897","demo-group","comment","The group's name",["105"],"my_group"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-groups-name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Retrieve a Group",["18"],"eeaa3958fd1f9","get","/groups/{name_or_id}",["19"],{},"get-groups-name_or_id","Retrieve a group using their name or ID.","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"groups",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33"],["34"],{"id":"35","url":"36","name":"37","description":"38","variables":"39"},"f68063f3fc87c","afc43e4ec973d","200",[],["40"],"OK",{"id":"41","name":"42","style":"43","examples":"44","description":"45","required":true,"schema":"46","explicitProperties":"47"},{"id":"48","key":"49","extensions":"50","description":"51","type":"52","name":"53","in":"54"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"55","path":"56","port":"57","protocol":"58"},{"id":"59","mediaType":"60","examples":"61","encodings":"62","schema":"63"},"8bcaec539432f","name_or_id","simple",[],"The group’s name or ID.",{"type":"64","$schema":"65","x-stoplight":"66"},["67","68","69","70","71"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"72","description":"73"},{"default":"74","description":"75"},{"default":"76","description":"77"},{"default":"78","description":"79","enum":"80"},"5e188fa1b5a20","application/json",["81"],[],{"type":"82","properties":"83","x-examples":"84","$schema":"65","x-stoplight":"85"},"string","http://json-schema.org/draft-07/schema#",{"id":"86"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["78","87"],{"id":"88","key":"89","value":"90"},"object",{"created_at":"91","id":"92","updated_at":"93","name":"94","comment":"95"},{"Example 1":"96"},{"id":"97"},"48bce289c8d91","https","a77d8bb49b070","Example response body",{"created_at":1556638385,"id":"98","updated_at":1556638385,"username":"99","comment":"100"},{"type":"101"},{"type":"64"},{"type":"101"},{"type":"64"},{"type":"64"},{"created_at":1556638385,"id":"98","updated_at":1556638385,"name":"99","comment":"102"},"e275e7b1ef4a6","665b4070-541f-48bf-82c1-53030babaa81","test-group","comment","integer","comment1"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/patch-groups-name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a Group",["18"],"da02e1a1cd5a0","patch","/groups/{name_or_id}",["19"],{},"patch-groups-name_or_id","Update information about a group","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35"},[],[],[],["36"],["37"],{"id":"38","url":"39","name":"40","description":"41","variables":"42"},"f68063f3fc87c","9ff4e78462558","200",[],[],"OK","26e53a1c29561",["43"],{"id":"44","name":"45","style":"46","examples":"47","description":"48","required":true,"schema":"49","explicitProperties":"50"},{"id":"51","key":"52","extensions":"53","description":"54","type":"55","name":"56","in":"57"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"58","path":"59","port":"60","protocol":"61"},{"id":"62","mediaType":"63","examples":"64","encodings":"65","schema":"66"},"1f388388fbe3f","name_or_id","simple",[],"The group’s name or ID.",{"type":"67","$schema":"68","x-stoplight":"69"},["70","71","72","73","74"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"75","description":"76"},{"default":"77","description":"78"},{"default":"79","description":"80"},{"default":"81","description":"82","enum":"83"},"1f4d20c30cc5a","application/json",["84"],[],{"type":"85","properties":"86","x-examples":"87","$schema":"68","x-stoplight":"88"},"string","http://json-schema.org/draft-07/schema#",{"id":"89"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["81","90"],{"id":"91","key":"92","value":"93"},"object",{"name":"94","comment":"95"},{"Example 1":"96"},{"id":"97"},"a41ceb7628907","https","5400109113e1c","Example 1",{"name":"67","comment":"67"},{"type":"67"},{"type":"67"},{"name":"98","comment":"99"},"1814b21c7ec3f","test-group","comment1"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-groups-name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete an Group",["18"],"bcbd665589fbb","delete","/groups/{name_or_id}",["19"],{},"delete-groups-name_or_id","Delete a group by specifying the group's name or ID.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"f68063f3fc87c","ae196f83d0a49","204",[],[],"No Content","56296da70e81a","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},{"id":"65","mediaType":"66","examples":"67","encodings":"68","schema":"69"},"f0b30a0f0fc76","name_or_id","simple",[],"The group’s name or ID.",{"type":"70","$schema":"71","x-stoplight":"72"},["73","74","75","76","77"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"78","description":"79"},{"default":"80","description":"81"},{"default":"82","description":"83"},{"default":"84","description":"85","enum":"86"},"f474eef9c4c15","application/json",["87","88","89"],[],{"type":"90","properties":"91","required":"92","title":"93","$schema":"71","x-stoplight":"94"},"string","http://json-schema.org/draft-07/schema#",{"id":"95"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["84","96"],{"id":"97","key":"98","value":"99","summary":"100"},{"id":"101","key":"102","value":"103","summary":"104"},{"id":"105","key":"106","value":"107","summary":"108"},"object",{"status":"109","message":"110"},["111","112"],"UnauthorizedError",{"id":"113"},"693dcaf10a0ba","https","fe7168903fe0f","DuplicateApiKey",{"message":"100","status":401},"Duplicate API key found","a06166231f202","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","e1c03d53d80b8","NoAPIKey",{"message":"114","status":401},"No API key found",{"type":"115"},{"type":"70"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-groups-name_or_id-roles",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List an Group’s Roles",["18"],"f87d7073ea57e","get","/groups/{name_or_id}/roles",["19"],{},"get-groups-name_or_id-roles","List all roles related to a group.","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"groups",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33"],["34"],{"id":"35","url":"36","name":"37","description":"38","variables":"39"},"f68063f3fc87c","62474529ec66b","200",[],["40"],"OK",{"id":"41","name":"42","style":"43","examples":"44","description":"45","required":true,"schema":"46","explicitProperties":"47"},{"id":"48","key":"49","extensions":"50","description":"51","type":"52","name":"53","in":"54"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"55","path":"56","port":"57","protocol":"58"},{"id":"59","mediaType":"60","examples":"61","encodings":"62","schema":"63"},"893aef0d77173","name_or_id","simple",[],"The group’s username or ID",{"type":"64","$schema":"65","x-stoplight":"66"},["67","68","69","70","71"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"72","description":"73"},{"default":"74","description":"75"},{"default":"76","description":"77"},{"default":"78","description":"79","enum":"80"},"999171748fe01","application/json",["81"],[],{"type":"82","properties":"83","x-examples":"84","$schema":"65","x-stoplight":"85"},"string","http://json-schema.org/draft-07/schema#",{"id":"86"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["78","87"],{"id":"88","key":"89","value":"90"},"object",{"data":"91"},{"Example 1":"92"},{"id":"93"},"241947fe3e62b","https","add5451900a9c","Example role list",{"data":"94"},{"type":"95","items":"96"},{"data":"97"},"d059b328e0955",["98"],"array",{"type":"82","properties":"99"},["100"],{"group":"101","rbac_role":"102","workspace":"103"},{"group":"104","rbac_role":"105","workspace":"106","next":"107"},{"group":"108","rbac_role":"109","workspace":"110"},{"comment":"111","created_at":1556563122,"id":"112","name":"113"},{"id":"114","name":"115"},{"id":"116"},{"type":"82","properties":"117"},{"type":"82","properties":"118"},{"type":"82","properties":"119"},{"nullable":true},{"comment":"111","created_at":1556563122,"id":"112","name":"113"},{"id":"114","name":"115"},{"id":"116"},"comment1","7574eb1d-c9fa-46a9-bd3a-3f1b4b196287","demo-group","7fdea5c8-2bfa-4aa9-9c21-7bb9e607186d","admin","99bd8d18-f5b6-410e-aefe-d75f4252f13c",{"id":"120","name":"121","comment":"122","updated_at":"123"},{"id":"124","name":"125"},{"id":"126"},{"type":"64"},{"type":"64"},{"type":"64"},{"type":"64","format":"127"},{"type":"64"},{"type":"64"},{"type":"64"},"date-time"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-groups-name_or_id-roles",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create or Update a Group's Roles",["18"],"9d03102e609e0","post","/groups/{name_or_id}/roles",["19"],{},"post-groups-name_or_id-roles","Create or update roles for a admin","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35","description":"36"},[],[],[],["37"],["38"],{"id":"39","url":"40","name":"41","description":"42","variables":"43"},"f68063f3fc87c","18fa91d47aa94","201",[],["44"],"Created","972aa30ec13db",["45"],"Comma-separated string of role names to create or update for a group.",{"id":"46","name":"47","style":"48","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},{"id":"64","mediaType":"65","examples":"66","encodings":"67","schema":"68"},{"id":"69","mediaType":"65","examples":"70","encodings":"71","schema":"72"},"04760662d8bff","name_or_id","simple",[],"The group’s username or ID",{"type":"73","$schema":"74","x-stoplight":"75"},["76","77","78","79","80"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88","enum":"89"},"edeaffa3a8b41","application/json",["90"],[],{"type":"91","properties":"92","x-examples":"93","$schema":"74","x-stoplight":"94"},"2cd8eefc45add",[],[],{"type":"91","properties":"95","x-examples":"96","$schema":"74","x-stoplight":"97"},"string","http://json-schema.org/draft-07/schema#",{"id":"98"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["87","99"],{"id":"100","key":"101","value":"102"},"object",{"group":"103","rbac_role":"104","workspace":"105"},{"Example 1":"106"},{"id":"107"},{"rbac_role_id":"108","workspace_id":"109"},{"Example 1":"110"},{"id":"111"},"785582f8df220","https","20307c16753fb","Example role assignment",{"group":"112","rbac_role":"113","workspace":"114"},{"type":"91","properties":"115"},{"type":"91","properties":"116"},{"type":"91","properties":"117"},{"group":"118","rbac_role":"119","workspace":"120"},"cd6f1d8033b91",{"type":"73"},{"type":"73"},{"rbac_role_id":"121","workspace_id":"122"},"56cf23ab87e2d",{"comment":"123","created_at":1556563122,"id":"124","name":"125","is_default":false},{"id":"126","name":"127"},{"id":"128"},{"id":"129","name":"130","comment":"131","updated_at":"132"},{"id":"133","name":"134"},{"id":"135"},{"comment":"123","created_at":1556563122,"id":"124","name":"125","is_default":false},{"id":"126","name":"127"},{"id":"128"},"12773c9a-7f7c-45f2-bcea-5285eb18fd2f","d107bce7-dd86-4124-93c8-667ecc34b32e","Read access to all endpoints, across all workspaces","7574eb1d-c9fa-46a9-bd3a-3f1b4b196287","read-only","7fdea5c8-2bfa-4aa9-9c21-7bb9e607186d","admin","99bd8d18-f5b6-410e-aefe-d75f4252f13c",{"type":"73"},{"type":"73"},{"type":"73"},{"type":"73","format":"136"},{"type":"73"},{"type":"73"},{"type":"73"},"date-time"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-groups-name_or_id-roles",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a group’s Role",["18"],"e594aebcecd4e","delete","/groups/{name_or_id}/roles",["19"],{},"delete-groups-name_or_id-roles","Delete a group's roles.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"groups",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40"],[],["41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"f68063f3fc87c","6e369619a98d9","204",[],[],"No Content","036696ab1917c","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"51","examples":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","name":"61","style":"62","examples":"63","description":"64","required":true,"schema":"65","explicitProperties":"66"},{"id":"67","key":"68","extensions":"69","description":"70","type":"71","name":"72","in":"73"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"74","path":"75","port":"76","protocol":"77"},{"id":"78","mediaType":"79","examples":"80","encodings":"81","schema":"82"},"59b941d6fe5e6","rbac_role_id","form",["83"],{"type":"84","examples":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92"],"5332dd376fcd7","workspace_id",["93"],{"type":"84","examples":"94","$schema":"86","x-stoplight":"95"},["88","89","90","91","92"],"9573fc984e075","name_or_id","simple",[],"The group’s username or ID",{"type":"84","$schema":"86","x-stoplight":"96"},["91","88","89","90","97"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"98","description":"99"},{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105","enum":"106"},"c3add2021611b","application/json",["107","108","109"],[],{"type":"110","properties":"111","required":"112","title":"113","$schema":"86","x-stoplight":"114"},{"id":"115","value":"116","key":"117"},"string",["116"],"http://json-schema.org/draft-07/schema#",{"id":"118"},"name","in","required","schema","example",{"id":"119","value":"120","key":"117"},["120"],{"id":"121"},{"id":"122"},"description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["104","123"],{"id":"124","key":"125","value":"126","summary":"127"},{"id":"128","key":"129","value":"130","summary":"131"},{"id":"132","key":"133","value":"134","summary":"135"},"object",{"status":"136","message":"137"},["138","139"],"UnauthorizedError",{"id":"140"},"485fdff880e8a","12773c9a-7f7c-45f2-bcea-5285eb18fd2f","default","7df5922192568","1b734ed293515","d107bce7-dd86-4124-93c8-667ecc34b32e","a459566a46207","4f65d9941963a","https","388d1fa207d38","DuplicateApiKey",{"message":"127","status":401},"Duplicate API key found","5ddb992d06fb8","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","b12de7296b893","NoAPIKey",{"message":"141","status":401},"No API key found",{"type":"142"},{"type":"84"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/put-debug-cluster-control-planes-nodes-log-level-log_level",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Set Node Log Level of All Control Plane Nodes",["18"],"f2657eaf0062a","put","/debug/cluster/control-planes-nodes/log-level/{log_level}",["19"],{},"put-debug-cluster-control-planes-nodes-log-level-log_level","Change the log level of all control plane nodes deployed in a hybrid (CP/DP) cluster.\nBe careful when changing the log level of a node to debug in a production environment because the disk could fill up quickly. As soon as the debug logging finishes, revert back to a higher level, such as notice.\nIt’s currently not possible to change the log level of data plane and DB-less nodes.\n\nThis endpoint can be protected with RBAC, and changes will be reflected in the audit logs. \nThe log level change is propagated to all Nginx workers of a node, including to newly spawned workers.\n\nLog levels are set in Kong’s configuration. Possible log levels in increasing order of severity: `debug`, `info`, `notice`, `warn`, `error`, and `crit`. For more information, review the [logging reference](https://docs.konghq.com/gateway/latest/production/logging/).\n\nWhen a user dynamically changes the log level for the entire cluster, if a new node joins the cluster, the new node will run at the previous log level, not at the log level that was previously set dynamically for the entire cluster. To work around that, make sure the new node starts with the proper level by setting the startup `kong.conf` setting [`KONG_LOG_LEVEL`](https://docs.konghq.com/gateway/latest/reference/configuration/#log_level).","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"debug",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"085fd651cfc0c","b9304a592d7be","200",[],[],"log level changed","4ea04aea9d60f","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},{"id":"65","mediaType":"66","examples":"67","encodings":"68","schema":"69"},"6016e1c2348ff","log_level","simple",[],"The log level",{"type":"70","enum":"71","$schema":"72","x-stoplight":"73"},["74","75","76","77","78"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86","enum":"87"},"d6378c53d1993","application/json",["88","89","90"],[],{"type":"91","properties":"92","required":"93","title":"94","$schema":"72","x-stoplight":"95"},"string",["18","96","97","98","99","100"],"http://json-schema.org/draft-07/schema#",{"id":"101"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["85","102"],{"id":"103","key":"104","value":"105","summary":"106"},{"id":"107","key":"108","value":"109","summary":"110"},{"id":"111","key":"112","value":"113","summary":"114"},"object",{"status":"115","message":"116"},["117","118"],"UnauthorizedError",{"id":"119"},"info","notice","warn","error","crit","56b42bb3c33d3","https","836ab83cd91c5","DuplicateApiKey",{"message":"106","status":401},"Duplicate API key found","18c85ee8e2c08","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","ccba295e9896e","NoAPIKey",{"message":"120","status":401},"No API key found",{"type":"121"},{"type":"70"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/put-debug-cluster-log-level-log_level",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Set Node Log Level of All Nodes",["18"],"1ff5698079bbe","put","/debug/cluster/log-level/{log_level}",["19"],{},"put-debug-cluster-log-level-log_level","Change the log level of all nodes in a cluster.\n\nBe careful when changing the log level of a node to debug in a production environment because the disk could fill up quickly. As soon as the debug logging finishes, revert back to a higher level, such as notice.\nIt’s currently not possible to change the log level of data plane and DB-less nodes.\n\nThis endpoint can be protected with RBAC, and changes will be reflected in the audit logs. \nThe log level change is propagated to all Nginx workers of a node, including to newly spawned workers.\n\nLog levels are set in Kong’s configuration. Possible log levels in increasing order of severity: `debug`, `info`, `notice`, `warn`, `error`, and `crit`. For more information, review the [logging reference](https://docs.konghq.com/gateway/latest/production/logging/).\n\nCurrently, when a user dynamically changes the log level for the entire cluster, if a new node joins the cluster, the new node will run at the previous log level, not at the log level that was previously set dynamically for the entire cluster. To work around that, make sure the new node starts with the proper level by setting the startup `kong.conf` setting [`KONG_LOG_LEVEL`](https://docs.konghq.com/gateway/latest/reference/configuration/#log_level).","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"debug",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"085fd651cfc0c","f953e96061ea6","200",[],[],"log level changed","c6a3ea08f768e","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},{"id":"65","mediaType":"66","examples":"67","encodings":"68","schema":"69"},"7f8f299e8caad","log_level","simple",[],"The log level",{"type":"70","enum":"71","$schema":"72","x-stoplight":"73"},["74","75","76","77","78"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86","enum":"87"},"4cbbfd1f7f092","application/json",["88","89","90"],[],{"type":"91","properties":"92","required":"93","title":"94","$schema":"72","x-stoplight":"95"},"string",["18","96","97","98","99","100"],"http://json-schema.org/draft-07/schema#",{"id":"101"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["85","102"],{"id":"103","key":"104","value":"105","summary":"106"},{"id":"107","key":"108","value":"109","summary":"110"},{"id":"111","key":"112","value":"113","summary":"114"},"object",{"status":"115","message":"116"},["117","118"],"UnauthorizedError",{"id":"119"},"info","notice","warn","error","crit","ea09678824dda","https","751dd3d5a909e","DuplicateApiKey",{"message":"106","status":401},"Duplicate API key found","673d3954c608f","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","a125853619a49","NoAPIKey",{"message":"120","status":401},"No API key found",{"type":"121"},{"type":"70"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-debug-node-log-level",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Retrieve Node Log Level of A Node",["18"],"414abe3ba2f3d","get","/debug/node/log-level",["19"],{},"get-debug-node-log-level","Retrieve the current log level of a node.\n\nSee the [Nginx Documentation](https://nginx.org/en/docs/ngx_core_module.html#error_log) for the list of possible return values.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"debug",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"085fd651cfc0c","2fdbea3a888f5","200",[],["45"],"OK","626be991f2371","401",[],["46"],"Unauthorized",{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},{"id":"63","mediaType":"59","examples":"64","encodings":"65","schema":"66"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"b618b9cdb5f77","application/json",["76"],[],{"type":"77","properties":"78","x-examples":"79","$schema":"80","x-stoplight":"81"},"99162d960e1c0",["82","83","84"],[],{"type":"77","properties":"85","required":"86","title":"87","$schema":"80","x-stoplight":"88"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","89"],{"id":"90","key":"91","value":"92"},"object",{"message":"93"},{"Example 1":"94"},"http://json-schema.org/draft-07/schema#",{"id":"95"},{"id":"96","key":"97","value":"98","summary":"99"},{"id":"100","key":"101","value":"102","summary":"103"},{"id":"104","key":"105","value":"106","summary":"107"},{"status":"108","message":"109"},["110","111"],"UnauthorizedError",{"id":"112"},"https","bd1a8bab5804d","Retrieved debug level",{"message":"113"},{"type":"113"},{"message":"114"},"2f5418035f631","40e9b873e84ee","DuplicateApiKey",{"message":"99","status":401},"Duplicate API key found","ad986d3213ba7","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","52fac9354a5c2","NoAPIKey",{"message":"115","status":401},"No API key found",{"type":"116"},{"type":"113"},"status","message","470b68e5f0549","string","log level: debug","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-debug-node-log-level-log_level",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Set Log Level of A Single Node",["18"],"82e0cad3b5b3b","put","/debug/node/log-level/{log_level}",["19"],{},"get-debug-node-log-level-log_level","Change the log level of a node.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"debug",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"085fd651cfc0c","84bb6d68ae2f2","200",[],["46"],"OK","1a0b6dfa1e4cf","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","key":"56","extensions":"57","description":"58","type":"59","name":"60","in":"61"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"62","path":"63","port":"64","protocol":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},"17ea482d86e75","log_level","simple",[],"The log level",{"type":"75","enum":"76","$schema":"77","x-stoplight":"78"},["79","80","81","82","83"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"84","description":"85"},{"default":"86","description":"87"},{"default":"88","description":"89"},{"default":"90","description":"91","enum":"92"},"4412a3692a3f2","application/json",["93"],[],{"type":"94","properties":"95","x-examples":"96","$schema":"77","x-stoplight":"97"},"100d02f2251d4",["98","99","100"],[],{"type":"94","properties":"101","required":"102","title":"103","$schema":"77","x-stoplight":"104"},"string",["18","105","106","107","108","109"],"http://json-schema.org/draft-07/schema#",{"id":"110"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["90","111"],{"id":"112","key":"113","value":"114"},"object",{"message":"115"},{"Example 1":"116"},{"id":"117"},{"id":"118","key":"119","value":"120","summary":"121"},{"id":"122","key":"123","value":"124","summary":"125"},{"id":"126","key":"127","value":"128","summary":"129"},{"status":"130","message":"131"},["132","133"],"UnauthorizedError",{"id":"134"},"info","notice","warn","error","crit","315175298a2da","https","26dc003b6b470","Example 1",{"message":"135"},{"type":"75"},{"message":"135"},"ed84e0686a960","dc0f6896a7b82","DuplicateApiKey",{"message":"121","status":401},"Duplicate API key found","7d1104ca55c67","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","6c59dbe10910d","NoAPIKey",{"message":"136","status":401},"No API key found",{"type":"137"},{"type":"75"},"status","message","470b68e5f0549","log level changed","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-rbac-users",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List Users",["18"],"50a15853eaab4","get","/rbac/users",["19"],{},"get-rbac-users","List all users.\n\nNote: RBAC users associated with admin aren't listed with `GET /rbac/users`. Instead, use `GET /admins` to list all admins.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"958e3839ee49e","d8103a20dd4b7","200",[],["45"],"Example response","d5803ac3a6b62","401",[],["46"],"Unauthorized",{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},{"id":"63","mediaType":"59","examples":"64","encodings":"65","schema":"66"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"5d0ef41dfaea0","application/json",["76"],[],{"type":"77","properties":"78","x-examples":"79","$schema":"80","x-stoplight":"81"},"fee9f1d5462f8",["82","83","84"],[],{"type":"77","properties":"85","required":"86","title":"87","$schema":"80","x-stoplight":"88"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","89"],{"id":"90","key":"91","value":"92"},"object",{"data":"93","next":"94"},{"Example 1":"95"},"http://json-schema.org/draft-07/schema#",{"id":"96"},{"id":"97","key":"98","value":"99","summary":"100"},{"id":"101","key":"102","value":"103","summary":"104"},{"id":"105","key":"106","value":"107","summary":"108"},{"status":"109","message":"110"},["111","112"],"UnauthorizedError",{"id":"113"},"https","350b0ea24a052","Returned user",{"data":"114","next":null},{"type":"115","items":"116"},{"type":"117"},{"data":"118","next":null},"d9ed6ac89c0c0","b85cd8d31e1fc","DuplicateApiKey",{"message":"100","status":401},"Duplicate API key found","86a0424351a51","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","e9377b10a88ea","NoAPIKey",{"message":"119","status":401},"No API key found",{"type":"120"},{"type":"117"},"status","message","470b68e5f0549",["121","122"],"array",{"type":"77","properties":"123"},"string",["124","125"],"No API key found in request","integer",{"comment":null,"created_at":1557512629,"enabled":true,"id":"126","name":"127","user_token":"128","user_token_ident":"129"},{"comment":null,"created_at":1557522650,"enabled":true,"id":"130","name":"131","user_token":"132","user_token_ident":"133"},{"comment":"134","created_at":"135","enabled":"136","id":"137","name":"138","user_token":"139","user_token_ident":"140"},{"comment":null,"created_at":1557512629,"enabled":true,"id":"126","name":"127","user_token":"128","user_token_ident":"129"},{"comment":null,"created_at":1557522650,"enabled":true,"id":"130","name":"131","user_token":"132","user_token_ident":"133"},"f035f120-a95e-4327-b2ae-8fa264601d75","doc_lord","$2b$09$TIMneYcTosdG9WbzRsqcweAS2zote8g6I8HqXAtbFHR1pds2ymsh6","88ea3","fa6881b2-f49f-4007-9475-577cd21d34f4","doc_knight","$2b$09$Za30VKAAAmyoB9zF2PNEF.9hgKcN2BdKkptPMCubPK/Ps08lzZjYG","4d870",{"type":"117"},{"type":"120"},{"type":"141"},{"type":"117"},{"type":"117"},{"type":"117"},{"type":"117"},"boolean"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-rbac-users",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Add a User",["17"],"b3bf9f2ecfe3b","post","/rbac/users",["18"],{},"post-rbac-users","inheritedFromService",["19","20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"17"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},{"id":"39","contents":"40"},[],[],[],[],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"958e3839ee49e","d60ad86c38c7c","200",[],["47"],"Example response","9b5ad914c1ea4","401",[],["48"],"Unauthorized","f5be555f5dbb5",["49"],{"id":"50","key":"51","extensions":"52","description":"53","type":"54","name":"55","in":"56"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"57","path":"58","port":"59","protocol":"60"},{"id":"61","mediaType":"62","examples":"63","encodings":"64","schema":"65"},{"id":"66","mediaType":"62","examples":"67","encodings":"68","schema":"69"},{"id":"70","mediaType":"62","examples":"71","encodings":"72","schema":"73"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"74","description":"75"},{"default":"76","description":"77"},{"default":"78","description":"79"},{"default":"80","description":"81","enum":"82"},"13a0642f79e82","application/json",["83"],[],{"type":"84","properties":"85","x-examples":"86","$schema":"87","x-stoplight":"88"},"a1ee6ccbe59f8",["89","90","91"],[],{"type":"84","properties":"92","required":"93","title":"94","$schema":"87","x-stoplight":"95"},"7f8d85504eb5b",[],[],{"type":"84","properties":"96","$schema":"87","x-stoplight":"97"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["80","98"],{"id":"99","key":"100","value":"101"},"object",{"data":"102","next":"103"},{"Example 1":"104"},"http://json-schema.org/draft-07/schema#",{"id":"105"},{"id":"106","key":"107","value":"108","summary":"109"},{"id":"110","key":"111","value":"112","summary":"113"},{"id":"114","key":"115","value":"116","summary":"117"},{"status":"118","message":"119"},["120","121"],"UnauthorizedError",{"id":"122"},{"name":"123","user_token":"124","enabled":"125","comment":"126"},{"id":"127"},"https","917e439a1e6a0","Returned user",{"data":"128","next":null},{"type":"129","items":"130"},{"type":"131"},{"data":"132","next":null},"d9ed6ac89c0c0","fb3ae90fa904a","DuplicateApiKey",{"message":"109","status":401},"Duplicate API key found","7edf917876d1b","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","24fde2f28f529","NoAPIKey",{"message":"133","status":401},"No API key found",{"type":"134"},{"type":"131"},"status","message","470b68e5f0549",{"type":"131","description":"135"},{"type":"131","description":"136"},{"type":"131","description":"137"},{"type":"131","description":"138"},"f8f3cd73a0535",["139","140"],"array",{"type":"84","properties":"141"},"string",["142","143"],"No API key found in request","integer","The RBAC user name.\n","The authentication token to be presented to the Admin API. The value will be hashed and cannot be fetched in plaintext.","A flag to enable or disable the user. By default, users are enabled.\n","A string describing the RBAC user object.\n",{"comment":null,"created_at":1557512629,"enabled":true,"id":"144","name":"145","user_token":"146","user_token_ident":"147"},{"comment":null,"created_at":1557522650,"enabled":true,"id":"148","name":"149","user_token":"150","user_token_ident":"151"},{"comment":"152","created_at":"153","enabled":"154","id":"155","name":"156","user_token":"157","user_token_ident":"158"},{"comment":null,"created_at":1557512629,"enabled":true,"id":"144","name":"145","user_token":"146","user_token_ident":"147"},{"comment":null,"created_at":1557522650,"enabled":true,"id":"148","name":"149","user_token":"150","user_token_ident":"151"},"f035f120-a95e-4327-b2ae-8fa264601d75","doc_lord","$2b$09$TIMneYcTosdG9WbzRsqcweAS2zote8g6I8HqXAtbFHR1pds2ymsh6","88ea3","fa6881b2-f49f-4007-9475-577cd21d34f4","doc_knight","$2b$09$Za30VKAAAmyoB9zF2PNEF.9hgKcN2BdKkptPMCubPK/Ps08lzZjYG","4d870",{"type":"131"},{"type":"134"},{"type":"159"},{"type":"131"},{"type":"131"},{"type":"131"},{"type":"131"},"boolean"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-rbac-users-name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Retrieve a User",["18"],"5a8bac15d58a5","get","/rbac/users/{name_or_id}",["19"],{},"get-rbac-users-name_or_id","Retrieve a user by passing a name or ID in the path.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"958e3839ee49e","a9114246695cc","200",[],["46"],"Example response","3e8142d7d96bd","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","key":"56","extensions":"57","description":"58","type":"59","name":"60","in":"61"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"62","path":"63","port":"64","protocol":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},"1937f747dafcc","name_or_id","simple",[],"The RBAC username or UUID.",{"type":"75","$schema":"76","x-stoplight":"77"},["78","79","80","81","82"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88"},{"default":"89","description":"90","enum":"91"},"1fa0f2577aba7","application/json",["92"],[],{"type":"93","properties":"94","x-examples":"95","$schema":"76","x-stoplight":"96"},"e721e740c6259",["97","98","99"],[],{"type":"93","properties":"100","required":"101","title":"102","$schema":"76","x-stoplight":"103"},"string","http://json-schema.org/draft-07/schema#",{"id":"104"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["89","105"],{"id":"106","key":"107","value":"108"},"object",{"data":"109","next":"110"},{"Example 1":"111"},{"id":"112"},{"id":"113","key":"114","value":"115","summary":"116"},{"id":"117","key":"118","value":"119","summary":"120"},{"id":"121","key":"122","value":"123","summary":"124"},{"status":"125","message":"126"},["127","128"],"UnauthorizedError",{"id":"129"},"43137ac5b6a54","https","fdcd2e2b52deb","Returned user",{"data":"130","next":null},{"type":"131","items":"132"},{"type":"75"},{"data":"133","next":null},"d9ed6ac89c0c0","9525a83ac5c5d","DuplicateApiKey",{"message":"116","status":401},"Duplicate API key found","c0668b64c88da","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","a693b517e3f7b","NoAPIKey",{"message":"134","status":401},"No API key found",{"type":"135"},{"type":"75"},"status","message","470b68e5f0549",["136","137"],"array",{"type":"93","properties":"138"},["139","140"],"No API key found in request","integer",{"comment":null,"created_at":1557512629,"enabled":true,"id":"141","name":"142","user_token":"143","user_token_ident":"144"},{"comment":null,"created_at":1557522650,"enabled":true,"id":"145","name":"146","user_token":"147","user_token_ident":"148"},{"comment":"149","created_at":"150","enabled":"151","id":"152","name":"153","user_token":"154","user_token_ident":"155"},{"comment":null,"created_at":1557512629,"enabled":true,"id":"141","name":"142","user_token":"143","user_token_ident":"144"},{"comment":null,"created_at":1557522650,"enabled":true,"id":"145","name":"146","user_token":"147","user_token_ident":"148"},"f035f120-a95e-4327-b2ae-8fa264601d75","doc_lord","$2b$09$TIMneYcTosdG9WbzRsqcweAS2zote8g6I8HqXAtbFHR1pds2ymsh6","88ea3","fa6881b2-f49f-4007-9475-577cd21d34f4","doc_knight","$2b$09$Za30VKAAAmyoB9zF2PNEF.9hgKcN2BdKkptPMCubPK/Ps08lzZjYG","4d870",{"type":"75"},{"type":"135"},{"type":"156"},{"type":"75"},{"type":"75"},{"type":"75"},{"type":"75"},"boolean"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/patch-rbac-users-name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a User",["18"],"d1300e7f5ab32","patch","/rbac/users/{name_or_id}",["19"],{},"patch-rbac-users-name_or_id","Update a user. Users are unable to update their own roles.","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"RBAC",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41"},[],[],[],["42"],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"958e3839ee49e","68a3c219365a2","200",[],["49"],"Example response","c0d3c3f5f89cd","401",[],["50"],"Unauthorized","e17ded9ec9678",["51"],{"id":"52","name":"53","style":"54","examples":"55","description":"56","required":true,"schema":"57","explicitProperties":"58"},{"id":"59","key":"60","extensions":"61","description":"62","type":"63","name":"64","in":"65"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"66","path":"67","port":"68","protocol":"69"},{"id":"70","mediaType":"71","examples":"72","encodings":"73","schema":"74"},{"id":"75","mediaType":"71","examples":"76","encodings":"77","schema":"78"},{"id":"79","mediaType":"71","examples":"80","encodings":"81","schema":"82"},"ecc935868c7ee","name_or_id","simple",[],"The RBAC username or UUID.",{"type":"83","$schema":"84","x-stoplight":"85"},["86","87","88","89","90"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"e72b64585871d","application/json",["100"],[],{"type":"101","properties":"102","x-examples":"103","$schema":"84","x-stoplight":"104"},"aa2ccde11bca4",["105","106","107"],[],{"type":"101","properties":"108","required":"109","title":"110","$schema":"84","x-stoplight":"111"},"ea0e4c2084fc9",[],[],{"type":"101","properties":"112","$schema":"84","x-stoplight":"113"},"string","http://json-schema.org/draft-07/schema#",{"id":"114"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","115"],{"id":"116","key":"117","value":"118"},"object",{"data":"119","next":"120"},{"Example 1":"121"},{"id":"122"},{"id":"123","key":"124","value":"125","summary":"126"},{"id":"127","key":"128","value":"129","summary":"130"},{"id":"131","key":"132","value":"133","summary":"134"},{"status":"135","message":"136"},["137","138"],"UnauthorizedError",{"id":"139"},{"name":"140","user_token":"141","enabled":"142","comment":"143"},{"id":"144"},"6174b3e6f4d1f","https","ae55b94c08f6d","Returned user",{"data":"145","next":null},{"type":"146","items":"147"},{"type":"83"},{"data":"148","next":null},"d9ed6ac89c0c0","da2ade5297b65","DuplicateApiKey",{"message":"126","status":401},"Duplicate API key found","eff96f2eb5a6c","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","4ef19497e13ec","NoAPIKey",{"message":"149","status":401},"No API key found",{"type":"150"},{"type":"83"},"status","message","470b68e5f0549",{"type":"83","description":"151"},{"type":"83","description":"152"},{"type":"83","description":"153"},{"type":"83","description":"154"},"f8f3cd73a0535",["155","156"],"array",{"type":"101","properties":"157"},["158","159"],"No API key found in request","integer","The RBAC user name.\n","The authentication token to be presented to the Admin API. The value will be hashed and cannot be fetched in plaintext.","A flag to enable or disable the user. By default, users are enabled.\n","A string describing the RBAC user object.\n",{"comment":null,"created_at":1557512629,"enabled":true,"id":"160","name":"161","user_token":"162","user_token_ident":"163"},{"comment":null,"created_at":1557522650,"enabled":true,"id":"164","name":"165","user_token":"166","user_token_ident":"167"},{"comment":"168","created_at":"169","enabled":"170","id":"171","name":"172","user_token":"173","user_token_ident":"174"},{"comment":null,"created_at":1557512629,"enabled":true,"id":"160","name":"161","user_token":"162","user_token_ident":"163"},{"comment":null,"created_at":1557522650,"enabled":true,"id":"164","name":"165","user_token":"166","user_token_ident":"167"},"f035f120-a95e-4327-b2ae-8fa264601d75","doc_lord","$2b$09$TIMneYcTosdG9WbzRsqcweAS2zote8g6I8HqXAtbFHR1pds2ymsh6","88ea3","fa6881b2-f49f-4007-9475-577cd21d34f4","doc_knight","$2b$09$Za30VKAAAmyoB9zF2PNEF.9hgKcN2BdKkptPMCubPK/Ps08lzZjYG","4d870",{"type":"83"},{"type":"150"},{"type":"175"},{"type":"83"},{"type":"83"},{"type":"83"},{"type":"83"},"boolean"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-rbac-users-name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a User",["18"],"ed04572c24274","delete","/rbac/users/{name_or_id}",["19"],{},"delete-rbac-users-name_or_id","Delete a user.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"958e3839ee49e","4848176583250","204",[],[],"No Content","457818084c071","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},{"id":"65","mediaType":"66","examples":"67","encodings":"68","schema":"69"},"0bb1f5cab675b","name_or_id","simple",[],"The RBAC username or UUID.",{"type":"70","$schema":"71","x-stoplight":"72"},["73","74","75","76","77"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"78","description":"79"},{"default":"80","description":"81"},{"default":"82","description":"83"},{"default":"84","description":"85","enum":"86"},"1b47e27009f86","application/json",["87","88","89"],[],{"type":"90","properties":"91","required":"92","title":"93","$schema":"71","x-stoplight":"94"},"string","http://json-schema.org/draft-07/schema#",{"id":"95"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["84","96"],{"id":"97","key":"98","value":"99","summary":"100"},{"id":"101","key":"102","value":"103","summary":"104"},{"id":"105","key":"106","value":"107","summary":"108"},"object",{"status":"109","message":"110"},["111","112"],"UnauthorizedError",{"id":"113"},"f08bbe70e63e1","https","a59f6f234e430","DuplicateApiKey",{"message":"100","status":401},"Duplicate API key found","1b7943481e00a","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","404495b853d4d","NoAPIKey",{"message":"114","status":401},"No API key found",{"type":"115"},{"type":"70"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-rbac-roles",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List Roles",["18"],"b4be6816c46f7","get","/rbac/roles",["19"],{},"get-rbac-roles","List all roles.","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"RBAC",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],[],["33"],{"id":"34","url":"35","name":"36","description":"37","variables":"38"},"958e3839ee49e","6edf2717e08c7","200",[],["39"],"OK",{"id":"40","key":"41","extensions":"42","description":"43","type":"44","name":"45","in":"46"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"47","path":"48","port":"49","protocol":"50"},{"id":"51","mediaType":"52","examples":"53","encodings":"54","schema":"55"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"56","description":"57"},{"default":"58","description":"59"},{"default":"60","description":"61"},{"default":"62","description":"63","enum":"64"},"c303d17977a80","application/json",["65"],[],{"type":"66","properties":"67","x-examples":"68","$schema":"69","x-stoplight":"70"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["62","71"],{"id":"72","key":"73","value":"74"},"object",{"data":"75","next":"76"},{"Example 1":"77"},"http://json-schema.org/draft-07/schema#",{"id":"78"},"https","9d86d647acb15","Multiple roles",{"data":"79","next":null},{"type":"80","items":"81"},{"type":"82"},{"data":"83","next":null},"c40358517ca7a",["84","85","86","87"],"array",{"type":"66","properties":"88"},"string",["89","90","91","92"],{"comment":"93","created_at":1557506249,"id":"94","name":"95"},{"comment":"96","created_at":1557506249,"id":"97","name":"98"},{"comment":"99","created_at":1557506249,"id":"100","name":"101"},{"comment":null,"created_at":1557532241,"id":"102","name":"103"},{"comment":"104","created_at":"105","id":"106","name":"107"},{"comment":"93","created_at":1557506249,"id":"94","name":"95"},{"comment":"96","created_at":1557506249,"id":"97","name":"98"},{"comment":"99","created_at":1557506249,"id":"100","name":"101"},{"comment":null,"created_at":1557532241,"id":"102","name":"103"},"Full access to all endpoints, across all workspaces—except RBAC Admin API","38a03d47-faae-4366-b430-f6c10aee5029","admin","Read access to all endpoints, across all workspaces","4141675c-8beb-41a5-aa04-6258ab2d2f7f","read-only","Full access to all endpoints, across all workspaces","888117e0-f2b3-404d-823b-dee595423505","super-admin","b5c5cfd4-3330-4796-9b7b-6026e91e3ad6","doc_lord",{"type":"82"},{"type":"108"},{"type":"82"},{"type":"82"},"integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-rbac-roles",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Add a Role",["18"],"07dcaef18df77","post","/rbac/roles",["19"],{},"post-rbac-roles","Add a role.","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35","description":"36"},[],[],[],[],["37"],{"id":"38","url":"39","name":"40","description":"41","variables":"42"},"958e3839ee49e","49ce1ae45f143","201",[],["43"],"Created","d3384d4ba389c",["44"],"The request body contains the name of the role and an optional attribute.",{"id":"45","key":"46","extensions":"47","description":"48","type":"49","name":"50","in":"51"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"52","path":"53","port":"54","protocol":"55"},{"id":"56","mediaType":"57","examples":"58","encodings":"59","schema":"60"},{"id":"61","mediaType":"57","examples":"62","encodings":"63","schema":"64"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"65","description":"66"},{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72","enum":"73"},"6383437d1fa7d","application/json",["74"],[],{"type":"75","properties":"76","x-examples":"77","$schema":"78","x-stoplight":"79"},"ece9171d6279d",[],[],{"type":"75","properties":"80","$schema":"78","x-stoplight":"81"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["71","82"],{"id":"83","key":"84","value":"85"},"object",{"comment":"86","created_at":"87","id":"88","is_default":"89","name":"90"},{"Example 1":"91"},"http://json-schema.org/draft-07/schema#",{"id":"92"},{"name":"93","comment":"94"},{"id":"95"},"https","05d1f53eeb94d","New role response body",{"comment":null,"created_at":1557532241,"id":"96","is_default":false,"name":"97"},{"type":"98"},{"type":"99"},{"type":"98"},{"type":"100"},{"type":"98"},{"comment":null,"created_at":1557532241,"id":"96","is_default":false,"name":"97"},"6ff4ad784099c",{"type":"98","description":"101"},{"type":"98","description":"102"},"2bf6e19602503","b5c5cfd4-3330-4796-9b7b-6026e91e3ad6","service_reader","string","integer","boolean","The RBAC role name.","A string describing the RBAC user object."]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-rbac-roles-name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Retrieve a Role",["18"],"1a4256a5af54d","get","/rbac/roles/{name_or_id}",["19"],{},"get-rbac-roles-name_or_id","Retrieve a role by passing the name or UUID as a path parameter.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"958e3839ee49e","3ffcf70f3ea1c","200",[],["46"],"OK","056cf7b7c7cd2","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","key":"56","extensions":"57","description":"58","type":"59","name":"60","in":"61"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"62","path":"63","port":"64","protocol":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},"0a83d1de1380d","name_or_id","simple",[],"The RBAC role name or UUID.",{"type":"75","$schema":"76","x-stoplight":"77"},["78","79","80","81","82"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88"},{"default":"89","description":"90","enum":"91"},"4f34194932b6b","application/json",["92"],[],{"type":"93","properties":"94","x-examples":"95","$schema":"76","x-stoplight":"96"},"9c84522ee01a1",["97","98","99"],[],{"type":"93","properties":"100","required":"101","title":"102","$schema":"76","x-stoplight":"103"},"string","http://json-schema.org/draft-07/schema#",{"id":"104"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["89","105"],{"id":"106","key":"107","value":"108"},"object",{"created_at":"109","id":"110","is_default":"111","name":"112"},{"Example 1":"113"},{"id":"114"},{"id":"115","key":"116","value":"117","summary":"118"},{"id":"119","key":"120","value":"121","summary":"122"},{"id":"123","key":"124","value":"125","summary":"126"},{"status":"127","message":"128"},["129","130"],"UnauthorizedError",{"id":"131"},"b67869caccd9a","https","190b1ebe9e7d2","Example 1",{"created_at":1557532241,"id":"132","is_default":false,"name":"133"},{"type":"134"},{"type":"75"},{"type":"135"},{"type":"75"},{"created_at":1557532241,"id":"132","is_default":false,"name":"133"},"468c9922920fc","3cc306b2c4740","DuplicateApiKey",{"message":"118","status":401},"Duplicate API key found","6de692db0d6b8","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","173e386935d24","NoAPIKey",{"message":"136","status":401},"No API key found",{"type":"134"},{"type":"75"},"status","message","470b68e5f0549","b5c5cfd4-3330-4796-9b7b-6026e91e3ad6","service_reader","integer","boolean","No API key found in request"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/put-rbac-roles-name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update or Create a Role",["18"],"338c34b24adcb","put","/rbac/roles/{name_or_id}",["19"],{},"put-rbac-roles-name_or_id","With a `PUT` request, if the request payload contains an existing entity’s primary key, the payload replaces the entity specified by the given primary key. If the primary key is not that of an existing entity, the entity is created with the given payload.\n","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"RBAC",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47"},[],[],[],["48"],["49"],{"id":"50","url":"51","name":"52","description":"53","variables":"54"},"958e3839ee49e","c443b03faa500","200",[],["55"],"OK","c433b03faa753","201",[],[],"Created","2ed3afae3a59e","401",[],["56"],"Unauthorized","ad3f59eaeece3",["57"],{"id":"58","name":"59","style":"60","examples":"61","description":"62","required":true,"schema":"63","explicitProperties":"64"},{"id":"65","key":"66","extensions":"67","description":"68","type":"69","name":"70","in":"71"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"72","path":"73","port":"74","protocol":"75"},{"id":"76","mediaType":"77","examples":"78","encodings":"79","schema":"80"},{"id":"81","mediaType":"77","examples":"82","encodings":"83","schema":"84"},{"id":"85","mediaType":"77","examples":"86","encodings":"87","schema":"88"},"f165251fb5ac6","name_or_id","simple",[],"The RBAC role name or UUID.",{"type":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"97","description":"98"},{"default":"99","description":"100"},{"default":"101","description":"102"},{"default":"103","description":"104","enum":"105"},"50dd3cbb46889","application/json",["106"],[],{"type":"107","properties":"108","x-examples":"109","$schema":"90","x-stoplight":"110"},"635df6fa109e1",["111","112","113"],[],{"type":"107","properties":"114","required":"115","title":"116","$schema":"90","x-stoplight":"117"},"d4226501b794c",[],[],{"type":"107","properties":"118","$schema":"90","x-stoplight":"119"},"string","http://json-schema.org/draft-07/schema#",{"id":"120"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["103","121"],{"id":"122","key":"123","value":"124"},"object",{"comment":"125","created_at":"126","id":"127","is_default":"128","name":"129"},{"Example 1":"130"},{"id":"131"},{"id":"132","key":"133","value":"134","summary":"135"},{"id":"136","key":"137","value":"138","summary":"139"},{"id":"140","key":"141","value":"142","summary":"143"},{"status":"144","message":"145"},["146","147"],"UnauthorizedError",{"id":"148"},{"name":"149","comment":"150"},{"id":"151"},"b9f59940bcc95","https","f9cf83bf3006e","Example entity replacement",{"comment":"152","created_at":1557532566,"id":"153","is_default":false,"name":"154"},{"type":"89"},{"type":"155"},{"type":"89"},{"type":"156"},{"type":"89"},{"comment":"152","created_at":1557532566,"id":"153","is_default":false,"name":"154"},"bdf10e275c6cb","870174ccf5b54","DuplicateApiKey",{"message":"135","status":401},"Duplicate API key found","07a597fea9594","InvalidAuthCred",{"message":"45","status":401},"Invalid authentication credentials","da9da01dad0d4","NoAPIKey",{"message":"157","status":401},"No API key found",{"type":"155"},{"type":"89"},"status","message","470b68e5f0549",{"type":"89"},{"type":"89"},"61391c2b980a4","the best","b5c5cfd4-3330-4796-9b7b-6026e91e3ad6","doc_lord","integer","boolean","No API key found in request"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/patch-rbac-roles-name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a Role",["18"],"392c8a7e81089","patch","/rbac/roles/{name_or_id}",["19"],{},"patch-rbac-roles-name_or_id","Updates a role by passing an optional attribute.","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35","description":"36"},[],[],[],["37"],["38"],{"id":"39","url":"40","name":"41","description":"42","variables":"43"},"958e3839ee49e","7a144ac064723","200",[],["44"],"OK","6f404c2e2ae37",["45"],"Attribute request body",{"id":"46","name":"47","style":"48","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},{"id":"64","mediaType":"65","examples":"66","encodings":"67","schema":"68"},{"id":"69","mediaType":"65","examples":"70","encodings":"71","schema":"72"},"415c2402a581b","name_or_id","simple",[],"The RBAC role name or UUID.",{"type":"73","$schema":"74","x-stoplight":"75"},["76","77","78","79","80"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88","enum":"89"},"309f49ccf3507","application/json",["90"],[],{"type":"91","properties":"92","x-examples":"93","$schema":"74","x-stoplight":"94"},"c7d6542587437",[],[],{"type":"91","properties":"95","$schema":"74","x-stoplight":"96"},"string","http://json-schema.org/draft-07/schema#",{"id":"97"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["87","98"],{"id":"99","key":"100","value":"101"},"object",{"comment":"102","created_at":"103","id":"104","is_default":"105","name":"106"},{"Example 1":"107"},{"id":"108"},{"attribute":"109"},{"id":"110"},"00996ea4c03f9","https","15768aa9901da","Patch request response",{"comment":"111","created_at":1557532566,"id":"112","is_default":false,"name":"113"},{"type":"73"},{"type":"114"},{"type":"73"},{"type":"115"},{"type":"73"},{"comment":"111","created_at":1557532566,"id":"112","is_default":false,"name":"113"},"d3cc92f5cd517",{"type":"73","description":"116"},"f15180bcd8055","comment from patch request","b5c5cfd4-3330-4796-9b7b-6026e91e3ad6","service_reader","integer","boolean","A string describing the RBAC role object.\n"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-rbac-roles-name_or_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a Role",["18"],"581236d6e20f1","delete","/rbac/roles/{name_or_id}",["19"],{},"delete-rbac-roles-name_or_id","Delete a role","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"958e3839ee49e","7c3f7cbb6c358","204",[],[],"No Content","a42f7e8115bca","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},{"id":"65","mediaType":"66","examples":"67","encodings":"68","schema":"69"},"df11c8deff51a","name_or_id","simple",[],"The RBAC role name or UUID.",{"type":"70","$schema":"71","x-stoplight":"72"},["73","74","75","76","77"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"78","description":"79"},{"default":"80","description":"81"},{"default":"82","description":"83"},{"default":"84","description":"85","enum":"86"},"6d210265f64ec","application/json",["87","88","89"],[],{"type":"90","properties":"91","required":"92","title":"93","$schema":"71","x-stoplight":"94"},"string","http://json-schema.org/draft-07/schema#",{"id":"95"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["84","96"],{"id":"97","key":"98","value":"99","summary":"100"},{"id":"101","key":"102","value":"103","summary":"104"},{"id":"105","key":"106","value":"107","summary":"108"},"object",{"status":"109","message":"110"},["111","112"],"UnauthorizedError",{"id":"113"},"cc0bee1129c6f","https","5373df988cc20","DuplicateApiKey",{"message":"100","status":401},"Duplicate API key found","70dd97eaacb82","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","986ef4ecc9d7b","NoAPIKey",{"message":"114","status":401},"No API key found",{"type":"115"},{"type":"70"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-rbac-roles-name_or_id-endpoints",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List Role Endpoints Permissions",["18"],"b7dfadda7d086","get","/rbac/roles/{name_or_id}/endpoints",["19"],{},"get-rbac-roles-name_or_id-endpoints","Lists all of a role's associated endpoint permissions.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"958e3839ee49e","3c56bd2393189","200",[],["46"],"OK","01a6bdcc1c02f","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","key":"56","extensions":"57","description":"58","type":"59","name":"60","in":"61"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"62","path":"63","port":"64","protocol":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},"f2dfd4747f19e","name_or_id","simple",[],"The RBAC role name or UUID.",{"type":"75","$schema":"76","x-stoplight":"77"},["78","79","80","81","82"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88"},{"default":"89","description":"90","enum":"91"},"dcc07bc3ddc68","application/json",[],[],{"type":"92","properties":"93","x-examples":"94","$schema":"76","x-stoplight":"95"},"259f6f15e9092",["96","97","98"],[],{"type":"92","properties":"99","required":"100","title":"101","$schema":"76","x-stoplight":"102"},"string","http://json-schema.org/draft-07/schema#",{"id":"103"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["89","104"],"object",{"data":"105"},{"Example 1":"106"},{"id":"107"},{"id":"108","key":"109","value":"110","summary":"111"},{"id":"112","key":"113","value":"114","summary":"115"},{"id":"116","key":"117","value":"118","summary":"119"},{"status":"120","message":"121"},["122","123"],"UnauthorizedError",{"id":"124"},"d4051659b2584","https",{"type":"125","items":"126"},{"data":"127"},"625d9f803dd47","a0b335f6b907a","DuplicateApiKey",{"message":"111","status":401},"Duplicate API key found","32bef26ae15a8","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","9d29a878c142b","NoAPIKey",{"message":"128","status":401},"No API key found",{"type":"129"},{"type":"75"},"status","message","470b68e5f0549","array",{"type":"92","properties":"130"},["131","132"],"No API key found in request","integer",{"actions":"133","created_at":"134","endpoint":"135","negative":"136","role":"137","role_source":"138","workspace":"139"},{"actions":"140","created_at":1557764505,"endpoint":"141","negative":false,"role":"142","workspace":"143"},{"actions":"144","created_at":1557764438,"endpoint":"145","negative":false,"role":"146","workspace":"143"},{"type":"125","items":"147"},{"type":"129"},{"type":"75"},{"type":"148"},{"type":"92","properties":"149"},{"description":"150","type":"75","default":"151","enum":"152"},{"type":"75"},["153","154","155","156"],"/consumers",{"id":"157"},"default",["156"],"/services",{"id":"157"},{"type":"75"},"boolean",{"id":"158"},"The origin of the RBAC user role. Specifies where the user role is defined, either locally or through an identity provider (IdP).","local",["151","159"],"delete","create","update","read","23df9f20-e7cc-4da4-bc89-d3a08f976e50",{"type":"75"},"idp"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-rbac-roles-name_or_id-endpoints",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Add a Role Endpoint Permission",["18"],"18ac24c223e5f","post","/rbac/roles/{name_or_id}/endpoints",["19"],{},"post-rbac-roles-name_or_id-endpoints","Add a role endpoint permission for the path of the associated endpoint. Permissions can be exact matches, or contain wildcards, represented by `*`.\n\nExact matches:\n- `/services/`\n- `/services/foo`\n\nWildcards:\n- `/services/*`\n- `/services/*/plugins`\nWhere `*` replaces exactly one segment between slashes (or the end of the path).\n\nNote that wildcards can be nested. For example, `/rbac/*`, `/rbac/*/*`, `/rbac/*/*/*` would refer to all paths under `/rbac/`.\n<br><br>\n For the `admin` role in the default workspace, CRUD actions on `/groups` and `/groups/*` endpoints are disallowed.\n For the `workspace-admin` role in non-default workspaces, CRUD actions on `/groups` and `/groups/*` endpoints are disallowed.","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35"},[],[],[],["36"],["37"],{"id":"38","url":"39","name":"40","description":"41","variables":"42"},"958e3839ee49e","ff8c859e756dd","201",[],["43"],"Created","48adec9f08830",["44"],{"id":"45","name":"46","style":"47","examples":"48","description":"49","required":true,"schema":"50","explicitProperties":"51"},{"id":"52","key":"53","extensions":"54","description":"55","type":"56","name":"57","in":"58"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"59","path":"60","port":"61","protocol":"62"},{"id":"63","mediaType":"64","examples":"65","encodings":"66","schema":"67"},{"id":"68","mediaType":"64","examples":"69","encodings":"70","schema":"71"},"8948f18eb8b98","name_or_id","simple",[],"The RBAC role name or UUID.",{"type":"72","$schema":"73","x-stoplight":"74"},["75","76","77","78","79"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"80","description":"81"},{"default":"82","description":"83"},{"default":"84","description":"85"},{"default":"86","description":"87","enum":"88"},"093decda9ff8b","application/json",["89"],[],{"type":"90","properties":"91","x-examples":"92","$schema":"73","x-stoplight":"93"},"ad9573e96e61b",[],[],{"type":"90","properties":"94","$schema":"73","x-stoplight":"95"},"string","http://json-schema.org/draft-07/schema#",{"id":"96"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["86","97"],{"id":"98","key":"99","value":"100"},"object",{"actions":"101","created_at":"102","endpoint":"103","negative":"104","role":"105","role_source":"106","workspace":"107"},{"Example 1":"108"},{"id":"109"},{"workspace":"110","endpoint":"111","negative":"112","actions":"113","comment":"114"},{"id":"115"},"245a0ee8108cc","https","548cf663de9ff","Basic example",{"actions":"116","created_at":1557764505,"endpoint":"117","negative":false,"role":"118","workspace":"119"},{"type":"120","items":"121"},{"type":"122"},{"type":"72"},{"type":"123"},{"type":"90","properties":"124"},{"description":"125","type":"72","default":"126","enum":"127"},{"type":"72"},{"actions":"128","created_at":1557764505,"endpoint":"117","negative":false,"role":"129","workspace":"119"},"c51f6bf702335",{"type":"72","description":"130"},{"type":"72","description":"131"},{"type":"72","description":"132"},{"type":"72","description":"133"},{"type":"72","description":"134"},"4c26ec3908949",["135","136","137","138"],"/consumers",{"id":"139"},"default","array",{"type":"72"},"integer","boolean",{"id":"140"},"The origin of the RBAC user role. Specifies where the user role is defined, either locally or through an identity provider (IdP).","local",["126","141"],["135","136","137","138"],{"id":"139"},"Workspace tied to the endpoint. Defaults to the default permission. Using the wildcard `*` means all workspaces are affected.","Endpoint associated with this permission.\n","If true, explicitly disallow the actions associated with the permissions tied to this endpoint. By default, this value is false.\n","One or more actions associated with this permission, written as a comma-separated string. \nFor example, `read,create,update,delete`.\n","A string describing the RBAC permission object.","delete","create","update","read","23df9f20-e7cc-4da4-bc89-d3a08f976e50",{"type":"72"},"idp"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-rbac-roles-name_or_id-endpoints-workspace_name_or_id-endpoint",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Retrieve a Role Endpoint Permission",["18"],"b42bb4c7caf18","get","/rbac/roles/{name_or_id}/endpoints/{workspace_name_or_id}/{endpoint}",["19"],{},"get-rbac-roles-name_or_id-endpoints-workspace_name_or_id-endpoint","Retrieve a Role Endpoint Permission\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40","41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"958e3839ee49e","e82ca9d7384a6","200",[],["48"],"OK","c01ca8118eeca","401",[],["49"],"Unauthorized",{"id":"50","name":"51","style":"52","examples":"53","description":"54","required":true,"schema":"55","explicitProperties":"56"},{"id":"57","name":"58","style":"52","examples":"59","description":"60","required":true,"schema":"61","explicitProperties":"62"},{"id":"63","name":"64","style":"52","examples":"65","description":"66","required":true,"schema":"67","explicitProperties":"68"},{"id":"69","key":"70","extensions":"71","description":"72","type":"73","name":"74","in":"75"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"76","path":"77","port":"78","protocol":"79"},{"id":"80","mediaType":"81","examples":"82","encodings":"83","schema":"84"},{"id":"85","mediaType":"81","examples":"86","encodings":"87","schema":"88"},"fc737444530f4","name_or_id","simple",[],"The RBAC role name or UUID.",{"type":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96"],"7bcb82e49915f","workspace_name_or_id",[],"The workspace name or UUID.",{"type":"89","$schema":"90","x-stoplight":"97"},["92","93","94","95","96"],"6344ff76bf9db","endpoint",[],"The endpoint associated with this permission.",{"type":"89","$schema":"90","x-stoplight":"98"},["92","93","94","95","96"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"99","description":"100"},{"default":"101","description":"102"},{"default":"103","description":"104"},{"default":"105","description":"106","enum":"107"},"befca491ef5bb","application/json",["108"],[],{"type":"109","properties":"110","x-examples":"111","$schema":"90","x-stoplight":"112"},"5a8fa0b904065",["113","114","115"],[],{"type":"109","properties":"116","required":"117","title":"118","$schema":"90","x-stoplight":"119"},"string","http://json-schema.org/draft-07/schema#",{"id":"120"},"schema","name","in","required","description",{"id":"121"},{"id":"122"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["105","123"],{"id":"124","key":"125","value":"126"},"object",{"actions":"127","created_at":"128","endpoint":"129","negative":"130","role":"131","role_source":"132","workspace":"133"},{"Example 1":"134"},{"id":"135"},{"id":"136","key":"137","value":"138","summary":"139"},{"id":"140","key":"141","value":"142","summary":"143"},{"id":"144","key":"145","value":"146","summary":"147"},{"status":"148","message":"149"},["150","151"],"UnauthorizedError",{"id":"152"},"0966a9ebc19e6","6bd7275962f12","ddd1ddc43d4dc","https","b8a157b1d7433","basic example",{"actions":"153","created_at":1557764505,"endpoint":"154","negative":false,"role":"155","workspace":"156"},{"type":"157","items":"158"},{"type":"159"},{"type":"89"},{"type":"160"},{"type":"109","properties":"161"},{"description":"162","type":"89","default":"163","enum":"164"},{"type":"89"},{"actions":"165","created_at":1557764505,"endpoint":"154","negative":false,"role":"166","workspace":"156"},"a5c900e1f380f","26b4d80f2bd72","DuplicateApiKey",{"message":"139","status":401},"Duplicate API key found","09d2edc336922","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","2736237a7eff7","NoAPIKey",{"message":"167","status":401},"No API key found",{"type":"159"},{"type":"89"},"status","message","470b68e5f0549",["168","169","170","171"],"/consumers",{"id":"172"},"default","array",{"type":"89"},"integer","boolean",{"id":"173"},"The origin of the RBAC user role. Specifies where the user role is defined, either locally or through an identity provider (IdP).","local",["163","174"],["168","169","170","171"],{"id":"172"},"No API key found in request","delete","create","update","read","23df9f20-e7cc-4da4-bc89-d3a08f976e50",{"type":"89"},"idp"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/patch-rbac-roles-name_or_id-endpoints-workspace_name_or_id-endpoint",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update a Role Endpoint Permission",["18"],"611030e04031a","patch","/rbac/roles/{name_or_id}/endpoints/{workspace_name_or_id}/{endpoint}",["19"],{},"patch-rbac-roles-name_or_id-endpoints-workspace_name_or_id-endpoint","Update a Role Endpoint Permission\n","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35"},[],[],[],["36","37","38"],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"958e3839ee49e","4438c64ec898c","200",[],["45"],"OK","c9c79e916d50e",["46"],{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","name":"55","style":"49","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","name":"61","style":"49","examples":"62","description":"63","required":true,"schema":"64","explicitProperties":"65"},{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},"6b8841061e3e0","name_or_id","simple",[],"The RBAC role name or UUID.",{"type":"86","$schema":"87","x-stoplight":"88"},["89","90","91","92","93"],"1b30991bed521","workspace_name_or_id",[],"The workspace name or UUID.",{"type":"86","$schema":"87","x-stoplight":"94"},["89","90","91","92","93"],"833d007b27bac","endpoint",[],"The endpoint associated with this permission.",{"type":"86","$schema":"87","x-stoplight":"95"},["89","90","91","92","93"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"96","description":"97"},{"default":"98","description":"99"},{"default":"100","description":"101"},{"default":"102","description":"103","enum":"104"},"3fdff3a192b4e","application/json",["105"],[],{"type":"106","properties":"107","x-examples":"108","$schema":"87","x-stoplight":"109"},"291abfaf940f3",[],[],{"type":"106","properties":"110","$schema":"87","x-stoplight":"111"},"string","http://json-schema.org/draft-07/schema#",{"id":"112"},"schema","name","in","required","description",{"id":"113"},{"id":"114"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["102","115"],{"id":"116","key":"117","value":"118"},"object",{"actions":"119","created_at":"120","endpoint":"121","negative":"122","role":"123","role_source":"124","workspace":"125"},{"Example 1":"126"},{"id":"127"},{"negative":"128","actions":"129"},{"id":"130"},"884ae64622df5","6a381dafccf50","448f77bdbb5f5","https","1e29438277d21","Example 1",{"actions":"131","created_at":1557764438,"endpoint":"132","negative":false,"role":"133","workspace":"134"},{"type":"135","items":"136"},{"type":"137"},{"type":"86"},{"type":"138"},{"type":"106","properties":"139"},{"description":"140","type":"86","default":"141","enum":"142"},{"type":"86"},{"actions":"143","created_at":1557764438,"endpoint":"132","negative":false,"role":"144","workspace":"134"},"930c253026a6c",{"type":"86","description":"145"},{"type":"86","description":"146"},"78ed5c03c4584",["147","148","149","150"],"/services",{"id":"151"},"default","array",{"type":"86"},"integer","boolean",{"id":"152"},"The origin of the RBAC user role. Specifies where the user role is defined, either locally or through an identity provider (IdP).","local",["141","153"],["147","148","149","150"],{"id":"151"},"If true, explicitly disallow the actions associated with the permissions tied to this resource. By default this value is false.\n","One or more actions associated with this permission.\n","delete","create","update","read","23df9f20-e7cc-4da4-bc89-d3a08f976e50",{"type":"86"},"idp"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-rbac-roles-name_or_id-endpoints-workspace_name_or_id-endpoint",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete a Role Endpoint Permission",["18"],"e66afa9fe8202","delete","/rbac/roles/{name_or_id}/endpoints/{workspace_name_or_id}/{endpoint}",["19"],{},"delete-rbac-roles-name_or_id-endpoints-workspace_name_or_id-endpoint","Delete a Role Endpoint Permission\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40","41"],["42"],{"id":"43","url":"44","name":"45","description":"46","variables":"47"},"958e3839ee49e","eb95fba402816","204",[],[],"No Content","ee85fb01398b3","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","required":true,"schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"51","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},"529088e964295","name_or_id","simple",[],"The RBAC role name or UUID.",{"type":"84","$schema":"85","x-stoplight":"86"},["87","88","89","90","91"],"ecb6a7416eabd","workspace_name_or_id",[],"The workspace name or UUID.",{"type":"84","$schema":"85","x-stoplight":"92"},["87","88","89","90","91"],"f35cab0cbb7d0","endpoint",[],"The endpoint associated with this permission.",{"type":"84","$schema":"85","x-stoplight":"93"},["87","88","89","90","91"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"94","description":"95"},{"default":"96","description":"97"},{"default":"98","description":"99"},{"default":"100","description":"101","enum":"102"},"4cc6ce0aadfd3","application/json",["103","104","105"],[],{"type":"106","properties":"107","required":"108","title":"109","$schema":"85","x-stoplight":"110"},"string","http://json-schema.org/draft-07/schema#",{"id":"111"},"schema","name","in","required","description",{"id":"112"},{"id":"113"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["100","114"],{"id":"115","key":"116","value":"117","summary":"118"},{"id":"119","key":"120","value":"121","summary":"122"},{"id":"123","key":"124","value":"125","summary":"126"},"object",{"status":"127","message":"128"},["129","130"],"UnauthorizedError",{"id":"131"},"8fc0fb0b445e4","618c0838eafb8","a76a0b6a4d43b","https","9af473a444dfd","DuplicateApiKey",{"message":"118","status":401},"Duplicate API key found","30521a504d840","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","15a4fc994934a","NoAPIKey",{"message":"132","status":401},"No API key found",{"type":"133"},{"type":"84"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-rbac-roles-name_or_id-entities",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List Entity Permissions",["18"],"76439e010a541","get","/rbac/roles/{name_or_id}/entities",["19"],{},"get-rbac-roles-name_or_id-entities","Add a Role Entity Permission\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"958e3839ee49e","2871ccfbc863a","200",[],["46"],"OK","f5c1cda45f259","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","key":"56","extensions":"57","description":"58","type":"59","name":"60","in":"61"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"62","path":"63","port":"64","protocol":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},"4e2cce8ec2843","name_or_id","simple",[],"The RBAC role name or UUID.",{"type":"75","$schema":"76","x-stoplight":"77"},["78","79","80","81","82"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88"},{"default":"89","description":"90","enum":"91"},"6d0b9667afa16","application/json",["92"],[],{"type":"93","properties":"94","x-examples":"95","$schema":"76","x-stoplight":"96"},"a38073f5c2a6a",["97","98","99"],[],{"type":"93","properties":"100","required":"101","title":"102","$schema":"76","x-stoplight":"103"},"string","http://json-schema.org/draft-07/schema#",{"id":"104"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["89","105"],{"id":"106","key":"107","value":"108"},"object",{"data":"109"},{"Example 1":"110"},{"id":"111"},{"id":"112","key":"113","value":"114","summary":"115"},{"id":"116","key":"117","value":"118","summary":"119"},{"id":"120","key":"121","value":"122","summary":"123"},{"status":"124","message":"125"},["126","127"],"UnauthorizedError",{"id":"128"},"833d58cb7a6c7","https","e3219c0f73822","Example 1",{"data":"129"},{"type":"130","items":"131"},{"data":"132"},"840ac5744f720","aaece689d959e","DuplicateApiKey",{"message":"115","status":401},"Duplicate API key found","9d0c4c08f658f","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","9e7a348a1ea70","NoAPIKey",{"message":"133","status":401},"No API key found",{"type":"134"},{"type":"75"},"status","message","470b68e5f0549",["135"],"array",{"type":"93","properties":"136"},["137"],"No API key found in request","integer",{"actions":"138","created_at":1557771505,"entity_id":"139","entity_type":"140","negative":false,"role":"141"},{"actions":"142","created_at":"143","entity_id":"144","entity_type":"145","negative":"146","role":"147","role_source":"148"},{"actions":"149","created_at":1557771505,"entity_id":"139","entity_type":"140","negative":false,"role":"150"},["151","152","153"],"*","wildcard",{"id":"154"},{"type":"130","items":"155"},{"type":"134"},{"type":"75"},{"type":"75"},{"type":"156"},{"type":"93","properties":"157"},{"description":"158","type":"75","default":"159","enum":"160"},["151","152","153"],{"id":"154"},"delete","create","read","bba049fa-bf7e-40ef-8e89-553dda292e99",{"type":"75"},"boolean",{"id":"161"},"The origin of the RBAC user role. Specifies where the user role is defined, either locally or through an identity provider (IdP).","local",["159","162"],{"type":"75"},"idp"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-rbac-roles-name_or_id-entities",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Add a Role Entity Permission",["18"],"1abee1db4c44b","post","/rbac/roles/{name_or_id}/entities",["19"],{},"post-rbac-roles-name_or_id-entities","The `entity_id` must be the ID of an entity in Kong. If you provide the ID of a workspace, the permission applies to all entities in that workspace. Future entities belonging to that workspace will get the same permissions. A wildcard (`*`) will be interpreted as all entities in the system.","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35","description":"36"},[],[],[],["37"],["38"],{"id":"39","url":"40","name":"41","description":"42","variables":"43"},"958e3839ee49e","154610b9b8c16","201",[],["44"],"Created","acb30d708b23a",["45"],"Request Body\n",{"id":"46","name":"47","style":"48","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},{"id":"64","mediaType":"65","examples":"66","encodings":"67","schema":"68"},{"id":"69","mediaType":"65","examples":"70","encodings":"71","schema":"72"},"d805d48933b5b","name_or_id","simple",[],"The RBAC role name or UUID.",{"type":"73","$schema":"74","x-stoplight":"75"},["76","77","78","79","80"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88","enum":"89"},"86c7ee7e5b890","application/json",["90"],[],{"type":"91","properties":"92","x-examples":"93","$schema":"74","x-stoplight":"94"},"c019d35535154",[],[],{"type":"91","description":"95","properties":"96","$schema":"74","x-stoplight":"97"},"string","http://json-schema.org/draft-07/schema#",{"id":"98"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["87","99"],{"id":"100","key":"101","value":"102"},"object",{"actions":"103","created_at":"104","entity_id":"105","entity_type":"106","negative":"107","role":"108"},{"Example 1":"109"},{"id":"110"},"If true, explicitly disallow the actions associated with the permissions tied to this resource. By default this value is false.",{"negative":"111","entity_id":"112","entity_type":"113","actions":"114","comment":"115"},{"id":"116"},"e6ccb1fc8f069","https","dabc9a08308f1","example response",{"actions":"117","created_at":1557771505,"entity_id":"118","entity_type":"119","negative":false,"role":"120"},{"type":"121","items":"122"},{"type":"123"},{"type":"73"},{"type":"73"},{"type":"124"},{"type":"91","properties":"125"},{"actions":"126","created_at":1557771505,"entity_id":"118","entity_type":"119","negative":false,"role":"127"},"48602e86d0a6e",{"type":"73","description":"128"},{"type":"73","description":"129"},{"type":"73","description":"130"},{"type":"73","description":"131"},{"type":"73","description":"132"},"2fbaab78dfe84",["133","134","135"],"*","wildcard",{"id":"136"},"array",{"type":"73"},"integer","boolean",{"id":"137"},["133","134","135"],{"id":"136"},"ID of the entity associated with this permission.","Type of the entity of a given `entity_id`.","One or more actions associated with this permission.","One or more actions associated with this permission.\n","A string describing the RBAC permission object.","delete","create","read","bba049fa-bf7e-40ef-8e89-553dda292e99",{"type":"73"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-rbac-roles-name_or_id-entities-entity_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Retrieve a Role Entity Permission",["18"],"4d0ac9482e9b9","get","/rbac/roles/{name_or_id}/entities/{entity_id}",["19"],{},"get-rbac-roles-name_or_id-entities-entity_id","Retrieve a Role Entity Permission\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"958e3839ee49e","b6c4566bf4447","200",[],["47"],"OK","e95455c35d083","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","required":true,"schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","key":"63","extensions":"64","description":"65","type":"66","name":"67","in":"68"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"69","path":"70","port":"71","protocol":"72"},{"id":"73","mediaType":"74","examples":"75","encodings":"76","schema":"77"},{"id":"78","mediaType":"74","examples":"79","encodings":"80","schema":"81"},"f530fccc6b3de","name_or_id","simple",[],"The RBAC permission name or UUID.",{"type":"82","$schema":"83","x-stoplight":"84"},["85","86","87","88","89"],"8a2d17d5a8d82","entity_id",[],"ID of the entity associated with this permission.",{"type":"82","$schema":"83","x-stoplight":"90"},["85","86","87","88","89"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"f6975afbef9cc","application/json",["100"],[],{"type":"101","properties":"102","x-examples":"103","$schema":"83","x-stoplight":"104"},"de129f4038d99",["105","106","107"],[],{"type":"101","properties":"108","required":"109","title":"110","$schema":"83","x-stoplight":"111"},"string","http://json-schema.org/draft-07/schema#",{"id":"112"},"schema","name","in","required","description",{"id":"113"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","114"],{"id":"115","key":"116","value":"117"},"object",{"actions":"118","created_at":"119","entity_id":"120","entity_type":"121","negative":"122","role":"123","role_source":"124"},{"Example 1":"125"},{"id":"126"},{"id":"127","key":"128","value":"129","summary":"130"},{"id":"131","key":"132","value":"133","summary":"134"},{"id":"135","key":"136","value":"137","summary":"138"},{"status":"139","message":"140"},["141","142"],"UnauthorizedError",{"id":"143"},"2962a7a1a35ac","c7929a81f43f0","https","2caa284203a46","example-response",{"actions":"144","created_at":0,"entity_id":"82","entity_type":"82","negative":true,"role":"145"},{"type":"146","items":"147"},{"type":"148"},{"type":"82"},{"type":"82"},{"type":"149"},{"type":"101","properties":"150"},{"description":"151","type":"82","default":"152","enum":"153"},{"actions":"154","created_at":1557771505,"entity_id":"155","entity_type":"156","negative":false,"role":"157"},"4c8ea7270c741","eb5b789e19123","DuplicateApiKey",{"message":"130","status":401},"Duplicate API key found","9f10d1dd9c6ec","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","e3aacd92aa4fc","NoAPIKey",{"message":"158","status":401},"No API key found",{"type":"148"},{"type":"82"},"status","message","470b68e5f0549",["82"],{"id":"82"},"array",{"type":"82"},"integer","boolean",{"id":"159"},"The origin of the RBAC user role. Specifies where the user role is defined, either locally or through an identity provider (IdP).","local",["152","160"],["161","162","163"],"*","wildcard",{"id":"164"},"No API key found in request",{"type":"82"},"idp","delete","create","read","bba049fa-bf7e-40ef-8e89-553dda292e99"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/patch-rbac-roles-name_or_id-entities-entity_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Update an Entity Permission",["17"],"9ca1ac15d2fec","patch","/rbac/roles/{name_or_id}/entities/{entity_id}",["18"],{},"patch-rbac-roles-name_or_id-entities-entity_id","inheritedFromService",["19","20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"17"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},{"id":"39","contents":"40"},[],[],[],["41","42"],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"958e3839ee49e","6bc8171bc0775","200",[],["49"],"OK","d658168a504d4","401",[],["50"],"Unauthorized","ea29b6b16d31f",["51"],{"id":"52","name":"53","style":"54","examples":"55","description":"56","required":true,"schema":"57","explicitProperties":"58"},{"id":"59","name":"60","style":"54","examples":"61","description":"62","required":true,"schema":"63","explicitProperties":"64"},{"id":"65","key":"66","extensions":"67","description":"68","type":"69","name":"70","in":"71"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"72","path":"73","port":"74","protocol":"75"},{"id":"76","mediaType":"77","examples":"78","encodings":"79","schema":"80"},{"id":"81","mediaType":"77","examples":"82","encodings":"83","schema":"84"},{"id":"85","mediaType":"77","examples":"86","encodings":"87","schema":"88"},"a4a4fd07ae0cc","name_or_id","simple",[],"The RBAC permission name or UUID.",{"type":"89","$schema":"90","x-stoplight":"91"},["92","93","94","95","96"],"d61dde197779d","entity_id",[],"ID of the entity associated with this permission.",{"type":"89","$schema":"90","x-stoplight":"97"},["92","93","94","95","96"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"98","description":"99"},{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105","enum":"106"},"e902fd4d7f5bd","application/json",["107"],[],{"type":"108","properties":"109","x-examples":"110","$schema":"90","x-stoplight":"111"},"59914985513a1",["112","113","114"],[],{"type":"108","properties":"115","required":"116","title":"117","$schema":"90","x-stoplight":"118"},"3781e9fb0ce23",[],[],{"type":"108","properties":"119","$schema":"90","x-stoplight":"120"},"string","http://json-schema.org/draft-07/schema#",{"id":"121"},"schema","name","in","required","description",{"id":"122"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["104","123"],{"id":"124","key":"125","value":"126"},"object",{"actions":"127","created_at":"128","entity_id":"129","entity_type":"130","negative":"131","role":"132"},{"Example 1":"133"},{"id":"134"},{"id":"135","key":"136","value":"137","summary":"138"},{"id":"139","key":"140","value":"141","summary":"142"},{"id":"143","key":"144","value":"145","summary":"146"},{"status":"147","message":"148"},["149","150"],"UnauthorizedError",{"id":"151"},{"negative":"152","actions":"153"},{"id":"154"},"38e479eb4e7ba","506605e8c8144","https","98fb266c297cd","example-response",{"actions":"155","created_at":1557771505,"entity_id":"156","entity_type":"157","negative":false,"role":"158"},{"type":"159","items":"160"},{"type":"161"},{"type":"89"},{"type":"89"},{"type":"162"},{"type":"108","properties":"163"},{"actions":"164","created_at":1557771505,"entity_id":"156","entity_type":"157","negative":false,"role":"165"},"1e9396e553b83","7157c734ce9a2","DuplicateApiKey",{"message":"138","status":401},"Duplicate API key found","f4fc6f9d9b6b0","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","25819add424ff","NoAPIKey",{"message":"166","status":401},"No API key found",{"type":"161"},{"type":"89"},"status","message","470b68e5f0549",{"type":"162","description":"167"},{"type":"89","description":"168"},"9a8870e7d60e5",["169"],"*","wildcard",{"id":"170"},"array",{"type":"89"},"integer","boolean",{"id":"171"},["169"],{"id":"170"},"No API key found in request","If true, explicitly disallow the actions associated with the permissions tied to this resource. By default this value is false.\n","One or more actions associated with this permission.","update","bba049fa-bf7e-40ef-8e89-553dda292e99",{"type":"89"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-rbac-roles-name_or_id-entities-entity_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete an Entity Permission",["18"],"ce834596d19ce","delete","/rbac/roles/{name_or_id}/entities/{entity_id}",["19"],{},"delete-rbac-roles-name_or_id-entities-entity_id","Delete an Entity Permission\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"958e3839ee49e","90d83b4db56c2","204",[],[],"No Content","39083970f374d","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"50","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},"5c905dc0c43a2","name_or_id","simple",[],"The RBAC permission name or UUID.",{"type":"77","$schema":"78","x-stoplight":"79"},["80","81","82","83","84"],"af67ac074e007","entity_id",[],"ID of the entity associated with this permission.",{"type":"77","$schema":"78","x-stoplight":"85"},["80","81","82","83","84"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"86","description":"87"},{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93","enum":"94"},"586c3adbaafe5","application/json",["95","96","97"],[],{"type":"98","properties":"99","required":"100","title":"101","$schema":"78","x-stoplight":"102"},"string","http://json-schema.org/draft-07/schema#",{"id":"103"},"schema","name","in","required","description",{"id":"104"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["92","105"],{"id":"106","key":"107","value":"108","summary":"109"},{"id":"110","key":"111","value":"112","summary":"113"},{"id":"114","key":"115","value":"116","summary":"117"},"object",{"status":"118","message":"119"},["120","121"],"UnauthorizedError",{"id":"122"},"09598c33f64d8","2a58ed34dfdca","https","b77e51e6df75e","DuplicateApiKey",{"message":"109","status":401},"Duplicate API key found","96cee1a28a137","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","af08af99503b3","NoAPIKey",{"message":"123","status":401},"No API key found",{"type":"124"},{"type":"77"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-rbac-roles-name_or_id-permissions",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"List Role Permissions",["17"],"57c2f5fd95255","get","/rbac/roles/{name_or_id}/permissions",["18"],{},"get-rbac-roles-name_or_id-permissions","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"RBAC",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38"],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"958e3839ee49e","a2c3629e1b59a","200",[],["45"],"OK","fad3647addd4d","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},{"id":"65","mediaType":"66","examples":"67","encodings":"68","schema":"69"},{"id":"70","mediaType":"66","examples":"71","encodings":"72","schema":"73"},"85ea0ee702c50","name_or_id","simple",[],"The RBAC role name or UUID.",{"type":"74","$schema":"75","x-stoplight":"76"},["77","78","79","80","81"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"82","description":"83"},{"default":"84","description":"85"},{"default":"86","description":"87"},{"default":"88","description":"89","enum":"90"},"c5e6490927a59","application/json",["91"],[],{"type":"92","properties":"93","x-examples":"94","$schema":"75","x-stoplight":"95"},"26864200a75fd",["96","97","98"],[],{"type":"92","properties":"99","required":"100","title":"101","$schema":"75","x-stoplight":"102"},"string","http://json-schema.org/draft-07/schema#",{"id":"103"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["88","104"],{"id":"105","key":"106","value":"107"},"object",{"endpoints":"108","entities":"109"},{"Example 1":"110"},{"id":"111"},{"id":"112","key":"113","value":"114","summary":"115"},{"id":"116","key":"117","value":"118","summary":"119"},{"id":"120","key":"121","value":"122","summary":"123"},{"status":"124","message":"125"},["126","127"],"UnauthorizedError",{"id":"128"},"67b2b1f398d50","https","2e6fd8b9a8586","role-permission-example",{"endpoints":"129","entities":"130"},{"type":"92","properties":"131"},{"type":"92","properties":"132"},{"endpoints":"133","entities":"134"},"115bf4390d50e","2460c4afddeb6","DuplicateApiKey",{"message":"115","status":401},"Duplicate API key found","2cf30bcfb2a38","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","1142d6b24a0d2","NoAPIKey",{"message":"135","status":401},"No API key found",{"type":"136"},{"type":"74"},"status","message","470b68e5f0549",{"*":"137"},{},{"*":"138"},{},{"*":"139"},{},"No API key found in request","integer",{"*":"140","/*/rbac/*":"141"},{"type":"92","properties":"142"},{"*":"143","/*/rbac/*":"144"},{"actions":"145","negative":false},{"actions":"146","negative":true},{"*":"147","/*/rbac/*":"148"},{"actions":"149","negative":false},{"actions":"150","negative":true},["151","152","153","154"],["151","152","153","154"],{"type":"92","properties":"155"},{"type":"92","properties":"156"},["151","152","153","154"],["151","152","153","154"],"delete","create","update","read",{"actions":"157","negative":"158"},{"actions":"159","negative":"160"},{"type":"161","items":"162"},{"type":"163"},{"type":"161","items":"164"},{"type":"163"},"array",{"type":"74"},"boolean",{"type":"74"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-rbac-users-name_or_id-roles",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List a User’s Roles",["18"],"ee84303099d47","get","/rbac/users/{name_or_id}/roles",["19"],{},"get-rbac-users-name_or_id-roles","Add a User to a Role\n","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"RBAC",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33"],["34"],{"id":"35","url":"36","name":"37","description":"38","variables":"39"},"958e3839ee49e","8bef801b00409","200",[],["40"],"OK",{"id":"41","name":"42","style":"43","examples":"44","description":"45","required":true,"schema":"46","explicitProperties":"47"},{"id":"48","key":"49","extensions":"50","description":"51","type":"52","name":"53","in":"54"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"55","path":"56","port":"57","protocol":"58"},{"id":"59","mediaType":"60","examples":"61","encodings":"62","schema":"63"},"ac2149eb72a2c","name_or_id","simple",[],"The RBAC user name or UUID.",{"type":"64","$schema":"65","x-stoplight":"66"},["67","68","69","70","71"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"72","description":"73"},{"default":"74","description":"75"},{"default":"76","description":"77"},{"default":"78","description":"79","enum":"80"},"4a474d43ae27e","application/json",["81"],[],{"type":"82","properties":"83","x-examples":"84","$schema":"65","x-stoplight":"85"},"string","http://json-schema.org/draft-07/schema#",{"id":"86"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["78","87"],{"id":"88","key":"89","value":"90"},"object",{"roles":"91","user":"92"},{"Example 1":"93"},{"id":"94"},"2719b68817707","https","d0e05d4665348","Example 1",{"roles":"95","user":"96"},{"type":"97","items":"98"},{"type":"82","properties":"99"},{"roles":"100","user":"101"},"db2721b084e00",["102","103"],{"comment":null,"created_at":1557772232,"enabled":true,"id":"104","name":"105","user_token":"106","user_token_ident":"107"},"array",{"type":"82","properties":"108"},{"comment":"109","created_at":"110","enabled":"111","id":"112","name":"113","user_token":"114","user_token_ident":"115"},["116","117"],{"comment":null,"created_at":1557772232,"enabled":true,"id":"104","name":"105","user_token":"106","user_token_ident":"107"},{"comment":"118","created_at":1557765500,"id":"119","name":"120"},{"created_at":1557772263,"id":"121","name":"122"},"b65ca712-7ceb-4114-87f4-5c310492582c","gruce-wayne","$2b$09$gZnMKK/mm/d2rAXN7gL63uL43mjdX/62iwMqdyCQwLyC0af3ce/1K","88ea3",{"comment":"123","created_at":"124","id":"125","name":"126"},{"type":"64"},{"type":"127"},{"type":"128"},{"type":"64"},{"type":"64"},{"type":"64"},{"type":"64"},{"comment":"118","created_at":1557765500,"id":"119","name":"120"},{"created_at":1557772263,"id":"121","name":"122"},"Read access to all endpoints, across all workspaces","a1c810ee-8366-4654-ba0c-963ffb9ccf2e","read-only","aae80073-095f-4553-ba9a-bee5ed3b8b91","doc-knight",{"type":"64"},{"type":"127"},{"type":"64"},{"type":"64"},"integer","boolean"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-rbac-users-name_or_id-roles",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Add a User to a Role",["18"],"8db830fdab02f","post","/rbac/users/{name_or_id}/roles",["19"],{},"post-rbac-users-name_or_id-roles","Add a User to a Role\n","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"RBAC",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41"},[],[],[],["42"],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"958e3839ee49e","226b6b217268f","201",[],["49"],"Created","7a8b6cfe35a07","401",[],["50"],"Unauthorized","774c101fdf92a",["51"],{"id":"52","name":"53","style":"54","examples":"55","description":"56","required":true,"schema":"57","explicitProperties":"58"},{"id":"59","key":"60","extensions":"61","description":"62","type":"63","name":"64","in":"65"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"66","path":"67","port":"68","protocol":"69"},{"id":"70","mediaType":"71","examples":"72","encodings":"73","schema":"74"},{"id":"75","mediaType":"71","examples":"76","encodings":"77","schema":"78"},{"id":"79","mediaType":"71","examples":"80","encodings":"81","schema":"82"},"675c18241c2e1","name_or_id","simple",[],"The RBAC user name or UUID.",{"type":"83","$schema":"84","x-stoplight":"85"},["86","87","88","89","90"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"91","description":"92"},{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98","enum":"99"},"a0dccf0ba3986","application/json",["100"],[],{"type":"101","properties":"102","x-examples":"103","$schema":"84","x-stoplight":"104"},"e14fdf6c1370e",["105","106","107"],[],{"type":"101","properties":"108","required":"109","title":"110","$schema":"84","x-stoplight":"111"},"1f69b106b2618",[],[],{"type":"101","properties":"112","$schema":"84","x-stoplight":"113"},"string","http://json-schema.org/draft-07/schema#",{"id":"114"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["97","115"],{"id":"116","key":"117","value":"118"},"object",{"roles":"119","user":"120"},{"Example 1":"121"},{"id":"122"},{"id":"123","key":"124","value":"125","summary":"126"},{"id":"127","key":"128","value":"129","summary":"130"},{"id":"131","key":"132","value":"133","summary":"134"},{"status":"135","message":"136"},["137","138"],"UnauthorizedError",{"id":"139"},{"roles":"140"},{"id":"141"},"6f969874276d1","https","9126bdb891339","example-role-created",{"roles":"142","user":"143"},{"type":"144","items":"145"},{"type":"101","properties":"146"},{"roles":"147","user":"148"},"d995508e06856","c21f2c2425b54","DuplicateApiKey",{"message":"126","status":401},"Duplicate API key found","76c936b4eb10f","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","33bfd87d97f01","NoAPIKey",{"message":"149","status":401},"No API key found",{"type":"150"},{"type":"83"},"status","message","470b68e5f0549",{"type":"83","description":"151"},"e36169ba43c3b",["152"],{"comment":null,"created_at":1557772232,"enabled":true,"id":"153","name":"154","user_token":"155","user_token_ident":"156"},"array",{"type":"101","properties":"157"},{"comment":"158","created_at":"159","enabled":"160","id":"161","name":"162","user_token":"163","user_token_ident":"164"},["165"],{"comment":null,"created_at":1557772232,"enabled":true,"id":"153","name":"154","user_token":"155","user_token_ident":"156"},"No API key found in request","integer","Comma-separated list of role names to assign to the user.",{"created_at":1557772263,"id":"166","name":"167"},"b65ca712-7ceb-4114-87f4-5c310492582c","gruce-wayne","$2b$09$gZnMKK/mm/d2rAXN7gL63uL43mjdX/62iwMqdyCQwLyC0af3ce/1K","88ea3",{"created_at":"168","id":"169","name":"170"},{"type":"83"},{"type":"150"},{"type":"171"},{"type":"83"},{"type":"83"},{"type":"83"},{"type":"83"},{"created_at":1557772263,"id":"166","name":"167"},"aae80073-095f-4553-ba9a-bee5ed3b8b91","doc-knight",{"type":"150"},{"type":"83"},{"type":"83"},"boolean"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-rbac-users-name_or_id-roles",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"4","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Delete a Role from a User",["17"],"b5b81c41ec3fb","delete","/rbac/users/{name_or_id}/roles",["18"],{},"delete-rbac-users-name_or_id-roles","inheritedFromService",["19"],{"headers":"20","query":"21","cookie":"22","path":"23"},["24"],["25"],"RBAC",{"id":"26","name":"17"},{"id":"27","code":"28","headers":"29","contents":"30","description":"31"},[],[],[],["32"],["33"],{"id":"34","url":"35","name":"36","description":"37","variables":"38"},"958e3839ee49e","81cb432fdaedd","204",[],[],"No Content",{"id":"39","name":"40","style":"41","examples":"42","description":"43","required":true,"schema":"44","explicitProperties":"45"},{"id":"46","key":"47","extensions":"48","description":"49","type":"50","name":"51","in":"52"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"53","path":"54","port":"55","protocol":"56"},"2e47c79934a58","name_or_id","simple",[],"The RBAC user name or UUID.",{"type":"57","$schema":"58","x-stoplight":"59"},["60","61","62","63","64"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"65","description":"66"},{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72","enum":"73"},"string","http://json-schema.org/draft-07/schema#",{"id":"74"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["71","75"],"ee522bd1e32fa","https"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-rbac-users-name_or_id-permissions",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List a User’s Permissions",["18"],"b434d87988dca","get","/rbac/users/{name_or_id}/permissions",["19"],{},"get-rbac-users-name_or_id-permissions","List a User’s Permissions\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"958e3839ee49e","468fff9f84db6","200",[],["46"],"OK","793fff13d3210","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","key":"56","extensions":"57","description":"58","type":"59","name":"60","in":"61"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"62","path":"63","port":"64","protocol":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},"acc8361c02343","name_or_id","simple",[],"The RBAC user name or UUID.",{"type":"75","$schema":"76","x-stoplight":"77"},["78","79","80","81","82"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88"},{"default":"89","description":"90","enum":"91"},"dfb990c766f50","application/json",["92"],[],{"type":"93","properties":"94","x-examples":"95","$schema":"76","x-stoplight":"96"},"8ffbed3b8aaf4",["97","98","99"],[],{"type":"93","properties":"100","required":"101","title":"102","$schema":"76","x-stoplight":"103"},"string","http://json-schema.org/draft-07/schema#",{"id":"104"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["89","105"],{"id":"106","key":"107","value":"108"},"object",{"endpoints":"109","entities":"110"},{"Example 1":"111"},{"id":"112"},{"id":"113","key":"114","value":"115","summary":"116"},{"id":"117","key":"118","value":"119","summary":"120"},{"id":"121","key":"122","value":"123","summary":"124"},{"status":"125","message":"126"},["127","128"],"UnauthorizedError",{"id":"129"},"8e79aae613b0b","https","e63e77e26574f","Example 1",{"endpoints":"130","entities":"131"},{"type":"93","properties":"132"},{"type":"93","properties":"133"},{"endpoints":"134","entities":"135"},"b5ba229123646","8a63e9db0fb09","DuplicateApiKey",{"message":"116","status":401},"Duplicate API key found","809231e8c8586","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","101eeb2660524","NoAPIKey",{"message":"136","status":401},"No API key found",{"type":"137"},{"type":"75"},"status","message","470b68e5f0549",{"*":"138"},{},{"*":"139"},{},{"*":"140"},{},"No API key found in request","integer",{"*":"141"},{"type":"93","properties":"142"},{"*":"143"},{"actions":"144","negative":false},{"*":"145"},{"actions":"146","negative":false},["147"],{"type":"93","properties":"148"},["147"],"read",{"actions":"149","negative":"150"},{"type":"151","items":"152"},{"type":"153"},"array",{"type":"75"},"boolean"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-rbac-roles-by-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List roles for a workspace",["18"],"3fb33fbc510c7","get","/{workspace}/rbac/roles",["19"],{},"get-rbac-roles-by-workspace","List all roles by workspace","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"RBAC",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33"],["34"],{"id":"35","url":"36","name":"37","description":"38","variables":"39"},"958e3839ee49e","4baa4d169ea80","200",[],["40"],"OK",{"id":"41","name":"42","style":"43","examples":"44","description":"45","required":true,"schema":"46","explicitProperties":"47"},{"id":"48","key":"49","extensions":"50","description":"51","type":"52","name":"53","in":"54"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"55","path":"56","port":"57","protocol":"58"},{"id":"59","mediaType":"60","examples":"61","encodings":"62","schema":"63"},"b164f05087c50","workspace","simple",[],"The workspace name or UUID.",{"type":"64","$schema":"65","x-stoplight":"66"},["67","68","69","70","71"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"72","description":"73"},{"default":"74","description":"75"},{"default":"76","description":"77"},{"default":"78","description":"79","enum":"80"},"8e9bfb3896b96","application/json",["81"],[],{"type":"82","properties":"83","x-examples":"84","$schema":"65","x-stoplight":"85"},"string","http://json-schema.org/draft-07/schema#",{"id":"86"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["78","87"],{"id":"88","key":"89","value":"90"},"object",{"data":"91","next":"92"},{"Example 1":"93"},{"id":"94"},"92f0a32fa81f8","https","ba36087e2cc42","Multiple roles",{"data":"95","next":null},{"type":"96","items":"97"},{"type":"64"},{"data":"98","next":null},"8f9833a79515c",["99","100","101","102"],"array",{"type":"82","properties":"103"},["104","105","106","107"],{"comment":"108","created_at":1557506249,"id":"109","name":"110"},{"comment":"111","created_at":1557506249,"id":"112","name":"113"},{"comment":"114","created_at":1557506249,"id":"115","name":"116"},{"comment":null,"created_at":1557532241,"id":"117","name":"118"},{"comment":"119","created_at":"120","id":"121","name":"122"},{"comment":"108","created_at":1557506249,"id":"109","name":"110"},{"comment":"111","created_at":1557506249,"id":"112","name":"113"},{"comment":"114","created_at":1557506249,"id":"115","name":"116"},{"comment":null,"created_at":1557532241,"id":"117","name":"118"},"Full access to all endpoints, across all workspaces—except RBAC Admin API","38a03d47-faae-4366-b430-f6c10aee5029","admin","Read access to all endpoints, across all workspaces","4141675c-8beb-41a5-aa04-6258ab2d2f7f","read-only","Full access to all endpoints, across all workspaces","888117e0-f2b3-404d-823b-dee595423505","super-admin","b5c5cfd4-3330-4796-9b7b-6026e91e3ad6","doc_lord",{"type":"64"},{"type":"123"},{"type":"64"},{"type":"64"},"integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-rbac-roles-workspace",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Add a role",["18"],"d123c240d8f1d","post","/{workspace}/rbac/roles",["19"],{},"post-rbac-roles-workspace","Add a role.","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"RBAC",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35","description":"36"},[],[],[],["37"],["38"],{"id":"39","url":"40","name":"41","description":"42","variables":"43"},"958e3839ee49e","df308abf84744","201",[],["44"],"Created","a26843dff136d",["45"],"The request body contains the name of the role and an optional attribute.",{"id":"46","name":"47","style":"48","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},{"id":"64","mediaType":"65","examples":"66","encodings":"67","schema":"68"},{"id":"69","mediaType":"65","examples":"70","encodings":"71","schema":"72"},"cccace601bdbb","workspace","simple",[],"The workspace name or UUID.",{"type":"73","$schema":"74","x-stoplight":"75"},["76","77","78","79","80"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88","enum":"89"},"ff872257685d0","application/json",["90"],[],{"type":"91","properties":"92","x-examples":"93","$schema":"74","x-stoplight":"94"},"efdb784dd0591",[],[],{"type":"91","properties":"95","$schema":"74","x-stoplight":"96"},"string","http://json-schema.org/draft-07/schema#",{"id":"97"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["87","98"],{"id":"99","key":"100","value":"101"},"object",{"comment":"102","created_at":"103","id":"104","is_default":"105","name":"106"},{"Example 1":"107"},{"id":"108"},{"name":"109","comment":"110"},{"id":"111"},"1554be9569243","https","06f1b7fb92f99","New role response body",{"comment":null,"created_at":1557532241,"id":"112","is_default":false,"name":"113"},{"type":"73"},{"type":"114"},{"type":"73"},{"type":"115"},{"type":"73"},{"comment":null,"created_at":1557532241,"id":"112","is_default":false,"name":"113"},"c2e26df0ffba9",{"type":"73","description":"116"},{"type":"73","description":"117"},"26817e908c3c0","b5c5cfd4-3330-4796-9b7b-6026e91e3ad6","service_reader","integer","boolean","The RBAC role name.","A string describing the RBAC user object."]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/getRoleSpecificEndpointPermissions",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","summary":"4","securityDeclarationType":"12","responses":"13","request":"14","security":"15","servers":"16"},"Get role-specific permissions for an endpoint within a workspace",["17"],"ec4232b74f190","get","/{workspace}/rbac/roles/{role}/endpoints/{endpoint}/",["18"],{},"getRoleSpecificEndpointPermissions","inheritedFromService",["19","20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"RBAC",{"id":"27","name":"17"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},{"id":"33","code":"34","headers":"35","contents":"36","description":"37"},[],[],[],["38","39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"958e3839ee49e","403c36620d440","200",[],["47"],"OK","72cc35b9760fa","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","required":true,"schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","name":"63","style":"51","examples":"64","description":"65","required":true,"schema":"66","explicitProperties":"67"},{"id":"68","key":"69","extensions":"70","description":"71","type":"72","name":"73","in":"74"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"75","path":"76","port":"77","protocol":"78"},{"id":"79","mediaType":"80","examples":"81","encodings":"82","schema":"83"},{"id":"84","mediaType":"80","examples":"85","encodings":"86","schema":"87"},"da85df59fb51f","workspace","simple",[],"The workspace name or UUID.",{"type":"88","$schema":"89","x-stoplight":"90"},["91","92","93","94","95"],"521058449b0bd","role",[],"The RBAC role ID.",{"type":"88","$schema":"89","x-stoplight":"96"},["91","92","93","94","95"],"00cae53d2c624","endpoint",[],"The specific endpoint to retrieve permissions for.",{"type":"88","$schema":"89","x-stoplight":"97"},["91","92","93","94","95"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"98","description":"99"},{"default":"100","description":"101"},{"default":"102","description":"103"},{"default":"104","description":"105","enum":"106"},"f3a2a6c92ff96","application/json",["107"],[],{"type":"108","properties":"109","$schema":"89","x-stoplight":"110"},"1bff4e1840f8c",["111","112","113"],[],{"type":"108","properties":"114","required":"115","title":"116","$schema":"89","x-stoplight":"117"},"string","http://json-schema.org/draft-07/schema#",{"id":"118"},"in","name","required","schema","description",{"id":"119"},{"id":"120"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["104","121"],{"id":"122","value":"123","key":"124"},"object",{"actions":"125","created_at":"126","endpoint":"127","negative":"128","role":"129","role_source":"130","workspace":"131"},{"id":"132"},{"id":"133","key":"134","value":"135","summary":"136"},{"id":"137","key":"138","value":"139","summary":"140"},{"id":"141","key":"142","value":"143","summary":"144"},{"status":"145","message":"146"},["147","148"],"UnauthorizedError",{"id":"149"},"5e6da51dae0aa","c61bec8e0e829","f6322d82ce991","https","3349413010444",{"actions":"150","created_at":1557764505,"endpoint":"151","negative":false,"role":"152","workspace":"124"},"default",{"type":"153","items":"154"},{"type":"155"},{"type":"88"},{"type":"156"},{"type":"108","properties":"157"},{"description":"158","type":"88","default":"159","enum":"160"},{"type":"88"},"e74d8e979c003","0c84e652a8841","DuplicateApiKey",{"message":"136","status":401},"Duplicate API key found","33a3f838f90b2","InvalidAuthCred",{"message":"37","status":401},"Invalid authentication credentials","8f3135aafb317","NoAPIKey",{"message":"161","status":401},"No API key found",{"type":"155"},{"type":"88"},"status","message","470b68e5f0549",["162","163","164","165"],"/consumers",{"id":"166"},"array",{"type":"88"},"integer","boolean",{"id":"167"},"The origin of the RBAC user role. Specifies where the user role is defined, either locally or through an identity provider (IdP).","local",["159","168"],"No API key found in request","delete","create","update","read","23df9f20-e7cc-4da4-bc89-d3a08f976e50",{"type":"88"},"idp"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-filter-chains",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Add Filter Chain",["18"],"f819b66b66310","post","/filter-chains",["19"],{},"post-filter-chains","Create Filter Chain\nNote: This API is not available in DB-less mode.\n","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"filter-chains",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],[],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"453fb3d0f8f1b","20bca4988709f","201",[],["49"],"Created","78dca67549c67","401",[],["50"],"Unauthorized","b95254e9670ea",["51"],"A filter chain is the database entity representing one or more WebAssembly filters executed for each request to a particular service or route, each one with its configuration.",{"id":"52","key":"53","extensions":"54","description":"55","type":"56","name":"57","in":"58"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"59","path":"60","port":"61","protocol":"62"},{"id":"63","mediaType":"64","examples":"65","encodings":"66","schema":"67"},{"id":"68","mediaType":"64","examples":"69","encodings":"70","schema":"71"},{"id":"72","mediaType":"64","examples":"73","encodings":"74","schema":"75"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"76","description":"77"},{"default":"78","description":"79"},{"default":"80","description":"81"},{"default":"82","description":"83","enum":"84"},"69deb6f6cb9c0","application/json",[],[],{"type":"85","x-examples":"86","description":"42","title":"87","properties":"88","$schema":"89","x-stoplight":"90"},"88ca435103bfd",["91","92","93"],[],{"type":"85","properties":"94","required":"95","title":"96","$schema":"89","x-stoplight":"97"},"025c28a690b49",["98"],[],{"type":"85","x-examples":"99","properties":"100","$schema":"89","x-stoplight":"101"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["82","102"],"object",{"Example 1":"103"},"Filter-chains",{"id":"104","name":"105","created_at":"106","updated_at":"107","enabled":"108","route":"109","service":"110","filters":"111","tags":"112"},"http://json-schema.org/draft-07/schema#",{"id":"113"},{"id":"114","key":"115","value":"116","summary":"117"},{"id":"118","key":"119","value":"120","summary":"121"},{"id":"122","key":"123","value":"124","summary":"125"},{"status":"126","message":"127"},["128","129"],"UnauthorizedError",{"id":"130"},{"id":"131","key":"132","value":"133"},{"Example 1":"134"},{" name":"135","enabled":"136","route":"137","service":"138","filters":"139","tags":"140"},{"id":"141"},"https",{"id":"142","name":"143","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"144","filters":"145","tags":"146"},{"type":"147","description":"148","format":"149","examples":"150"},{"type":"147","description":"151","examples":"152"},{"type":"153","examples":"154"},{"type":"153","examples":"155"},{"type":"156","description":"157","default":true},{"description":"158","nullable":true},{"type":"147","description":"159","examples":"160"},{"type":"161","description":"162","items":"163"},{"type":"161","items":"164"},"befdc60dc4d76","c5c11d669e759","DuplicateApiKey",{"message":"117","status":401},"Duplicate API key found","ed019274c10a5","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","fdace89234eda","NoAPIKey",{"message":"165","status":401},"No API key found",{"type":"153"},{"type":"147"},"status","message","470b68e5f0549","d85eed781892f","Example 1",{" name":"143","enabled":"147","route":"147","service":"144","filters":"147","tags":"147"},{"id":"142","name":"143","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"144","filters":"166","tags":"167"},{"type":"147","description":"151","examples":"168"},{"type":"147","description":"157"},{"type":"147","description":"169"},{"type":"147","description":"170","examples":"171"},{"type":"147","description":"162"},{"type":"147","description":"172"},"bc09fa8927983","ce44eef5-41ed-47f6-baab-f725cecf98c7","my-chain","20487393-41ed-47f6-93a8-3407cade2002",["173","174"],["175"],"string","The unique identifier or the name attribute of the route that should be associated to the newly created filter chain.","uuid",["142"],"The name of the filter chain.\n",["143"],"integer",[1422386534],[1422386534],"boolean","Whether the filter chain is applied. Default: true.\n","The route to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. In JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.","The service to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. In JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",["144"],"array","An array of filter definitions. Each filter is an object containing a mandatory name, an optional config, and a boolean enabled setting.",{"type":"85","properties":"176"},{"type":"147"},"No API key found in request",["177","178"],["175"],["143"],"The route to which this chain is applied. \nA filter chain must be applied to either a single route or a single service. \nDefault: `null`. \n\nIn form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. \nIn JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.\n","The service to which this chain is applied. \nA filter chain must be applied to either a single route or a single service. Default: `null`. \n\nIn form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. \nIn JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.\n",["144"],"An optional set of strings associated with the filter chain for grouping and filtering.\n",{"name":"179","enabled":true,"config":"180"},{"name":"181","enabled":true,"config":"182"},"my-tag",{"name":"183","enabled":"184","config":"185"},{"name":"179","enabled":true,"config":"180"},{"name":"181","enabled":true,"config":"182"},"go-rate-limiting","{ \"minute\": 30 }","rust-response-transformer","{ \"remove_header\": \"X-Example\" }",{"type":"147","description":"186","examples":"187"},{"type":"156","description":"188"},{"type":"147","description":"189","examples":"190"},"The name of the filter\n",["179"],"Enable the filter","configuration filter headers",["191"],"{ \\\"minute\\\": 30 }"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-filter-chains",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List Filter Chains",["18"],"ebf4d6b077ce2","get","/filter-chains",["19"],{},"get-filter-chains","List All Filter Chains\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"filter-chains",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"453fb3d0f8f1b","07076f28f3ce4","200",[],["45"],"OK","67377105c354f","401",[],["46"],"Unauthorized",{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},{"id":"63","mediaType":"59","examples":"64","encodings":"65","schema":"66"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"85ad81fa39768","application/json",[],[],{"type":"76","x-examples":"77","description":"78","title":"79","properties":"80","$schema":"81","x-stoplight":"82"},"0493a5cc11d30",["83","84","85"],[],{"type":"76","properties":"86","required":"87","title":"88","$schema":"81","x-stoplight":"89"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","90"],"object",{"Example 1":"91"},"A filter chain is the database entity representing one or more WebAssembly filters executed for each request to a particular service or route, each one with its configuration.","Filter-chains",{"id":"92","name":"93","created_at":"94","updated_at":"95","enabled":"96","route":"97","service":"98","filters":"99","tags":"100"},"http://json-schema.org/draft-07/schema#",{"id":"101"},{"id":"102","key":"103","value":"104","summary":"105"},{"id":"106","key":"107","value":"108","summary":"109"},{"id":"110","key":"111","value":"112","summary":"113"},{"status":"114","message":"115"},["116","117"],"UnauthorizedError",{"id":"118"},"https",{"id":"119","name":"120","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"121","filters":"122","tags":"123"},{"type":"124","description":"125","format":"126","examples":"127"},{"type":"124","description":"128","examples":"129"},{"type":"130","examples":"131"},{"type":"130","examples":"132"},{"type":"133","description":"134","default":true},{"description":"135","nullable":true},{"type":"124","description":"136","examples":"137"},{"type":"138","description":"139","items":"140"},{"type":"138","items":"141"},"befdc60dc4d76","be32496c01bcc","DuplicateApiKey",{"message":"105","status":401},"Duplicate API key found","eecb17d3be438","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","5e8b8081e84b3","NoAPIKey",{"message":"142","status":401},"No API key found",{"type":"130"},{"type":"124"},"status","message","470b68e5f0549","ce44eef5-41ed-47f6-baab-f725cecf98c7","my-chain","20487393-41ed-47f6-93a8-3407cade2002",["143","144"],["145"],"string","The unique identifier or the name attribute of the route that should be associated to the newly created filter chain.","uuid",["119"],"The name of the filter chain.\n",["120"],"integer",[1422386534],[1422386534],"boolean","Whether the filter chain is applied. Default: true.\n","The route to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. In JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.","The service to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. In JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",["121"],"array","An array of filter definitions. Each filter is an object containing a mandatory name, an optional config, and a boolean enabled setting.",{"type":"76","properties":"146"},{"type":"124"},"No API key found in request",{"name":"147","enabled":true,"config":"148"},{"name":"149","enabled":true,"config":"150"},"my-tag",{"name":"151","enabled":"152","config":"153"},"go-rate-limiting","{ \"minute\": 30 }","rust-response-transformer","{ \"remove_header\": \"X-Example\" }",{"type":"124","description":"154","examples":"155"},{"type":"133","description":"156"},{"type":"124","description":"157","examples":"158"},"The name of the filter\n",["147"],"Enable the filter","configuration filter headers",["159"],"{ \\\"minute\\\": 30 }"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-routes-route_name_or_id-filter-chains",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Add Filter Chain",["18"],"a6a17d629f6cc","post","/routes/{route_id_or_name}/filter-chains",["19"],{},"get-routes-route_name_or_id-filter-chains","Create Filter Chain Associated to a Specific Route\n","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"filter-chains",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],["43"],["44"],{"id":"45","url":"46","name":"47","description":"48","variables":"49"},"453fb3d0f8f1b","fc97588fd22e8","201",[],["50"],"Created","54b75a6c940f7","401",[],["51"],"Unauthorized","4903216c02313",["52"],"A filter chain is the database entity representing one or more WebAssembly filters executed for each request to a particular service or route, each one with its configuration.",{"id":"53","name":"54","style":"55","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","key":"61","extensions":"62","description":"63","type":"64","name":"65","in":"66"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"67","path":"68","port":"69","protocol":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},{"id":"76","mediaType":"72","examples":"77","encodings":"78","schema":"79"},{"id":"80","mediaType":"72","examples":"81","encodings":"82","schema":"83"},"5ea55a829e7a5","route_id_or_name","simple",[],"The unique identifier or the name of the route to retrieve.",{"type":"84","examples":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98"},{"default":"99","description":"100","enum":"101"},"218ed6d62c092","application/json",[],[],{"type":"102","x-examples":"103","description":"42","title":"104","properties":"105","$schema":"86","x-stoplight":"106"},"e768f8621cfae",["107","108","109"],[],{"type":"102","properties":"110","required":"111","title":"112","$schema":"86","x-stoplight":"113"},"6d948d8b5bbf6",["114"],[],{"type":"102","x-examples":"115","properties":"116","$schema":"86","x-stoplight":"117"},"string",["118"],"http://json-schema.org/draft-07/schema#",{"id":"119"},"name","in","required","schema","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["99","120"],"object",{"Example 1":"121"},"Filter-chains",{"id":"122","name":"123","created_at":"124","updated_at":"125","enabled":"126","route":"127","service":"128","filters":"129","tags":"130"},{"id":"131"},{"id":"132","key":"133","value":"134","summary":"135"},{"id":"136","key":"137","value":"138","summary":"139"},{"id":"140","key":"141","value":"142","summary":"143"},{"status":"144","message":"145"},["146","147"],"UnauthorizedError",{"id":"148"},{"id":"149","key":"150","value":"151"},{"Example 1":"152"},{" name":"153","enabled":"154","route":"155","service":"156","filters":"157","tags":"158"},{"id":"159"},"my-route","e159f2012ef05","https",{"id":"160","name":"161","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"162","filters":"163","tags":"164"},{"type":"84","description":"165","format":"166","examples":"167"},{"type":"84","description":"168","examples":"169"},{"type":"170","examples":"171"},{"type":"170","examples":"172"},{"type":"173","description":"174","default":true},{"description":"175","nullable":true},{"type":"84","description":"176","examples":"177"},{"type":"178","description":"179","items":"180"},{"type":"178","items":"181"},"befdc60dc4d76","9f8cd80031aef","DuplicateApiKey",{"message":"135","status":401},"Duplicate API key found","9df3a1d6f8c2b","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","4844a013d7a0a","NoAPIKey",{"message":"182","status":401},"No API key found",{"type":"170"},{"type":"84"},"status","message","470b68e5f0549","9dd277713fe2e","Example 1",{" name":"161","enabled":"84","route":"84","service":"162","filters":"84","tags":"84"},{"id":"160","name":"161","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"162","filters":"183","tags":"184"},{"type":"84","description":"168","examples":"185"},{"type":"84","description":"174"},{"type":"84","description":"186"},{"type":"84","description":"187","examples":"188"},{"type":"84","description":"179"},{"type":"84","description":"189"},"bc09fa8927983","ce44eef5-41ed-47f6-baab-f725cecf98c7","my-chain","20487393-41ed-47f6-93a8-3407cade2002",["190","191"],["192"],"The unique identifier or the name attribute of the route that should be associated to the newly created filter chain.","uuid",["160"],"The name of the filter chain.\n",["161"],"integer",[1422386534],[1422386534],"boolean","Whether the filter chain is applied. Default: true.\n","The route to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. In JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.","The service to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. In JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",["162"],"array","An array of filter definitions. Each filter is an object containing a mandatory name, an optional config, and a boolean enabled setting.",{"type":"102","properties":"193"},{"type":"84"},"No API key found in request",["194","195"],["192"],["161"],"The route to which this chain is applied. \nA filter chain must be applied to either a single route or a single service. \nDefault: `null`. \n\nIn form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. \nIn JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.\n","The service to which this chain is applied. \nA filter chain must be applied to either a single route or a single service. Default: `null`. \n\nIn form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. \nIn JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.\n",["162"],"An optional set of strings associated with the filter chain for grouping and filtering.\n",{"name":"196","enabled":true,"config":"197"},{"name":"198","enabled":true,"config":"199"},"my-tag",{"name":"200","enabled":"201","config":"202"},{"name":"196","enabled":true,"config":"197"},{"name":"198","enabled":true,"config":"199"},"go-rate-limiting","{ \"minute\": 30 }","rust-response-transformer","{ \"remove_header\": \"X-Example\" }",{"type":"84","description":"203","examples":"204"},{"type":"173","description":"205"},{"type":"84","description":"206","examples":"207"},"The name of the filter\n",["196"],"Enable the filter","configuration filter headers",["208"],"{ \\\"minute\\\": 30 }"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-routes-route_id_or_name-filter-chains",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List Filter Chains Associated to a Specific Route",["18"],"ac4a25460dfd2","get","/routes/{route_id_or_name}/filter-chains",["19"],{},"get-routes-route_id_or_name-filter-chains","List Filter Chains Associated to a Specific Route\n","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"filter-chains",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33"],["34"],{"id":"35","url":"36","name":"37","description":"38","variables":"39"},"453fb3d0f8f1b","37a0eab82c5b1","200",[],["40"],"OK",{"id":"41","name":"42","style":"43","examples":"44","description":"45","required":true,"schema":"46","explicitProperties":"47"},{"id":"48","key":"49","extensions":"50","description":"51","type":"52","name":"53","in":"54"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"55","path":"56","port":"57","protocol":"58"},{"id":"59","mediaType":"60","examples":"61","encodings":"62","schema":"63"},"b15becc35e7d2","route_id_or_name","simple",[],"The unique identifier or the name of the route to retrieve.",{"type":"64","examples":"65","$schema":"66","x-stoplight":"67"},["68","69","70","71","72"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"73","description":"74"},{"default":"75","description":"76"},{"default":"77","description":"78"},{"default":"79","description":"80","enum":"81"},"594e31a969031","application/json",[],[],{"type":"82","x-examples":"83","description":"84","title":"85","properties":"86","$schema":"66","x-stoplight":"87"},"string",["88"],"http://json-schema.org/draft-07/schema#",{"id":"89"},"name","in","required","schema","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["79","90"],"object",{"Example 1":"91"},"A filter chain is the database entity representing one or more WebAssembly filters executed for each request to a particular service or route, each one with its configuration.","Filter-chains",{"id":"92","name":"93","created_at":"94","updated_at":"95","enabled":"96","route":"97","service":"98","filters":"99","tags":"100"},{"id":"101"},"my-route","0823752cbe559","https",{"id":"102","name":"103","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"104","filters":"105","tags":"106"},{"type":"64","description":"107","format":"108","examples":"109"},{"type":"64","description":"110","examples":"111"},{"type":"112","examples":"113"},{"type":"112","examples":"114"},{"type":"115","description":"116","default":true},{"description":"117","nullable":true},{"type":"64","description":"118","examples":"119"},{"type":"120","description":"121","items":"122"},{"type":"120","items":"123"},"befdc60dc4d76","ce44eef5-41ed-47f6-baab-f725cecf98c7","my-chain","20487393-41ed-47f6-93a8-3407cade2002",["124","125"],["126"],"The unique identifier or the name attribute of the route that should be associated to the newly created filter chain.","uuid",["102"],"The name of the filter chain.\n",["103"],"integer",[1422386534],[1422386534],"boolean","Whether the filter chain is applied. Default: true.\n","The route to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. In JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.","The service to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. In JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",["104"],"array","An array of filter definitions. Each filter is an object containing a mandatory name, an optional config, and a boolean enabled setting.",{"type":"82","properties":"127"},{"type":"64"},{"name":"128","enabled":true,"config":"129"},{"name":"130","enabled":true,"config":"131"},"my-tag",{"name":"132","enabled":"133","config":"134"},"go-rate-limiting","{ \"minute\": 30 }","rust-response-transformer","{ \"remove_header\": \"X-Example\" }",{"type":"64","description":"135","examples":"136"},{"type":"115","description":"137"},{"type":"64","description":"138","examples":"139"},"The name of the filter\n",["128"],"Enable the filter","configuration filter headers",["140"],"{ \\\"minute\\\": 30 }"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/patch-routes-route_id_or_name-filter-chains",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update Filter Chain Associated to a Specific Route",["18"],"72a2a95125d8e","patch","/routes/{route_id_or_name}/filter-chains",["19"],{},"patch-routes-route_id_or_name-filter-chains","Update Filter Chain Associated to a Specific Route\n","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"filter-chains",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],["43"],["44"],{"id":"45","url":"46","name":"47","description":"48","variables":"49"},"453fb3d0f8f1b","1169c9a00b20c","201",[],["50"],"Created","dec9ca48a2790","401",[],["51"],"Unauthorized","c33868d90bbe5",["52"],"A filter chain is the database entity representing one or more WebAssembly filters executed for each request to a particular service or route, each one with its configuration.",{"id":"53","name":"54","style":"55","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","key":"61","extensions":"62","description":"63","type":"64","name":"65","in":"66"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"67","path":"68","port":"69","protocol":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},{"id":"76","mediaType":"72","examples":"77","encodings":"78","schema":"79"},{"id":"80","mediaType":"72","examples":"81","encodings":"82","schema":"83"},"c0ea724a41e11","route_id_or_name","simple",[],"The unique identifier or the name of the route to retrieve.",{"type":"84","examples":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98"},{"default":"99","description":"100","enum":"101"},"a7d62f1e1edc7","application/json",[],[],{"type":"102","x-examples":"103","description":"42","title":"104","properties":"105","$schema":"86","x-stoplight":"106"},"3879252f39b15",["107","108","109"],[],{"type":"102","properties":"110","required":"111","title":"112","$schema":"86","x-stoplight":"113"},"581e51cdcb0c3",["114"],[],{"type":"102","x-examples":"115","properties":"116","$schema":"86","x-stoplight":"117"},"string",["118"],"http://json-schema.org/draft-07/schema#",{"id":"119"},"name","in","required","schema","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["99","120"],"object",{"Example 1":"121"},"Filter-chains",{"id":"122","name":"123","created_at":"124","updated_at":"125","enabled":"126","route":"127","service":"128","filters":"129","tags":"130"},{"id":"131"},{"id":"132","key":"133","value":"134","summary":"135"},{"id":"136","key":"137","value":"138","summary":"139"},{"id":"140","key":"141","value":"142","summary":"143"},{"status":"144","message":"145"},["146","147"],"UnauthorizedError",{"id":"148"},{"id":"149","key":"150","value":"151"},{"Example 1":"152"},{" name":"153","enabled":"154","route":"155","service":"156","filters":"157","tags":"158"},{"id":"159"},"my-route","0bbb470c091c5","https",{"id":"160","name":"161","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"162","filters":"163","tags":"164"},{"type":"84","description":"165","format":"166","examples":"167"},{"type":"84","description":"168","examples":"169"},{"type":"170","examples":"171"},{"type":"170","examples":"172"},{"type":"173","description":"174","default":true},{"description":"175","nullable":true},{"type":"84","description":"176","examples":"177"},{"type":"178","description":"179","items":"180"},{"type":"178","items":"181"},"befdc60dc4d76","ce262c9d9384d","DuplicateApiKey",{"message":"135","status":401},"Duplicate API key found","3808caec00c2f","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","fa50088e9837a","NoAPIKey",{"message":"182","status":401},"No API key found",{"type":"170"},{"type":"84"},"status","message","470b68e5f0549","66bc362ac5abc","Example 1",{" name":"161","enabled":"84","route":"84","service":"162","filters":"84","tags":"84"},{"id":"160","name":"161","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"162","filters":"183","tags":"184"},{"type":"84","description":"168","examples":"185"},{"type":"84","description":"174"},{"type":"84","description":"186"},{"type":"84","description":"187","examples":"188"},{"type":"84","description":"179"},{"type":"84","description":"189"},"bc09fa8927983","ce44eef5-41ed-47f6-baab-f725cecf98c7","my-chain","20487393-41ed-47f6-93a8-3407cade2002",["190","191"],["192"],"The unique identifier or the name attribute of the route that should be associated to the newly created filter chain.","uuid",["160"],"The name of the filter chain.\n",["161"],"integer",[1422386534],[1422386534],"boolean","Whether the filter chain is applied. Default: true.\n","The route to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. In JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.","The service to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. In JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",["162"],"array","An array of filter definitions. Each filter is an object containing a mandatory name, an optional config, and a boolean enabled setting.",{"type":"102","properties":"193"},{"type":"84"},"No API key found in request",["194","195"],["192"],["161"],"The route to which this chain is applied. \nA filter chain must be applied to either a single route or a single service. \nDefault: `null`. \n\nIn form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. \nIn JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.\n","The service to which this chain is applied. \nA filter chain must be applied to either a single route or a single service. Default: `null`. \n\nIn form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. \nIn JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.\n",["162"],"An optional set of strings associated with the filter chain for grouping and filtering.\n",{"name":"196","enabled":true,"config":"197"},{"name":"198","enabled":true,"config":"199"},"my-tag",{"name":"200","enabled":"201","config":"202"},{"name":"196","enabled":true,"config":"197"},{"name":"198","enabled":true,"config":"199"},"go-rate-limiting","{ \"minute\": 30 }","rust-response-transformer","{ \"remove_header\": \"X-Example\" }",{"type":"84","description":"203","examples":"204"},{"type":"173","description":"205"},{"type":"84","description":"206","examples":"207"},"The name of the filter\n",["196"],"Enable the filter","configuration filter headers",["208"],"{ \\\"minute\\\": 30 }"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-services-service_id_or_name-filter-chains",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create Filter Chain Associated to a Specific Service",["18"],"e9711283c09d1","post","/services/{service_id_or_name}/filter-chains",["19"],{},"get-services-service_id_or_name-filter-chains","Add filter chain Associated to a Specific Service\n","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"filter-chains",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],["43"],["44"],{"id":"45","url":"46","name":"47","description":"48","variables":"49"},"453fb3d0f8f1b","7a51da73d2c97","201",[],["50"],"Created","2231d8971081f","401",[],["51"],"Unauthorized","42bf060d36554",["52"],"A filter chain is the database entity representing one or more WebAssembly filters executed for each request to a particular service or route, each one with its configuration.",{"id":"53","name":"54","style":"55","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","key":"61","extensions":"62","description":"63","type":"64","name":"65","in":"66"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"67","path":"68","port":"69","protocol":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},{"id":"76","mediaType":"72","examples":"77","encodings":"78","schema":"79"},{"id":"80","mediaType":"72","examples":"81","encodings":"82","schema":"83"},"12afe0abdf146","service_id_or_name","simple",["84"],"ID **or** name of the service to lookup",{"type":"85","examples":"86","$schema":"87","x-stoplight":"88"},["89","90","91","92","93","94","95"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"96","description":"97"},{"default":"98","description":"99"},{"default":"100","description":"101"},{"default":"102","description":"103","enum":"104"},"ae85ee332b3ac","application/json",[],[],{"type":"105","x-examples":"106","description":"42","title":"107","properties":"108","$schema":"87","x-stoplight":"109"},"9d52ee7efd9db",["110","111","112"],[],{"type":"105","properties":"113","required":"114","title":"115","$schema":"87","x-stoplight":"116"},"073066ac1341e",["117"],[],{"type":"105","x-examples":"118","properties":"119","$schema":"87","x-stoplight":"120"},{"id":"121","value":"122","key":"123"},"string",["122"],"http://json-schema.org/draft-07/schema#",{"id":"124"},"name","description","example","in","required","schema","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["102","125"],"object",{"Example 1":"126"},"Filter-chains",{"id":"127","name":"128","created_at":"129","updated_at":"130","enabled":"131","route":"132","service":"133","filters":"134","tags":"135"},{"id":"136"},{"id":"137","key":"138","value":"139","summary":"140"},{"id":"141","key":"142","value":"143","summary":"144"},{"id":"145","key":"146","value":"147","summary":"148"},{"status":"149","message":"150"},["151","152"],"UnauthorizedError",{"id":"153"},{"id":"154","key":"155","value":"156"},{"Example 1":"157"},{" name":"158","enabled":"159","route":"160","service":"161","filters":"162","tags":"163"},{"id":"164"},"f2e8e820d607e","test-service","default","b130c43d0aeab","https",{"id":"165","name":"166","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"167","filters":"168","tags":"169"},{"type":"85","description":"170","format":"171","examples":"172"},{"type":"85","description":"173","examples":"174"},{"type":"175","examples":"176"},{"type":"175","examples":"177"},{"type":"178","description":"179","default":true},{"description":"180","nullable":true},{"type":"85","description":"181","examples":"182"},{"type":"183","description":"184","items":"185"},{"type":"183","items":"186"},"befdc60dc4d76","fffc4c7f4f90d","DuplicateApiKey",{"message":"140","status":401},"Duplicate API key found","a8e8fe6c799de","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","7be3e04d578f6","NoAPIKey",{"message":"187","status":401},"No API key found",{"type":"175"},{"type":"85"},"status","message","470b68e5f0549","4546832ec3bb5","Example 1",{" name":"166","enabled":"85","route":"85","service":"167","filters":"85","tags":"85"},{"id":"165","name":"166","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"167","filters":"188","tags":"189"},{"type":"85","description":"173","examples":"190"},{"type":"85","description":"179"},{"type":"85","description":"191"},{"type":"85","description":"192","examples":"193"},{"type":"85","description":"184"},{"type":"85","description":"194"},"bc09fa8927983","ce44eef5-41ed-47f6-baab-f725cecf98c7","my-chain","20487393-41ed-47f6-93a8-3407cade2002",["195","196"],["197"],"The unique identifier or the name attribute of the route that should be associated to the newly created filter chain.","uuid",["165"],"The name of the filter chain.\n",["166"],"integer",[1422386534],[1422386534],"boolean","Whether the filter chain is applied. Default: true.\n","The route to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. In JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.","The service to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. In JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",["167"],"array","An array of filter definitions. Each filter is an object containing a mandatory name, an optional config, and a boolean enabled setting.",{"type":"105","properties":"198"},{"type":"85"},"No API key found in request",["199","200"],["197"],["166"],"The route to which this chain is applied. \nA filter chain must be applied to either a single route or a single service. \nDefault: `null`. \n\nIn form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. \nIn JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.\n","The service to which this chain is applied. \nA filter chain must be applied to either a single route or a single service. Default: `null`. \n\nIn form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. \nIn JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.\n",["167"],"An optional set of strings associated with the filter chain for grouping and filtering.\n",{"name":"201","enabled":true,"config":"202"},{"name":"203","enabled":true,"config":"204"},"my-tag",{"name":"205","enabled":"206","config":"207"},{"name":"201","enabled":true,"config":"202"},{"name":"203","enabled":true,"config":"204"},"go-rate-limiting","{ \"minute\": 30 }","rust-response-transformer","{ \"remove_header\": \"X-Example\" }",{"type":"85","description":"208","examples":"209"},{"type":"178","description":"210"},{"type":"85","description":"211","examples":"212"},"The name of the filter\n",["201"],"Enable the filter","configuration filter headers",["213"],"{ \\\"minute\\\": 30 }"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-service_id_or_name-filter-chains",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List Filter Chains Associated to a Specific Service",["18"],"59cc9574d1a5b","get","/services/{service_id_or_name}/filter-chains",["19"],{},"get-service_id_or_name-filter-chains","List Filter Chains Associated to a Specific Service\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"filter-chains",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"453fb3d0f8f1b","5c7c5ed84f8ec","200",[],["46"],"OK","21cc5f80d7584","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","key":"56","extensions":"57","description":"58","type":"59","name":"60","in":"61"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"62","path":"63","port":"64","protocol":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},"72fe3e3d3c898","service_id_or_name","simple",["75"],"ID **or** name of the service to lookup",{"type":"76","examples":"77","$schema":"78","x-stoplight":"79"},["80","81","82","83","84","85","86"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"87","description":"88"},{"default":"89","description":"90"},{"default":"91","description":"92"},{"default":"93","description":"94","enum":"95"},"e575aaa4accdb","application/json",[],[],{"type":"96","x-examples":"97","description":"98","title":"99","properties":"100","$schema":"78","x-stoplight":"101"},"1196cc29dea74",["102","103","104"],[],{"type":"96","properties":"105","required":"106","title":"107","$schema":"78","x-stoplight":"108"},{"id":"109","value":"110","key":"111"},"string",["110"],"http://json-schema.org/draft-07/schema#",{"id":"112"},"name","description","example","in","required","schema","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["93","113"],"object",{"Example 1":"114"},"A filter chain is the database entity representing one or more WebAssembly filters executed for each request to a particular service or route, each one with its configuration.","Filter-chains",{"id":"115","name":"116","created_at":"117","updated_at":"118","enabled":"119","route":"120","service":"121","filters":"122","tags":"123"},{"id":"124"},{"id":"125","key":"126","value":"127","summary":"128"},{"id":"129","key":"130","value":"131","summary":"132"},{"id":"133","key":"134","value":"135","summary":"136"},{"status":"137","message":"138"},["139","140"],"UnauthorizedError",{"id":"141"},"d25ede6df6294","test-service","default","0fd971c6671a5","https",{"id":"142","name":"143","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"144","filters":"145","tags":"146"},{"type":"76","description":"147","format":"148","examples":"149"},{"type":"76","description":"150","examples":"151"},{"type":"152","examples":"153"},{"type":"152","examples":"154"},{"type":"155","description":"156","default":true},{"description":"157","nullable":true},{"type":"76","description":"158","examples":"159"},{"type":"160","description":"161","items":"162"},{"type":"160","items":"163"},"befdc60dc4d76","871b1448861f6","DuplicateApiKey",{"message":"128","status":401},"Duplicate API key found","3055e8d1b1ab3","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","1cb6ebb95f261","NoAPIKey",{"message":"164","status":401},"No API key found",{"type":"152"},{"type":"76"},"status","message","470b68e5f0549","ce44eef5-41ed-47f6-baab-f725cecf98c7","my-chain","20487393-41ed-47f6-93a8-3407cade2002",["165","166"],["167"],"The unique identifier or the name attribute of the route that should be associated to the newly created filter chain.","uuid",["142"],"The name of the filter chain.\n",["143"],"integer",[1422386534],[1422386534],"boolean","Whether the filter chain is applied. Default: true.\n","The route to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. In JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.","The service to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. In JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",["144"],"array","An array of filter definitions. Each filter is an object containing a mandatory name, an optional config, and a boolean enabled setting.",{"type":"96","properties":"168"},{"type":"76"},"No API key found in request",{"name":"169","enabled":true,"config":"170"},{"name":"171","enabled":true,"config":"172"},"my-tag",{"name":"173","enabled":"174","config":"175"},"go-rate-limiting","{ \"minute\": 30 }","rust-response-transformer","{ \"remove_header\": \"X-Example\" }",{"type":"76","description":"176","examples":"177"},{"type":"155","description":"178"},{"type":"76","description":"179","examples":"180"},"The name of the filter\n",["169"],"Enable the filter","configuration filter headers",["181"],"{ \\\"minute\\\": 30 }"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-filter-chains-filter_chain_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Retrieve Filter Chain",["18"],"784913cc38ec5","get","/filter-chains/{filter_chain_id}",["19"],{},"get-filter-chains-filter_chain_id","Retrieve Filter Chain\n'401': \n $ref: '#/components/responses/HTTP401Error'\n","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"filter-chains",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33"],["34"],{"id":"35","url":"36","name":"37","description":"38","variables":"39"},"453fb3d0f8f1b","5fa7e65fc11eb","200",[],["40"],"OK",{"id":"41","name":"42","style":"43","examples":"44","description":"45","required":true,"schema":"46","explicitProperties":"47"},{"id":"48","key":"49","extensions":"50","description":"51","type":"52","name":"53","in":"54"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"55","path":"56","port":"57","protocol":"58"},{"id":"59","mediaType":"60","examples":"61","encodings":"62","schema":"63"},"f22b3969f5589","filter_chain_id","simple",[],"The unique identifier of the filter chain to retrieve.",{"type":"64","$schema":"65","x-stoplight":"66"},["67","68","69","70","71","72"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"73","description":"74"},{"default":"75","description":"76"},{"default":"77","description":"78"},{"default":"79","description":"80","enum":"81"},"ca67b9d872da1","application/json",[],[],{"type":"82","x-examples":"83","description":"84","title":"85","properties":"86","$schema":"65","x-stoplight":"87"},"string","http://json-schema.org/draft-07/schema#",{"id":"88"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["79","89"],"object",{"Example 1":"90"},"A filter chain is the database entity representing one or more WebAssembly filters executed for each request to a particular service or route, each one with its configuration.","Filter-chains",{"id":"91","name":"92","created_at":"93","updated_at":"94","enabled":"95","route":"96","service":"97","filters":"98","tags":"99"},{"id":"100"},"0f1b99d7e5937","https",{"id":"101","name":"102","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"103","filters":"104","tags":"105"},{"type":"64","description":"106","format":"107","examples":"108"},{"type":"64","description":"109","examples":"110"},{"type":"111","examples":"112"},{"type":"111","examples":"113"},{"type":"114","description":"115","default":true},{"description":"116","nullable":true},{"type":"64","description":"117","examples":"118"},{"type":"119","description":"120","items":"121"},{"type":"119","items":"122"},"befdc60dc4d76","ce44eef5-41ed-47f6-baab-f725cecf98c7","my-chain","20487393-41ed-47f6-93a8-3407cade2002",["123","124"],["125"],"The unique identifier or the name attribute of the route that should be associated to the newly created filter chain.","uuid",["101"],"The name of the filter chain.\n",["102"],"integer",[1422386534],[1422386534],"boolean","Whether the filter chain is applied. Default: true.\n","The route to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. In JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.","The service to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. In JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",["103"],"array","An array of filter definitions. Each filter is an object containing a mandatory name, an optional config, and a boolean enabled setting.",{"type":"82","properties":"126"},{"type":"64"},{"name":"127","enabled":true,"config":"128"},{"name":"129","enabled":true,"config":"130"},"my-tag",{"name":"131","enabled":"132","config":"133"},"go-rate-limiting","{ \"minute\": 30 }","rust-response-transformer","{ \"remove_header\": \"X-Example\" }",{"type":"64","description":"134","examples":"135"},{"type":"114","description":"136"},{"type":"64","description":"137","examples":"138"},"The name of the filter\n",["127"],"Enable the filter","configuration filter headers",["139"],"{ \\\"minute\\\": 30 }"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/patch-filter-chains-filter_chain_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update Filter Chain",["18"],"a2082e84eedbe","patch","/filter-chains/{filter_chain_id}",["19"],{},"patch-filter-chains-filter_chain_id","Update Filter Chain\nNote: This API is not available in DB-less mode.\n","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"filter-chains",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],["43"],["44"],{"id":"45","url":"46","name":"47","description":"48","variables":"49"},"453fb3d0f8f1b","b823033de537e","201",[],["50"],"Created","7d8303e66ed25","401",[],["51"],"Unauthorized","e93e7fedca6cc",["52"],"A filter chain is the database entity representing one or more WebAssembly filters executed for each request to a particular service or route, each one with its configuration.",{"id":"53","name":"54","style":"55","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","key":"61","extensions":"62","description":"63","type":"64","name":"65","in":"66"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"67","path":"68","port":"69","protocol":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},{"id":"76","mediaType":"72","examples":"77","encodings":"78","schema":"79"},{"id":"80","mediaType":"72","examples":"81","encodings":"82","schema":"83"},"8e006303738fd","filter_chain_id","simple",[],"The unique identifier of the filter chain to retrieve.",{"type":"84","$schema":"85","x-stoplight":"86"},["87","88","89","90","91","92"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98"},{"default":"99","description":"100","enum":"101"},"0c3f98b920596","application/json",[],[],{"type":"102","x-examples":"103","description":"42","title":"104","properties":"105","$schema":"85","x-stoplight":"106"},"bc95fb440454d",["107","108","109"],[],{"type":"102","properties":"110","required":"111","title":"112","$schema":"85","x-stoplight":"113"},"f0753a7791d39",["114"],[],{"type":"102","x-examples":"115","properties":"116","$schema":"85","x-stoplight":"117"},"string","http://json-schema.org/draft-07/schema#",{"id":"118"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["99","119"],"object",{"Example 1":"120"},"Filter-chains",{"id":"121","name":"122","created_at":"123","updated_at":"124","enabled":"125","route":"126","service":"127","filters":"128","tags":"129"},{"id":"130"},{"id":"131","key":"132","value":"133","summary":"134"},{"id":"135","key":"136","value":"137","summary":"138"},{"id":"139","key":"140","value":"141","summary":"142"},{"status":"143","message":"144"},["145","146"],"UnauthorizedError",{"id":"147"},{"id":"148","key":"149","value":"150"},{"Example 1":"151"},{" name":"152","enabled":"153","route":"154","service":"155","filters":"156","tags":"157"},{"id":"158"},"5e0e367cf21c7","https",{"id":"159","name":"160","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"161","filters":"162","tags":"163"},{"type":"84","description":"164","format":"165","examples":"166"},{"type":"84","description":"167","examples":"168"},{"type":"169","examples":"170"},{"type":"169","examples":"171"},{"type":"172","description":"173","default":true},{"description":"174","nullable":true},{"type":"84","description":"175","examples":"176"},{"type":"177","description":"178","items":"179"},{"type":"177","items":"180"},"befdc60dc4d76","f5b058ed2a454","DuplicateApiKey",{"message":"134","status":401},"Duplicate API key found","7e01f83944132","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","161b4a213eb62","NoAPIKey",{"message":"181","status":401},"No API key found",{"type":"169"},{"type":"84"},"status","message","470b68e5f0549","158cb0894cd25","Example 1",{" name":"160","enabled":"84","route":"84","service":"161","filters":"84","tags":"84"},{"id":"159","name":"160","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"161","filters":"182","tags":"183"},{"type":"84","description":"167","examples":"184"},{"type":"84","description":"173"},{"type":"84","description":"185"},{"type":"84","description":"186","examples":"187"},{"type":"84","description":"178"},{"type":"84","description":"188"},"bc09fa8927983","ce44eef5-41ed-47f6-baab-f725cecf98c7","my-chain","20487393-41ed-47f6-93a8-3407cade2002",["189","190"],["191"],"The unique identifier or the name attribute of the route that should be associated to the newly created filter chain.","uuid",["159"],"The name of the filter chain.\n",["160"],"integer",[1422386534],[1422386534],"boolean","Whether the filter chain is applied. Default: true.\n","The route to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. In JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.","The service to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. In JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",["161"],"array","An array of filter definitions. Each filter is an object containing a mandatory name, an optional config, and a boolean enabled setting.",{"type":"102","properties":"192"},{"type":"84"},"No API key found in request",["193","194"],["191"],["160"],"The route to which this chain is applied. \nA filter chain must be applied to either a single route or a single service. \nDefault: `null`. \n\nIn form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. \nIn JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.\n","The service to which this chain is applied. \nA filter chain must be applied to either a single route or a single service. Default: `null`. \n\nIn form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. \nIn JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.\n",["161"],"An optional set of strings associated with the filter chain for grouping and filtering.\n",{"name":"195","enabled":true,"config":"196"},{"name":"197","enabled":true,"config":"198"},"my-tag",{"name":"199","enabled":"200","config":"201"},{"name":"195","enabled":true,"config":"196"},{"name":"197","enabled":true,"config":"198"},"go-rate-limiting","{ \"minute\": 30 }","rust-response-transformer","{ \"remove_header\": \"X-Example\" }",{"type":"84","description":"202","examples":"203"},{"type":"172","description":"204"},{"type":"84","description":"205","examples":"206"},"The name of the filter\n",["195"],"Enable the filter","configuration filter headers",["207"],"{ \\\"minute\\\": 30 }"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/put-filter-chains-filter_chain_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Update Or Create Filter Chain",["18"],"af3e48d908f1c","put","/filter-chains/{filter_chain_id}",["19"],{},"put-filter-chains-filter_chain_id","Inserts (or replaces) the filter chain under the requested resource with the definition specified in the body. The filter chain is identified via the name or ID attribute.\n\nWhen the name or ID attribute has the structure of a UUID, the filter chain being inserted or replaced is identified by its ID. Otherwise, it is identified by its name.\n\nWhen creating a new filter chain without specifying an ID (neither in the URL nor in the body), the ID will be auto-generated.\n\nNotice that specifying a name in the URL and a different one in the request body is not allowed.","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"filter-chains",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],["43"],["44"],{"id":"45","url":"46","name":"47","description":"48","variables":"49"},"453fb3d0f8f1b","1c63123402ff9","200",[],[],"OK","bc331057324b5","401",[],["50"],"Unauthorized","da895cc7ea4c8",["51"],"A filter chain is the database entity representing one or more WebAssembly filters executed for each request to a particular service or route, each one with its configuration.",{"id":"52","name":"53","style":"54","examples":"55","description":"56","required":true,"schema":"57","explicitProperties":"58"},{"id":"59","key":"60","extensions":"61","description":"62","type":"63","name":"64","in":"65"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"66","path":"67","port":"68","protocol":"69"},{"id":"70","mediaType":"71","examples":"72","encodings":"73","schema":"74"},{"id":"75","mediaType":"71","examples":"76","encodings":"77","schema":"78"},"4d928f85332b6","filter_chain_id","simple",[],"The unique identifier of the filter chain to retrieve.",{"type":"79","$schema":"80","x-stoplight":"81"},["82","83","84","85","86","87"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95","enum":"96"},"e60ecca04e26c","application/json",["97","98","99"],[],{"type":"100","properties":"101","required":"102","title":"103","$schema":"80","x-stoplight":"104"},"fce5152e7041a",["105"],[],{"type":"100","x-examples":"106","properties":"107","$schema":"80","x-stoplight":"108"},"string","http://json-schema.org/draft-07/schema#",{"id":"109"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["94","110"],{"id":"111","key":"112","value":"113","summary":"114"},{"id":"115","key":"116","value":"117","summary":"118"},{"id":"119","key":"120","value":"121","summary":"122"},"object",{"status":"123","message":"124"},["125","126"],"UnauthorizedError",{"id":"127"},{"id":"128","key":"129","value":"130"},{"Example 1":"131"},{" name":"132","enabled":"133","route":"134","service":"135","filters":"136","tags":"137"},{"id":"138"},"b197b5f2a729c","https","bae97b556b229","DuplicateApiKey",{"message":"114","status":401},"Duplicate API key found","892ce4c59d42c","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","d271f7d40c854","NoAPIKey",{"message":"139","status":401},"No API key found",{"type":"140"},{"type":"79"},"status","message","470b68e5f0549","5921f8e9b4b30","Example 1",{" name":"141","enabled":"79","route":"79","service":"142","filters":"79","tags":"79"},{"id":"143","name":"141","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"142","filters":"144","tags":"145"},{"type":"79","description":"146","examples":"147"},{"type":"79","description":"148"},{"type":"79","description":"149"},{"type":"79","description":"150","examples":"151"},{"type":"79","description":"152"},{"type":"79","description":"153"},"bc09fa8927983","No API key found in request","integer","my-chain","20487393-41ed-47f6-93a8-3407cade2002","ce44eef5-41ed-47f6-baab-f725cecf98c7",["154","155"],["156"],"The name of the filter chain.\n",["141"],"Whether the filter chain is applied. Default: true.\n","The route to which this chain is applied. \nA filter chain must be applied to either a single route or a single service. \nDefault: `null`. \n\nIn form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. \nIn JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.\n","The service to which this chain is applied. \nA filter chain must be applied to either a single route or a single service. Default: `null`. \n\nIn form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. \nIn JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.\n",["142"],"An array of filter definitions. Each filter is an object containing a mandatory name, an optional config, and a boolean enabled setting.","An optional set of strings associated with the filter chain for grouping and filtering.\n",{"name":"157","enabled":true,"config":"158"},{"name":"159","enabled":true,"config":"160"},"my-tag","go-rate-limiting","{ \"minute\": 30 }","rust-response-transformer","{ \"remove_header\": \"X-Example\" }"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-filter-chains-filter_chain_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete Filter Chain",["18"],"e5d5eb3efd9c2","delete","/filter-chains/{filter_chain_id}",["19"],{},"delete-filter-chains-filter_chain_id","Delete filter chain.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"filter-chains",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"453fb3d0f8f1b","491ec01364a38","204",[],[],"No Content","e92ebe369462a","401",[],["46"],"Unauthorized",{"id":"47","name":"48","style":"49","examples":"50","description":"51","required":true,"schema":"52","explicitProperties":"53"},{"id":"54","key":"55","extensions":"56","description":"57","type":"58","name":"59","in":"60"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"61","path":"62","port":"63","protocol":"64"},{"id":"65","mediaType":"66","examples":"67","encodings":"68","schema":"69"},"a3ba3d7b31ebe","filter_chain_id","simple",[],"The unique identifier of the filter chain to retrieve.",{"type":"70","$schema":"71","x-stoplight":"72"},["73","74","75","76","77","78"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"79","description":"80"},{"default":"81","description":"82"},{"default":"83","description":"84"},{"default":"85","description":"86","enum":"87"},"c60aef27b0ee4","application/json",["88","89","90"],[],{"type":"91","properties":"92","required":"93","title":"94","$schema":"71","x-stoplight":"95"},"string","http://json-schema.org/draft-07/schema#",{"id":"96"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["85","97"],{"id":"98","key":"99","value":"100","summary":"101"},{"id":"102","key":"103","value":"104","summary":"105"},{"id":"106","key":"107","value":"108","summary":"109"},"object",{"status":"110","message":"111"},["112","113"],"UnauthorizedError",{"id":"114"},"c3936de3b0207","https","d0375eb9f1a15","DuplicateApiKey",{"message":"101","status":401},"Duplicate API key found","f777d3c813c19","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","bf99bc55a9c17","NoAPIKey",{"message":"115","status":401},"No API key found",{"type":"116"},{"type":"70"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-routes-route_id_or_name-filter-chains-filter_chain_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List Filter Chains Associated to a Specific Route",["18"],"964ea4b4894c9","get","/routes/{route_id_or_name}/filter-chains/{filter_chain_id}",["19"],{},"get-routes-route_id_or_name-filter-chains-filter_chain_id","Retrieve filter chain associated to a specific route.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"filter-chains",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"453fb3d0f8f1b","09cbf46f90698","200",[],["47"],"OK","69dbf64c60533","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","required":true,"schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","required":true,"schema":"60","explicitProperties":"61"},{"id":"62","key":"63","extensions":"64","description":"65","type":"66","name":"67","in":"68"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"69","path":"70","port":"71","protocol":"72"},{"id":"73","mediaType":"74","examples":"75","encodings":"76","schema":"77"},{"id":"78","mediaType":"74","examples":"79","encodings":"80","schema":"81"},"93b727b55a00d","route_id_or_name","simple",[],"The unique identifier or the name of the route to retrieve.",{"type":"82","examples":"83","$schema":"84","x-stoplight":"85"},["86","87","88","89","90","91"],"0ab37bb1fb91d","filter_chain_id",[],"The unique identifier of the filter chain to retrieve.",{"type":"82","$schema":"84","x-stoplight":"92"},["86","87","88","89","90","91"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98"},{"default":"99","description":"100","enum":"101"},"a70024cbe9863","application/json",[],[],{"type":"102","x-examples":"103","description":"104","title":"105","properties":"106","$schema":"84","x-stoplight":"107"},"ee4b735e42681",["108","109","110"],[],{"type":"102","properties":"111","required":"112","title":"113","$schema":"84","x-stoplight":"114"},"string",["115"],"http://json-schema.org/draft-07/schema#",{"id":"116"},"name","in","required","schema","description","title",{"id":"117"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["99","118"],"object",{"Example 1":"119"},"A filter chain is the database entity representing one or more WebAssembly filters executed for each request to a particular service or route, each one with its configuration.","Filter-chains",{"id":"120","name":"121","created_at":"122","updated_at":"123","enabled":"124","route":"125","service":"126","filters":"127","tags":"128"},{"id":"129"},{"id":"130","key":"131","value":"132","summary":"133"},{"id":"134","key":"135","value":"136","summary":"137"},{"id":"138","key":"139","value":"140","summary":"141"},{"status":"142","message":"143"},["144","145"],"UnauthorizedError",{"id":"146"},"my-route","e1d89b4da1841","af742c15475b5","https",{"id":"147","name":"148","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"149","filters":"150","tags":"151"},{"type":"82","description":"152","format":"153","examples":"154"},{"type":"82","description":"155","examples":"156"},{"type":"157","examples":"158"},{"type":"157","examples":"159"},{"type":"160","description":"161","default":true},{"description":"162","nullable":true},{"type":"82","description":"163","examples":"164"},{"type":"165","description":"166","items":"167"},{"type":"165","items":"168"},"befdc60dc4d76","93efd2ed3dfde","DuplicateApiKey",{"message":"133","status":401},"Duplicate API key found","6f961d34bf7ff","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","15b0b781c5a5c","NoAPIKey",{"message":"169","status":401},"No API key found",{"type":"157"},{"type":"82"},"status","message","470b68e5f0549","ce44eef5-41ed-47f6-baab-f725cecf98c7","my-chain","20487393-41ed-47f6-93a8-3407cade2002",["170","171"],["172"],"The unique identifier or the name attribute of the route that should be associated to the newly created filter chain.","uuid",["147"],"The name of the filter chain.\n",["148"],"integer",[1422386534],[1422386534],"boolean","Whether the filter chain is applied. Default: true.\n","The route to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. In JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.","The service to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. In JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.",["149"],"array","An array of filter definitions. Each filter is an object containing a mandatory name, an optional config, and a boolean enabled setting.",{"type":"102","properties":"173"},{"type":"82"},"No API key found in request",{"name":"174","enabled":true,"config":"175"},{"name":"176","enabled":true,"config":"177"},"my-tag",{"name":"178","enabled":"179","config":"180"},"go-rate-limiting","{ \"minute\": 30 }","rust-response-transformer","{ \"remove_header\": \"X-Example\" }",{"type":"82","description":"181","examples":"182"},{"type":"160","description":"183"},{"type":"82","description":"184","examples":"185"},"The name of the filter\n",["174"],"Enable the filter","configuration filter headers",["186"],"{ \\\"minute\\\": 30 }"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/put-routes-route_id_or_name-filter-chains-filter_chain_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Create Or Update Filter Chain Associated to a Specific Route",["18"],"71b7a8a53f945","put","/routes/{route_id_or_name}/filter-chains/{filter_chain_id}",["19"],{},"put-routes-route_id_or_name-filter-chains-filter_chain_id","Create or update filter chain associated to a specific route.\n","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"filter-chains",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],["43","44"],["45"],{"id":"46","url":"47","name":"48","description":"49","variables":"50"},"453fb3d0f8f1b","613fa6072b50d","200",[],[],"OK","b96fa7e3edee6","401",[],["51"],"Unauthorized","e8bbb900bcb2b",["52"],"A filter chain is the database entity representing one or more WebAssembly filters executed for each request to a particular service or route, each one with its configuration.",{"id":"53","name":"54","style":"55","examples":"56","description":"57","required":true,"schema":"58","explicitProperties":"59"},{"id":"60","name":"61","style":"55","examples":"62","description":"63","required":true,"schema":"64","explicitProperties":"65"},{"id":"66","key":"67","extensions":"68","description":"69","type":"70","name":"71","in":"72"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"73","path":"74","port":"75","protocol":"76"},{"id":"77","mediaType":"78","examples":"79","encodings":"80","schema":"81"},{"id":"82","mediaType":"78","examples":"83","encodings":"84","schema":"85"},"f0a34d76c0485","route_id_or_name","simple",[],"The unique identifier or the name of the route to retrieve.",{"type":"86","examples":"87","$schema":"88","x-stoplight":"89"},["90","91","92","93","94","95"],"ec265a1a5a26d","filter_chain_id",[],"The unique identifier of the filter chain to retrieve.",{"type":"86","$schema":"88","x-stoplight":"96"},["90","91","92","93","94","95"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"97","description":"98"},{"default":"99","description":"100"},{"default":"101","description":"102"},{"default":"103","description":"104","enum":"105"},"0cf9c15606e3e","application/json",["106","107","108"],[],{"type":"109","properties":"110","required":"111","title":"112","$schema":"88","x-stoplight":"113"},"389d86225c71e",["114"],[],{"type":"109","x-examples":"115","properties":"116","$schema":"88","x-stoplight":"117"},"string",["118"],"http://json-schema.org/draft-07/schema#",{"id":"119"},"name","in","required","schema","description","title",{"id":"120"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["103","121"],{"id":"122","key":"123","value":"124","summary":"125"},{"id":"126","key":"127","value":"128","summary":"129"},{"id":"130","key":"131","value":"132","summary":"133"},"object",{"status":"134","message":"135"},["136","137"],"UnauthorizedError",{"id":"138"},{"id":"139","key":"140","value":"141"},{"Example 1":"142"},{" name":"143","enabled":"144","route":"145","service":"146","filters":"147","tags":"148"},{"id":"149"},"my-route","afa87328380d3","9e515676159d0","https","f9fb5e4daee60","DuplicateApiKey",{"message":"125","status":401},"Duplicate API key found","903d10b61c24a","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","d7a8f212a22bc","NoAPIKey",{"message":"150","status":401},"No API key found",{"type":"151"},{"type":"86"},"status","message","470b68e5f0549","b101f05b7001d","Example 1",{" name":"152","enabled":"86","route":"86","service":"153","filters":"86","tags":"86"},{"id":"154","name":"152","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"153","filters":"155","tags":"156"},{"type":"86","description":"157","examples":"158"},{"type":"86","description":"159"},{"type":"86","description":"160"},{"type":"86","description":"161","examples":"162"},{"type":"86","description":"163"},{"type":"86","description":"164"},"bc09fa8927983","No API key found in request","integer","my-chain","20487393-41ed-47f6-93a8-3407cade2002","ce44eef5-41ed-47f6-baab-f725cecf98c7",["165","166"],["167"],"The name of the filter chain.\n",["152"],"Whether the filter chain is applied. Default: true.\n","The route to which this chain is applied. \nA filter chain must be applied to either a single route or a single service. \nDefault: `null`. \n\nIn form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. \nIn JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.\n","The service to which this chain is applied. \nA filter chain must be applied to either a single route or a single service. Default: `null`. \n\nIn form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. \nIn JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.\n",["153"],"An array of filter definitions. Each filter is an object containing a mandatory name, an optional config, and a boolean enabled setting.","An optional set of strings associated with the filter chain for grouping and filtering.\n",{"name":"168","enabled":true,"config":"169"},{"name":"170","enabled":true,"config":"171"},"my-tag","go-rate-limiting","{ \"minute\": 30 }","rust-response-transformer","{ \"remove_header\": \"X-Example\" }"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-routes-route_id_or_name-filter_chain_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete Filter Chain Associated to a Specific Route",["18"],"17047843b64c6","delete","/routes/{route_id_or_name}/{filter_chain_id}",["19"],{},"get-routes-route_id_or_name-filter_chain_id","Delete filter chain associated to a specific route.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"filter-chains",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"453fb3d0f8f1b","ef8100637b5b5","204",[],[],"No Content","5a70ffd20cf87","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"50","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},"23bdefc683100","filter_chain_id","simple",[],"The unique identifier of the filter chain to retrieve.",{"type":"77","$schema":"78","x-stoplight":"79"},["80","81","82","83","84","85"],"62317348c4e1a","route_id_or_name",[],"The unique identifier or the name of the route to retrieve.",{"type":"77","examples":"86","$schema":"78","x-stoplight":"87"},["80","81","82","83","84","85"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"88","description":"89"},{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95","enum":"96"},"8d4defc508d91","application/json",["97","98","99"],[],{"type":"100","properties":"101","required":"102","title":"103","$schema":"78","x-stoplight":"104"},"string","http://json-schema.org/draft-07/schema#",{"id":"105"},"name","in","required","schema","description","title",["106"],{"id":"107"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["94","108"],{"id":"109","key":"110","value":"111","summary":"112"},{"id":"113","key":"114","value":"115","summary":"116"},{"id":"117","key":"118","value":"119","summary":"120"},"object",{"status":"121","message":"122"},["123","124"],"UnauthorizedError",{"id":"125"},"bd1b7a9236ad2","my-route","f7600d89d6a04","https","44598d691ee61","DuplicateApiKey",{"message":"112","status":401},"Duplicate API key found","bebb07d030c99","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","039370ff64ec5","NoAPIKey",{"message":"126","status":401},"No API key found",{"type":"127"},{"type":"77"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/delete-services-service_id_or_name-filter-chains-filter_chain_id",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete Filter Chain Associated to a Specific Service",["18"],"0313c59c82a24","delete","/services/{service_id_or_name}/filter-chains/{filter_chain_id}",["19"],{},"delete-services-service_id_or_name-filter-chains-filter_chain_id","Delete filter chain associated to a specific service.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"filter-chains",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39","40"],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"453fb3d0f8f1b","099a700d7e13c","204",[],[],"No Content","616a71ea40e0b","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","name":"56","style":"50","examples":"57","description":"58","required":true,"schema":"59","explicitProperties":"60"},{"id":"61","key":"62","extensions":"63","description":"64","type":"65","name":"66","in":"67"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"68","path":"69","port":"70","protocol":"71"},{"id":"72","mediaType":"73","examples":"74","encodings":"75","schema":"76"},"1a45e6a24662c","service_id_or_name","simple",["77"],"ID **or** name of the service to lookup",{"type":"78","examples":"79","$schema":"80","x-stoplight":"81"},["82","83","84","85","86","87","88"],"8a27e079bcb49","filter_chain_id",[],"The unique identifier of the filter chain to retrieve.",{"type":"78","$schema":"80","x-stoplight":"89"},["82","85","86","87","83","88"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"90","description":"91"},{"default":"92","description":"93"},{"default":"94","description":"95"},{"default":"96","description":"97","enum":"98"},"651d3746f271b","application/json",["99","100","101"],[],{"type":"102","properties":"103","required":"104","title":"105","$schema":"80","x-stoplight":"106"},{"id":"107","value":"108","key":"109"},"string",["108"],"http://json-schema.org/draft-07/schema#",{"id":"110"},"name","description","example","in","required","schema","title",{"id":"111"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["96","112"],{"id":"113","key":"114","value":"115","summary":"116"},{"id":"117","key":"118","value":"119","summary":"120"},{"id":"121","key":"122","value":"123","summary":"124"},"object",{"status":"125","message":"126"},["127","128"],"UnauthorizedError",{"id":"129"},"f142b891d7532","test-service","default","db49a0cbf7f11","d3e753876d995","https","e071e0b41aa33","DuplicateApiKey",{"message":"116","status":401},"Duplicate API key found","bfc2706fc5a52","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","8715937d1002f","NoAPIKey",{"message":"130","status":401},"No API key found",{"type":"131"},{"type":"78"},"status","message","470b68e5f0549","No API key found in request","integer"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-audit-requests",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List request audit logs",["18"],"26c807070a2c4","get","/audit/requests",["19"],{},"get-audit-requests","You can access request and database audit logs through the Admin API.\nThe default order of audit log is by request timestamp - latest to oldest.\nFor usage examples, see [Audit Logging in Kong Gateway](https://docs.konghq.com/gateway/latest/kong-enterprise/audit-log/).","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"audit-logs",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40"],[],[],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"7e0109d393728","581ea7de54467","200",[],["47"],"Example response generated for checking the `/status` endpoint without RBAC enabled.","258ea886eb9eb","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","required":false,"schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","required":false,"schema":"60","explicitProperties":"61"},{"id":"62","key":"63","extensions":"64","description":"65","type":"66","name":"67","in":"68"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"69","path":"70","port":"71","protocol":"72"},{"id":"73","mediaType":"74","examples":"75","encodings":"76","schema":"77"},{"id":"78","mediaType":"74","examples":"79","encodings":"80","schema":"81"},"6f8d7772bdca2","before_audit_log_filter","form",[],"Before filter could be used to request audit log data that was recorded before certain time (exclusive).\nIt can either be a timestamp as Unix Epoch or a string following RFC3339 Schema (without fractions of a second) - ex: '2024-04-25T15:03:24Z'\n",{"oneOf":"82","title":"83","$schema":"84","x-stoplight":"85"},["86","87","88","89","90","91"],"d2772aa607c9a","after_audit_log_filter",[],"After filter could be used to request audit log data that was recorded after certain time (inclusive).\nIt can either be a timestamp as Unix Epoch or a string following RFC3339 Schema (without fractions of a second) - ex: '2024-04-25T15:03:24Z'\n",{"oneOf":"92","title":"83","$schema":"84","x-stoplight":"93"},["86","87","88","89","90","91"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"94","description":"95"},{"default":"96","description":"97"},{"default":"98","description":"99"},{"default":"100","description":"101","enum":"102"},"9312ed3b5ec9a","application/json",[],[],{"type":"103","x-examples":"104","properties":"105","$schema":"84","x-stoplight":"106"},"863a1e1d7dd4a",["107","108","109"],[],{"type":"103","properties":"110","required":"111","title":"112","$schema":"84","x-stoplight":"113"},["114","115"],"RequestTimestampFilterSchema","http://json-schema.org/draft-07/schema#",{"id":"116"},"name","in","required","schema","description","title",["114","115"],{"id":"117"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["100","118"],"object",{"Example 1":"119"},{"data":"120","total":"121"},{"id":"122"},{"id":"123","key":"124","value":"125","summary":"126"},{"id":"127","key":"128","value":"129","summary":"130"},{"id":"131","key":"132","value":"133","summary":"134"},{"status":"135","message":"136"},["137","138"],"UnauthorizedError",{"id":"139"},{"type":"140","pattern":"141"},{"type":"142"},"3a18350405bfc","d158aa01f29e4","https",{"data":"143","total":1},{"type":"144","description":"145","items":"146"},{"type":"142"},"0327efb200185","757ab115c85a3","DuplicateApiKey",{"message":"126","status":401},"Duplicate API key found","f577e7446c52d","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","f149b305b5633","NoAPIKey",{"message":"147","status":401},"No API key found",{"type":"142"},{"type":"140"},"status","message","470b68e5f0549","string","^(\\d+|\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z)$","integer",["148"],"array","The client IP address",{"type":"103","properties":"149"},"No API key found in request",{"client_ip":"150","method":"151","path":"152","payload":null,"rbac_user_id":null,"rbac_user_name":null,"removed_from_payload":null,"request_id":"153","request_source":null,"request_timestamp":1676424547,"signature":null,"status":200,"ttl":2591997,"workspace":"154"},{"client_ip":"155","method":"156","path":"157","payload":"158","rbac_user_id":"159","rbac_user_name":"160","removed_from_payload":"161","request_id":"162","request_source":"163","request_timestamp":"164","signature":"165","status":"166","ttl":"167","workspace":"168"},"127.0.0.1","GET","/status","OjOcUBvt6q6XJlX3dd6BSpy1uUkTyctC","1065b6d6-219f-4002-b3e9-334fc3eff46c",{"type":"140","description":"145"},{"type":"140","description":"169"},{"type":"140","description":"170"},{"nullable":true},{"nullable":true},{"nullable":true},{"nullable":true},{"type":"140"},{"nullable":true},{"type":"142"},{"nullable":true},{"type":"142"},{"type":"142"},{"type":"140"},"The HTTP method","The path of the endpoint"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-audit-objects",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List database audit logs",["18"],"f49df246d0338","get","/audit/objects",["19"],{},"get-audit-objects","List database audit logs (ordered by request timestamp - latest to oldest)","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"audit-logs",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],["39","40"],[],[],["41"],{"id":"42","url":"43","name":"44","description":"45","variables":"46"},"7e0109d393728","184f17c0b5a02","200",[],["47"],"Example response for a consumer creation log entry","adbf1852258a4","401",[],["48"],"Unauthorized",{"id":"49","name":"50","style":"51","examples":"52","description":"53","required":false,"schema":"54","explicitProperties":"55"},{"id":"56","name":"57","style":"51","examples":"58","description":"59","required":false,"schema":"60","explicitProperties":"61"},{"id":"62","key":"63","extensions":"64","description":"65","type":"66","name":"67","in":"68"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"69","path":"70","port":"71","protocol":"72"},{"id":"73","mediaType":"74","examples":"75","encodings":"76","schema":"77"},{"id":"78","mediaType":"74","examples":"79","encodings":"80","schema":"81"},"fdbbc719a6260","before_audit_log_filter","form",[],"Before filter could be used to request audit log data that was recorded before certain time (exclusive).\nIt can either be a timestamp as Unix Epoch or a string following RFC3339 Schema (without fractions of a second) - ex: '2024-04-25T15:03:24Z'\n",{"oneOf":"82","title":"83","$schema":"84","x-stoplight":"85"},["86","87","88","89","90","91"],"a2f87540e6e33","after_audit_log_filter",[],"After filter could be used to request audit log data that was recorded after certain time (inclusive).\nIt can either be a timestamp as Unix Epoch or a string following RFC3339 Schema (without fractions of a second) - ex: '2024-04-25T15:03:24Z'\n",{"oneOf":"92","title":"83","$schema":"84","x-stoplight":"93"},["86","87","88","89","90","91"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"94","description":"95"},{"default":"96","description":"97"},{"default":"98","description":"99"},{"default":"100","description":"101","enum":"102"},"404612d4051e0","application/json",[],[],{"properties":"103","$schema":"84","x-stoplight":"104"},"73019c2e785c8",["105","106","107"],[],{"type":"108","properties":"109","required":"110","title":"111","$schema":"84","x-stoplight":"112"},["113","114"],"RequestTimestampFilterSchema","http://json-schema.org/draft-07/schema#",{"id":"115"},"name","in","required","schema","description","title",["113","114"],{"id":"116"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["100","117"],{"id":"118"},{"id":"119"},{"id":"120","key":"121","value":"122","summary":"123"},{"id":"124","key":"125","value":"126","summary":"127"},{"id":"128","key":"129","value":"130","summary":"131"},"object",{"status":"132","message":"133"},["134","135"],"UnauthorizedError",{"id":"136"},{"type":"137","pattern":"138"},{"type":"139"},"48a756dc089e9","d24304464b314","https",{"type":"137"},"b68e30bcb2ef5","08440727db91d","DuplicateApiKey",{"message":"123","status":401},"Duplicate API key found","29044213bbf73","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","802d4e44a1915","NoAPIKey",{"message":"140","status":401},"No API key found",{"type":"139"},{"type":"137"},"status","message","470b68e5f0549","string","^(\\d+|\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z)$","integer","No API key found in request"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-event-hooks",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all event hooks",["18"],"53ff9b16c7101","get","/event-hooks",["19"],{},"get-event-hooks","List all event hooks and return information about the event hooks.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Event-hooks",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"4d46b836009dc","d805d66eda174","200",[],["45"],"Example event hooks response","7fd5d49217abb","401",[],["46"],"Unauthorized",{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},{"id":"63","mediaType":"59","examples":"64","encodings":"65","schema":"66"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"0d17296e82566","application/json",["76"],[],{"type":"77","properties":"78","x-examples":"79","$schema":"80","x-stoplight":"81"},"901ee783c26ea",["82","83","84"],[],{"type":"77","properties":"85","required":"86","title":"87","$schema":"80","x-stoplight":"88"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","89"],{"id":"90","key":"33","value":"91"},"object",{"data":"92","next":"93"},{"Example 1":"94"},"http://json-schema.org/draft-07/schema#",{"id":"95"},{"id":"96","key":"97","value":"98","summary":"99"},{"id":"100","key":"101","value":"102","summary":"103"},{"id":"104","key":"105","value":"106","summary":"107"},{"status":"108","message":"109"},["110","111"],"UnauthorizedError",{"id":"112"},"https","6d170ec9abf98",{"data":"113","next":"114"},{"type":"115","items":"116"},{"type":"117"},{"data":"118","next":null},"a25679ec80462","a0d2068f2bc10","DuplicateApiKey",{"message":"99","status":401},"Duplicate API key found","83f01c4335684","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","230ba932f4c61","NoAPIKey",{"message":"119","status":401},"No API key found",{"type":"120"},{"type":"117"},"status","message","470b68e5f0549",["121"],"null","array",{"type":"77","properties":"122"},"string",["123","124","125"],"No API key found in request","integer",{"config":"126","created_at":0,"event":"117","handler":"117","id":"117","on_change":"117","snooze":0,"source":"117"},{"config":"127","created_at":"128","event":"129","handler":"130","id":"131","on_change":"132","snooze":"133","source":"134"},{"config":"135","created_at":1627588552,"event":"136","handler":"137","id":"138","on_change":null,"snooze":null,"source":"139"},{"config":"140","created_at":1627581575,"event":"141","handler":"142","id":"143","on_change":null,"snooze":null,"source":"139"},{"config":"144","created_at":1627595513,"event":"141","handler":"145","id":"146","on_change":null,"snooze":null,"source":"139"},{"body":"114","body_format":true,"headers":"147","headers_format":true,"method":"117","payload":"148","payload_format":true,"secret":"114","ssl_verify":true,"url":"117","functions":"149"},{"type":"77","properties":"150"},{"type":"120"},{"type":"117"},{"type":"117"},{"type":"117"},{"type":"117"},{"type":"120"},{"type":"117"},{"body":null,"body_format":true,"headers":"151","headers_format":false,"method":"152","payload":"153","payload_format":true,"secret":null,"ssl_verify":false,"url":"154"},"admins","webhook-custom","937df175-3db2-4e6d-8aa1-d95c94a76089","crud",{"headers":"155","secret":null,"ssl_verify":false,"url":"156"},"consumers","webhook","c57340ab-9fed-40fd-bb7e-1cef8d37c2df",{"functions":"157"},"lambda","c9fdd58d-5416-4d3a-9467-51e5cfe4ca0e",{"content-type":"117"},{"text":"117"},["117"],{"body":"158","body_format":"159","headers":"160","headers_format":"161","method":"162","payload":"163","payload_format":"164","secret":"165","ssl_verify":"166","url":"167","functions":"168"},{"content-type":"59"},"POST",{"text":"169"},"https://hooks.slack.com/services/foo/bar/baz",{},"https://webhook.site/a1b2c3-d4e5-g6h7-i8j9-k1l2m3n4o5p6",["170"],{"type":"117"},{"type":"171"},{"type":"77","properties":"172"},{"type":"171"},{"type":"117"},{"type":"77","properties":"173"},{"type":"171"},{"type":"117"},{"type":"171"},{"type":"117"},{"type":"115","items":"174"},"payload_text","return function (data, event, source, pid)\n local user = data.entity.username\n error(\"Event hook on consumer \" .. user .. \"\")\nend\n","boolean",{"content-type":"175"},{"text":"176"},{"type":"117"},{"type":"117"},{"type":"117"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-event-hooks",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Add a webhook",["18"],"65a37543b0a30","post","/event-hooks",["19"],{},"post-event-hooks","Add a webhook\n","inheritedFromService",["20","21"],{"body":"22","headers":"23","query":"24","cookie":"25","path":"26"},["27"],["28"],"Event-hooks",{"id":"29","name":"18"},{"id":"30","code":"31","headers":"32","contents":"33","description":"34"},{"id":"35","code":"36","headers":"37","contents":"38","description":"39"},{"id":"40","contents":"41","description":"42"},[],[],[],[],["43"],{"id":"44","url":"45","name":"46","description":"47","variables":"48"},"4d46b836009dc","46e736586c2d1","200",[],["49"],"Example event hooks response","e6b7347b9c18d","401",[],["50"],"Unauthorized","11b0b69da9280",["51"],"Request body for adding a webhook",{"id":"52","key":"53","extensions":"54","description":"55","type":"56","name":"57","in":"58"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"59","path":"60","port":"61","protocol":"62"},{"id":"63","mediaType":"64","examples":"65","encodings":"66","schema":"67"},{"id":"68","mediaType":"64","examples":"69","encodings":"70","schema":"71"},{"id":"72","mediaType":"64","examples":"73","encodings":"74","schema":"75"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"76","description":"77"},{"default":"78","description":"79"},{"default":"80","description":"81"},{"default":"82","description":"83","enum":"84"},"ddbc657407a1a","application/json",["85"],[],{"type":"86","properties":"87","x-examples":"88","$schema":"89","x-stoplight":"90"},"6cfabf66b9d83",["91","92","93"],[],{"type":"86","properties":"94","required":"95","title":"96","$schema":"89","x-stoplight":"97"},"63013d8aaf6cc",["98"],[],{"type":"86","properties":"99","required":"100","$schema":"89","x-stoplight":"101"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["82","102"],{"id":"103","key":"34","value":"104"},"object",{"data":"105","next":"106"},{"Example 1":"107"},"http://json-schema.org/draft-07/schema#",{"id":"108"},{"id":"109","key":"110","value":"111","summary":"112"},{"id":"113","key":"114","value":"115","summary":"116"},{"id":"117","key":"118","value":"119","summary":"120"},{"status":"121","message":"122"},["123","124"],"UnauthorizedError",{"id":"125"},{"id":"126","key":"127","value":"128"},{"event":"129","handler":"130","source":"131","snooze":"132","on_change":"133","config.url":"134","config.headers":"135","config.secret":"136","config.ssl_verify":"137"},["138","139","140"],{"id":"141"},"https","b4ecfee32a1c5",{"data":"142","next":"143"},{"type":"144","items":"145"},{"type":"146"},{"data":"147","next":null},"a25679ec80462","f7aa7844075ce","DuplicateApiKey",{"message":"112","status":401},"Duplicate API key found","8dec2aac75524","InvalidAuthCred",{"message":"39","status":401},"Invalid authentication credentials","eedaaf8234ce2","NoAPIKey",{"message":"148","status":401},"No API key found",{"type":"149"},{"type":"146"},"status","message","470b68e5f0549","e564464c46365","Example 2",{"event":"150","handler":"151","source":"152","snooze":0,"on_change":true,"config.url":"153","config.headers":"154","config.secret":"146","config.ssl_verify":"146"},{"type":"146","description":"155","examples":"156"},{"type":"146","description":"157","examples":"158"},{"type":"146","description":"159","examples":"160"},{"type":"149","description":"161","default":0,"examples":"162"},{"type":"163","description":"164"},{"type":"146","description":"165","examples":"166"},{"type":"86","description":"167","properties":"168"},{"type":"146","description":"169"},{"type":"146","description":"170"},"handler","source","config.url","177ab74a9d553",["171"],"null","array",{"type":"86","properties":"172"},"string",["173","174","175"],"No API key found in request","integer","consumers","webhook","crud","https://webhook.site/a1b2c3-d4e5-g6h7-i8j9-k1l2m3n4o5p6",{"headers":"146"},"A string describing the Kong entity the event hook listens to for events.\n",["150"],"A string describing one of four handler options: webhook, webhook-custom, log, or lambda.\n",["151"],"A string describing the action that triggers the event hook.\n",["152"],"An optional integer describing the time in seconds to delay an event trigger to avoid spamming an integration.\n",[0],"boolean","An optional boolean indicating whether to trigger an event when key parts of a payload have changed.\n","The URL the JSON POST request is made to with the event data as the payload.\n",["153"],"An object defining additional HTTP headers to send in the webhook request. For example `{\"X-Custom-Header\": \"My Value\"}`.\n",{"headers":"176"},"An optional string used to sign the remote webhook for remote verification. When set, Kong signs the body of the event hook with HMAC-SHA1 and includes it in a header, `x-kong-signature`, sent to the remote endpoint.\n","A boolean indicating whether to verify the SSL certificate of the remote HTTPS server where the event hook will be sent. The default is false.\n",{"config":"177","created_at":0,"event":"146","handler":"146","id":"146","on_change":"146","snooze":0,"source":"146"},{"config":"178","created_at":"179","event":"180","handler":"181","id":"182","on_change":"183","snooze":"184","source":"185"},{"config":"186","created_at":1627588552,"event":"187","handler":"188","id":"189","on_change":null,"snooze":null,"source":"152"},{"config":"190","created_at":1627581575,"event":"150","handler":"151","id":"191","on_change":null,"snooze":null,"source":"152"},{"config":"192","created_at":1627595513,"event":"150","handler":"193","id":"194","on_change":null,"snooze":null,"source":"152"},{"type":"146","description":"195"},{"body":"143","body_format":true,"headers":"196","headers_format":true,"method":"146","payload":"197","payload_format":true,"secret":"143","ssl_verify":true,"url":"146","functions":"198"},{"type":"86","properties":"199"},{"type":"149"},{"type":"146"},{"type":"146"},{"type":"146"},{"type":"146"},{"type":"149"},{"type":"146"},{"body":null,"body_format":true,"headers":"200","headers_format":false,"method":"201","payload":"202","payload_format":true,"secret":null,"ssl_verify":false,"url":"203"},"admins","webhook-custom","937df175-3db2-4e6d-8aa1-d95c94a76089",{"headers":"204","secret":null,"ssl_verify":false,"url":"153"},"c57340ab-9fed-40fd-bb7e-1cef8d37c2df",{"functions":"205"},"lambda","c9fdd58d-5416-4d3a-9467-51e5cfe4ca0e","Optional configuration header\n",{"content-type":"146"},{"text":"146"},["146"],{"body":"206","body_format":"207","headers":"208","headers_format":"209","method":"210","payload":"211","payload_format":"212","secret":"213","ssl_verify":"214","url":"215","functions":"216"},{"content-type":"64"},"POST",{"text":"217"},"https://hooks.slack.com/services/foo/bar/baz",{},["218"],{"type":"146"},{"type":"163"},{"type":"86","properties":"219"},{"type":"163"},{"type":"146"},{"type":"86","properties":"220"},{"type":"163"},{"type":"146"},{"type":"163"},{"type":"146"},{"type":"144","items":"221"},"payload_text","return function (data, event, source, pid)\n local user = data.entity.username\n error(\"Event hook on consumer \" .. user .. \"\")\nend\n",{"content-type":"222"},{"text":"223"},{"type":"146"},{"type":"146"},{"type":"146"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-event-hooks-sources",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all sources",["18"],"45f29aa8f2147","get","/event-hooks/sources",["19"],{},"get-event-hooks-sources","Sources are the actions that trigger the event hook. The `/sources` JSON output follows the following pattern:\n\n* 1st level = The source, which is the action that triggers the event hook.\n* 2nd level = The event, which is the Kong entity the event hook listens to for events.\n* 3rd level = The available template parameters for use in `webhook-custom` payloads.\n\nFor instance, in the example below `balancer` is the source, `health` is the event, and `upstream_id`, `ip`, `port`, `hostname`, and `health` are the available template parameters.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Event-hooks",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"4d46b836009dc","7fac2a90deaa5","200",[],["45"],"OK","1f7c28b40ef0a","401",[],["46"],"Unauthorized",{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},{"id":"63","mediaType":"59","examples":"64","encodings":"65","schema":"66"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"3d828122581c4","application/json",["76"],[],{"type":"77","properties":"78","x-examples":"79","$schema":"80","x-stoplight":"81"},"ab5d0e17941fb",["82","83","84"],[],{"type":"77","properties":"85","required":"86","title":"87","$schema":"80","x-stoplight":"88"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","89"],{"id":"90","key":"91","value":"92"},"object",{"data":"93"},{"Example 1":"94"},"http://json-schema.org/draft-07/schema#",{"id":"95"},{"id":"96","key":"97","value":"98","summary":"99"},{"id":"100","key":"101","value":"102","summary":"103"},{"id":"104","key":"105","value":"106","summary":"107"},{"status":"108","message":"109"},["110","111"],"UnauthorizedError",{"id":"112"},"https","4be7567c1dcf4","sources example",{"data":"113"},{"type":"77","properties":"114"},{"data":"115"},"85a3a7d647acd","277140709275c","DuplicateApiKey",{"message":"99","status":401},"Duplicate API key found","d696a6e33b60c","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","091c044218d90","NoAPIKey",{"message":"116","status":401},"No API key found",{"type":"117"},{"type":"118"},"status","message","470b68e5f0549",{"balancer":"119","crud":"120","rate-limiting-advanced":"121"},{"balancer":"122","crud":"123","rate-limiting-advanced":"124"},{"balancer":"125","crud":"126","rate-limiting-advanced":"127"},"No API key found in request","integer","string",{"health":"128"},{"acls":"129"},{"rate-limit-exceeded":"130"},{"type":"77","properties":"131"},{"type":"77","properties":"132"},{"type":"77","properties":"133"},{"health":"134"},{"acls":"135"},{"rate-limit-exceeded":"136"},{"fields":"137"},{"fields":"138"},{"description":"118","fields":"139","unique":"140"},{"health":"141"},{"acls":"142"},{"rate-limit-exceeded":"143"},{"fields":"144"},{"fields":"145"},{"description":"146","fields":"147","unique":"148"},["118"],["118"],["118"],["118"],{"type":"77","properties":"149"},{"type":"77","properties":"150"},{"type":"77","properties":"151"},["152","153","154","155","156"],["157","158","159","160"],"Run an event when a rate limit has been exceeded",["161","153","162","163","164","165"],["161","153","162"],{"fields":"166"},{"fields":"167"},{"description":"168","fields":"169","unique":"170"},"upstream_id","ip","port","hostname","health","operation","entity","old_entity","schema","consumer","service","rate","limit","window",{"type":"171","items":"172"},{"type":"171","items":"173"},{"type":"118"},{"type":"171","items":"174"},{"type":"171","items":"175"},"array",{"type":"118"},{"type":"118"},{"type":"118"},{"type":"118"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-event-hooks-sources-source",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all events for a source",["18"],"fb6ba3758e89e","get","/event-hooks/sources/{source}",["19"],{},"get-event-hooks-sources-source","Events are the Kong entities the event hook listens for events. With this endpoint, you can list all of the events associated with a particular source.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Event-hooks",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"4d46b836009dc","12bae9a94115d","200",[],["46"],"OK","456ae91d910f9","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","key":"56","extensions":"57","description":"58","type":"59","name":"60","in":"61"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"62","path":"63","port":"64","protocol":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},"12113fceec7b8","source","simple",[],"The source you want to list events from.",{"type":"75","$schema":"76","x-stoplight":"77"},["78","79","80","81","82"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88"},{"default":"89","description":"90","enum":"91"},"ca38a1bb11279","application/json",[],[],{"type":"92","properties":"93","x-examples":"94","$schema":"76","x-stoplight":"95"},"4e782d26d8000",["96","97","98"],[],{"type":"92","properties":"99","required":"100","title":"101","$schema":"76","x-stoplight":"102"},"string","http://json-schema.org/draft-07/schema#",{"id":"103"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["89","104"],"object",{"data":"105"},{"Example 1":"106"},{"id":"107"},{"id":"108","key":"109","value":"110","summary":"111"},{"id":"112","key":"113","value":"114","summary":"115"},{"id":"116","key":"117","value":"118","summary":"119"},{"status":"120","message":"121"},["122","123"],"UnauthorizedError",{"id":"124"},"729f9612f42cf","https",{"type":"92","properties":"125"},{"data":"126"},"d082dbc8e4d7a","340f8f7d78d5a","DuplicateApiKey",{"message":"111","status":401},"Duplicate API key found","9df22dcbe6f21","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","cf39042f81dae","NoAPIKey",{"message":"127","status":401},"No API key found",{"type":"128"},{"type":"75"},"status","message","470b68e5f0549",{"create":"129","delete":"130","update":"131"},{"create":"132","delete":"133","update":"134"},"No API key found in request","integer",{"type":"92","properties":"135"},{"type":"92","properties":"136"},{"type":"92","properties":"137"},{"fields":"138"},{"fields":"139"},{"fields":"140"},{"fields":"141"},{"fields":"142"},{"fields":"143"},["144","145","146","78"],["144","145","146","78"],["144","145","146","78"],{"type":"147","items":"148"},{"type":"147","items":"149"},{"type":"147","items":"150"},"operation","entity","old_entity","array",{"type":"75"},{"type":"75"},{"type":"75"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-event-hooks-event-hook-id-test",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Test an event hook",["18"],"6ac8d5dd29855","post","/event-hooks/{event-hook-id}/test",["19"],{},"post-event-hooks-event-hook-id-test","It’s useful to manually trigger an event hook without provoking the event to be triggered. For instance, you might want to test the integration, or see if your hook’s service is receiving a payload from Kong.\n\nPOST any data to `/event-hooks/:id-of-hook/test`, and the `/test` endpoint executes the with the provided data as the event payload.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Event-hooks",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"4d46b836009dc","a0cb84e8ec2b3","200",[],["46"],"Example event hooks response","661b859175dd1","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","key":"56","extensions":"57","description":"58","type":"59","name":"60","in":"61"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"62","path":"63","port":"64","protocol":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},"33dc0a7f9f031","event-hook-id","simple",[],"The event hook id",{"type":"75","$schema":"76","x-stoplight":"77"},["78","79","80","81","82"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88"},{"default":"89","description":"90","enum":"91"},"7f40b7a77f612","application/json",["92"],[],{"type":"93","properties":"94","x-examples":"95","$schema":"76","x-stoplight":"96"},"6add6adefb593",["97","98","99"],[],{"type":"93","properties":"100","required":"101","title":"102","$schema":"76","x-stoplight":"103"},"string","http://json-schema.org/draft-07/schema#",{"id":"104"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["89","105"],{"id":"106","key":"33","value":"107"},"object",{"data":"108","next":"109"},{"Example 1":"110"},{"id":"111"},{"id":"112","key":"113","value":"114","summary":"115"},{"id":"116","key":"117","value":"118","summary":"119"},{"id":"120","key":"121","value":"122","summary":"123"},{"status":"124","message":"125"},["126","127"],"UnauthorizedError",{"id":"128"},"ca4f870567333","https","4231a242d9d3b",{"data":"129","next":"130"},{"type":"131","items":"132"},{"type":"75"},{"data":"133","next":null},"a25679ec80462","a7495157f2308","DuplicateApiKey",{"message":"115","status":401},"Duplicate API key found","bb3d9deade82e","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","67b46d75d9f0b","NoAPIKey",{"message":"134","status":401},"No API key found",{"type":"135"},{"type":"75"},"status","message","470b68e5f0549",["136"],"null","array",{"type":"93","properties":"137"},["138","139","140"],"No API key found in request","integer",{"config":"141","created_at":0,"event":"75","handler":"75","id":"75","on_change":"75","snooze":0,"source":"75"},{"config":"142","created_at":"143","event":"144","handler":"145","id":"146","on_change":"147","snooze":"148","source":"149"},{"config":"150","created_at":1627588552,"event":"151","handler":"152","id":"153","on_change":null,"snooze":null,"source":"154"},{"config":"155","created_at":1627581575,"event":"156","handler":"157","id":"158","on_change":null,"snooze":null,"source":"154"},{"config":"159","created_at":1627595513,"event":"156","handler":"160","id":"161","on_change":null,"snooze":null,"source":"154"},{"body":"130","body_format":true,"headers":"162","headers_format":true,"method":"75","payload":"163","payload_format":true,"secret":"130","ssl_verify":true,"url":"75","functions":"164"},{"type":"93","properties":"165"},{"type":"135"},{"type":"75"},{"type":"75"},{"type":"75"},{"type":"75"},{"type":"135"},{"type":"75"},{"body":null,"body_format":true,"headers":"166","headers_format":false,"method":"167","payload":"168","payload_format":true,"secret":null,"ssl_verify":false,"url":"169"},"admins","webhook-custom","937df175-3db2-4e6d-8aa1-d95c94a76089","crud",{"headers":"170","secret":null,"ssl_verify":false,"url":"171"},"consumers","webhook","c57340ab-9fed-40fd-bb7e-1cef8d37c2df",{"functions":"172"},"lambda","c9fdd58d-5416-4d3a-9467-51e5cfe4ca0e",{"content-type":"75"},{"text":"75"},["75"],{"body":"173","body_format":"174","headers":"175","headers_format":"176","method":"177","payload":"178","payload_format":"179","secret":"180","ssl_verify":"181","url":"182","functions":"183"},{"content-type":"67"},"POST",{"text":"184"},"https://hooks.slack.com/services/foo/bar/baz",{},"https://webhook.site/a1b2c3-d4e5-g6h7-i8j9-k1l2m3n4o5p6",["185"],{"type":"75"},{"type":"186"},{"type":"93","properties":"187"},{"type":"186"},{"type":"75"},{"type":"93","properties":"188"},{"type":"186"},{"type":"75"},{"type":"186"},{"type":"75"},{"type":"131","items":"189"},"payload_text","return function (data, event, source, pid)\n local user = data.entity.username\n error(\"Event hook on consumer \" .. user .. \"\")\nend\n","boolean",{"content-type":"190"},{"text":"191"},{"type":"75"},{"type":"75"},{"type":"75"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/deleteEventHook",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Delete an event hook",["18"],"0e6b24e6c26dd","delete","/event-hooks/{event-hook-id}",["19"],{},"deleteEventHook","Deletes a specific event hook by its ID.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Event-hooks",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"4d46b836009dc","7f6f3ad3bb5da","204",[],[],"Event hook successfully deleted.","d70f3cb07d26a","404",[],[],"Event hook not found.",{"id":"46","name":"47","style":"48","examples":"49","description":"50","required":true,"schema":"51","explicitProperties":"52"},{"id":"53","key":"54","extensions":"55","description":"56","type":"57","name":"58","in":"59"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"60","path":"61","port":"62","protocol":"63"},"fd3527d0fa1f0","event-hook-id","simple",[],"The ID of the event hook to delete.",{"type":"64","$schema":"65","x-stoplight":"66"},["67","68","69","70","71"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"72","description":"73"},{"default":"74","description":"75"},{"default":"76","description":"77"},{"default":"78","description":"79","enum":"80"},"string","http://json-schema.org/draft-07/schema#",{"id":"81"},"name","in","required","description","schema","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["78","82"],"bf3cfec601c37","https"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-event-hooks-event-hook-id-ping",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Ping a webhook event hook",["18"],"93d8b024b3215","get","/event-hooks/{event-hook-id}/ping",["19"],{},"get-event-hooks-event-hook-id-ping","Ping a webhook event hook.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Event-hooks",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"4d46b836009dc","c7b98dcfb2093","200",[],["46"],"Example event hooks response","6fa98bf2efef8","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","key":"56","extensions":"57","description":"58","type":"59","name":"60","in":"61"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"62","path":"63","port":"64","protocol":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},"3dd5361296b16","event-hook-id","simple",[],"The ID of the event hook to delete.",{"type":"75","$schema":"76","x-stoplight":"77"},["78","79","80","81","82"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88"},{"default":"89","description":"90","enum":"91"},"f1e2b05d9121e","application/json",["92"],[],{"type":"93","properties":"94","x-examples":"95","$schema":"76","x-stoplight":"96"},"62b177ece7990",["97","98","99"],[],{"type":"93","properties":"100","required":"101","title":"102","$schema":"76","x-stoplight":"103"},"string","http://json-schema.org/draft-07/schema#",{"id":"104"},"name","in","required","description","schema","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["89","105"],{"id":"106","key":"33","value":"107"},"object",{"data":"108","next":"109"},{"Example 1":"110"},{"id":"111"},{"id":"112","key":"113","value":"114","summary":"115"},{"id":"116","key":"117","value":"118","summary":"119"},{"id":"120","key":"121","value":"122","summary":"123"},{"status":"124","message":"125"},["126","127"],"UnauthorizedError",{"id":"128"},"cbaadcb0bf0ee","https","935d0b82476dc",{"data":"129","next":"130"},{"type":"131","items":"132"},{"type":"75"},{"data":"133","next":null},"a25679ec80462","9b8e203cf3680","DuplicateApiKey",{"message":"115","status":401},"Duplicate API key found","e723478b347ed","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","75383de125e70","NoAPIKey",{"message":"134","status":401},"No API key found",{"type":"135"},{"type":"75"},"status","message","470b68e5f0549",["136"],"null","array",{"type":"93","properties":"137"},["138","139","140"],"No API key found in request","integer",{"config":"141","created_at":0,"event":"75","handler":"75","id":"75","on_change":"75","snooze":0,"source":"75"},{"config":"142","created_at":"143","event":"144","handler":"145","id":"146","on_change":"147","snooze":"148","source":"149"},{"config":"150","created_at":1627588552,"event":"151","handler":"152","id":"153","on_change":null,"snooze":null,"source":"154"},{"config":"155","created_at":1627581575,"event":"156","handler":"157","id":"158","on_change":null,"snooze":null,"source":"154"},{"config":"159","created_at":1627595513,"event":"156","handler":"160","id":"161","on_change":null,"snooze":null,"source":"154"},{"body":"130","body_format":true,"headers":"162","headers_format":true,"method":"75","payload":"163","payload_format":true,"secret":"130","ssl_verify":true,"url":"75","functions":"164"},{"type":"93","properties":"165"},{"type":"135"},{"type":"75"},{"type":"75"},{"type":"75"},{"type":"75"},{"type":"135"},{"type":"75"},{"body":null,"body_format":true,"headers":"166","headers_format":false,"method":"167","payload":"168","payload_format":true,"secret":null,"ssl_verify":false,"url":"169"},"admins","webhook-custom","937df175-3db2-4e6d-8aa1-d95c94a76089","crud",{"headers":"170","secret":null,"ssl_verify":false,"url":"171"},"consumers","webhook","c57340ab-9fed-40fd-bb7e-1cef8d37c2df",{"functions":"172"},"lambda","c9fdd58d-5416-4d3a-9467-51e5cfe4ca0e",{"content-type":"75"},{"text":"75"},["75"],{"body":"173","body_format":"174","headers":"175","headers_format":"176","method":"177","payload":"178","payload_format":"179","secret":"180","ssl_verify":"181","url":"182","functions":"183"},{"content-type":"67"},"POST",{"text":"184"},"https://hooks.slack.com/services/foo/bar/baz",{},"https://webhook.site/a1b2c3-d4e5-g6h7-i8j9-k1l2m3n4o5p6",["185"],{"type":"75"},{"type":"186"},{"type":"93","properties":"187"},{"type":"186"},{"type":"75"},{"type":"93","properties":"188"},{"type":"186"},{"type":"75"},{"type":"186"},{"type":"75"},{"type":"131","items":"189"},"payload_text","return function (data, event, source, pid)\n local user = data.entity.username\n error(\"Event hook on consumer \" .. user .. \"\")\nend\n","boolean",{"content-type":"190"},{"text":"191"},{"type":"75"},{"type":"75"},{"type":"75"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/getDataPlanes",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Retrieve connected data planes",["18"],"3328198118344","get","/clustering/data-planes",["19"],{},"getDataPlanes","Retrieve a list of all data planes connected to the control plane. This endpoint is only accessible when Kong Gateway is running in hybrid mode.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"clustering",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"6b8b3a28fe83c","90bb94c0d2a81","200",[],["45"],"A list of connected data planes.","689b92fb29f98","400",[],["46"],"Kong Gatewat is not running as a control plane.",{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},{"id":"63","mediaType":"59","examples":"64","encodings":"65","schema":"66"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"46faab2572aae","application/json",[],[],{"type":"76","properties":"77","$schema":"78","x-stoplight":"79"},"4bd23cd11797e",[],[],{"type":"76","properties":"80","$schema":"78","x-stoplight":"81"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","82"],"object",{"data":"83"},"http://json-schema.org/draft-07/schema#",{"id":"84"},{"message":"85"},{"id":"86"},"https",{"type":"87","items":"88"},"26521163e6b61",{"type":"89","examples":"90"},"07011bd0b8e72","array",{"type":"76","properties":"91"},"string",["92"],{"ip":"93","updated_at":"94","config_hash":"95","sync_status":"96","version":"97","id":"98","hostname":"99","ttl":"100","last_seen":"101","labels":"102","cert_details":"103"},"This endpoint is only available when Kong is running as a control plane for the cluster.",{"type":"89","description":"104"},{"type":"105","description":"106"},{"type":"89","description":"107"},{"type":"89","description":"108"},{"type":"89","description":"109"},{"type":"89","description":"110"},{"type":"89","description":"111"},{"type":"105","description":"112"},{"type":"105","description":"113"},{"type":"76","description":"114","properties":"115"},{"type":"76","properties":"116"},"The IP address of the data plane.","integer","Unix timestamp of the last update.","The hash of the current configuration on the data plane.","The sync status of the data plane.","The version of Kong running on the data plane.","Unique identifier of the data plane.","The hostname of the data plane.","Time-to-live for the connection.","Unix timestamp when the data plane was last seen by the control plane.","Metadata labels attached to the data plane.",{"deployment":"117","region":"118"},{"expiry_timestamp":"119"},{"type":"89","description":"120"},{"type":"89","description":"121"},{"type":"105","description":"122"},"The deployment name.","The region of the data plane.","Timestamp for when the certificate expires."]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/getDataPlaneStatus",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Retrieve the status of connected data planes",["18"],"31bb748f0dee9","get","/clustering/status",["19"],{},"getDataPlaneStatus","Retrieve a status report for all data planes connected to the control plane. It includes information like the config hash, hostname, IP address, and last seen timestamp. This endpoint is only accessible when Kong Gateway is running in hybrid mode.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"clustering",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"6b8b3a28fe83c","befeadedc4274","200",["45"],["46"],"The status of all connected data planes.","8c5eae965af5f","400",[],["47"],"Kong Gatewat is not running as a control plane.",{"id":"48","key":"49","extensions":"50","description":"51","type":"52","name":"53","in":"54"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"55","path":"56","port":"57","protocol":"58"},{"id":"59","name":"60","style":"61","schema":"62","description":"63","encodings":"64","examples":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"75","description":"76"},{"default":"77","description":"78"},{"default":"79","description":"80"},{"default":"81","description":"82","enum":"83"},"d294dff3a37a0","Deprecation","simple",{"type":"84","$schema":"85","x-stoplight":"86"},"Indicates that the endpoint may be deprecated in the future.\n",[],[],"ca910fca5c600","application/json",[],[],{"type":"87","additionalProperties":"88","$schema":"85","x-stoplight":"89"},"8bdd75cfbbae4",[],[],{"type":"87","properties":"90","$schema":"85","x-stoplight":"91"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["81","92"],"string","http://json-schema.org/draft-07/schema#",{"id":"93"},"object",{"type":"87","properties":"94"},{"id":"95"},{"message":"96"},{"id":"97"},"https","5aa8f55741ed0",{"config_hash":"98","hostname":"99","ip":"100","last_seen":"101"},"57a2c0e7a7354",{"type":"84","examples":"102"},"16b4ec3c38de2",{"type":"84","description":"103"},{"type":"84","description":"104"},{"type":"84","description":"105"},{"type":"106","description":"107"},["108"],"Hash of the configuration running on the data plane.","Hostname of the data plane.","The IP address of the data plane.","integer","Unix timestamp of the last interaction between the data plane and control plane.","This endpoint is only available when Kong is running as a control plane for the cluster."]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/getCacheByKey",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Get cache value by key",["18"],"88814d150180c","get","/cache/{key}",["19"],{},"getCacheByKey","Retrieve the cached value for a specific key. This endpoint probes both `kong.cache` and `kong.core_cache`. If the key exists, it returns the associated value and TTL. If not found, it returns a 404.\n","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"cache",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"81ef6e112aea3","8c2552353ab5f","200",[],["46"],"Cached value found.","e4055411fce93","404",[],["47"],"Cache key not found.",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","key":"56","extensions":"57","description":"58","type":"59","name":"60","in":"61"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"62","path":"63","port":"64","protocol":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},"20e92577f7952","key","simple",[],"The cache key to retrieve.",{"type":"75","$schema":"76","x-stoplight":"77"},["78","79","80","81","82"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"83","description":"84"},{"default":"85","description":"86"},{"default":"87","description":"88"},{"default":"89","description":"90","enum":"91"},"0466367318582","application/json",[],[],{"type":"92","properties":"93","$schema":"76","x-stoplight":"94"},"e9c77e77c9c20",[],[],{"type":"92","properties":"95","$schema":"76","x-stoplight":"96"},"string","http://json-schema.org/draft-07/schema#",{"id":"97"},"name","in","required","description","schema","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["89","98"],"object",{"ttl":"99","message":"100"},{"id":"101"},{"message":"102"},{"id":"103"},"17cbed7a0bd91","https",{"type":"104","description":"105"},{"type":"75","description":"106"},"aa7fab52936f0",{"type":"75","examples":"107"},"058fcf40ccd00","integer","Time-to-live (TTL) of the cached entry.","Cached value or a message.",["108"],"Not found"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/deleteCacheByKey",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Invalidate cache by key",["18"],"8e936d8c65a96","delete","/cache/{key}",["19"],{},"deleteCacheByKey","Invalidate the cache for a specific key in both `kong.cache` and `kong.core_cache`.\n","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"cache",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],["33"],["34"],{"id":"35","url":"36","name":"37","description":"38","variables":"39"},"81ef6e112aea3","44cb87c50aabf","204",[],[],"Cache invalidated successfully.",{"id":"40","name":"41","style":"42","examples":"43","description":"44","required":true,"schema":"45","explicitProperties":"46"},{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},"d88f82b005686","key","simple",[],"The cache key to invalidate.",{"type":"58","$schema":"59","x-stoplight":"60"},["61","62","63","64","65"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"66","description":"67"},{"default":"68","description":"69"},{"default":"70","description":"71"},{"default":"72","description":"73","enum":"74"},"string","http://json-schema.org/draft-07/schema#",{"id":"75"},"name","in","required","description","schema","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["72","76"],"e47cadbd657db","https"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/purgeAllCache",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Purge all cache entries",["18"],"d3b6a340e3cfe","delete","/cache",["19"],{},"purgeAllCache","Purge all cache entries in both `kong.cache` and `kong.core_cache`.\n","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"cache",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],[],["33"],{"id":"34","url":"35","name":"36","description":"37","variables":"38"},"81ef6e112aea3","545c6f02f8776","204",[],[],"All cache entries purged successfully.",{"id":"39","key":"40","extensions":"41","description":"42","type":"43","name":"44","in":"45"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"46","path":"47","port":"48","protocol":"49"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"50","description":"51"},{"default":"52","description":"53"},{"default":"54","description":"55"},{"default":"56","description":"57","enum":"58"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["56","59"],"https"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-config",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Apply Declarative Config",["18"],"df82353ea8576","post","/config",["19"],{},"post-config","Apply a configuration from a declarative JSON or YAML file. Any existing configuration will be overwritten. Note: This API is only available in DB-less mode.\n","inheritedFromService",["20"],{"body":"21","headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"config",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","contents":"35"},[],[],[],[],["36"],{"id":"37","url":"38","name":"39","description":"40","variables":"41"},"5f55edec3cdc9","dfcf5e4021274","201",[],["42"],"Created","98889dbf80737",["43","44","45"],{"id":"46","key":"47","extensions":"48","description":"49","type":"50","name":"51","in":"52"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"53","path":"54","port":"55","protocol":"56"},{"id":"57","mediaType":"58","examples":"59","encodings":"60","schema":"61"},{"id":"62","mediaType":"58","examples":"63","encodings":"64","schema":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"72","examples":"73","encodings":"74","schema":"75"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"76","description":"77"},{"default":"78","description":"79"},{"default":"80","description":"81"},{"default":"82","description":"83","enum":"84"},"924eb19fcaed7","application/json",[],[],{"type":"85","$schema":"86","x-stoplight":"87"},"1b0baf7b29e8b",[],[],{"type":"85","$schema":"86","x-stoplight":"88"},"b8a2cef7e1755","application/yaml",["89"],[],{"type":"85","$schema":"86","x-stoplight":"90"},"59659fb1faea1","multipart/form-data",[],[],{"type":"85","properties":"91","$schema":"86","x-stoplight":"92"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["82","93"],"object","http://json-schema.org/draft-07/schema#",{"id":"94"},{"id":"95"},{"id":"96","value":"97","key":"98"},{"id":"99"},{"config":"100"},{"id":"101"},"https","2da38ebca3c41","351a7df293d20","fc1b98d03bd38","services:\n - name: example-service\n url: http://example.com\n routes:\n - name: example-route\n paths:\n - /example\n","default","b825115c15778",{"type":"102","description":"103","examples":"104","contentMediaType":"105"},"ce1ce0a914f21","string","Configuration file in JSON or YAML.",["106"],"application/octet-stream","/path/to/<config-file>"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-config",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Get Declarative Config",["18"],"d227a980c67ec","get","/config",["19"],{},"get-config","Get the current configuration. Note: This API is only available in DB-less mode.\n","inheritedFromService",["20"],{"headers":"21","query":"22","cookie":"23","path":"24"},["25"],["26"],"config",{"id":"27","name":"18"},{"id":"28","code":"29","headers":"30","contents":"31","description":"32"},[],[],[],[],["33"],{"id":"34","url":"35","name":"36","description":"37","variables":"38"},"5f55edec3cdc9","fd293da26d7da","200",[],["39"],"OK",{"id":"40","key":"41","extensions":"42","description":"43","type":"44","name":"45","in":"46"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"47","path":"48","port":"49","protocol":"50"},{"id":"51","mediaType":"52","examples":"53","encodings":"54","schema":"55"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"56","description":"57"},{"default":"58","description":"59"},{"default":"60","description":"61"},{"default":"62","description":"63","enum":"64"},"f2b5e65f7c87a","application/json",[],[],{"type":"65","properties":"66","$schema":"67","x-stoplight":"68"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["62","69"],"object",{"config":"70"},"http://json-schema.org/draft-07/schema#",{"id":"71"},"https",{"type":"72"},"31170a5361b56","string"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-tags",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List all tags",["18"],"1e9d8feba480a","get","/tags",["19"],{},"get-tags","Returns a paginated list of all the tags in the system.\n\nThe list of entities isn't restricted to a single entity type. All the entities tagged with tags are present in this list.\n\nIf an entity is tagged with more than one tag, the `entity_id` for that entity appears more than once in the resulting list. Similarly, if several entities have been tagged with the same tag, the tag appears in several items of this list.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Tags",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],[],["39"],{"id":"40","url":"41","name":"42","description":"43","variables":"44"},"74c12741b988d","cf4f8e81a2a32","200",[],["45"],"Tags response body","649f8f131143f","401",[],["46"],"Unauthorized",{"id":"47","key":"48","extensions":"49","description":"50","type":"51","name":"52","in":"53"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"54","path":"55","port":"56","protocol":"57"},{"id":"58","mediaType":"59","examples":"60","encodings":"61","schema":"62"},{"id":"63","mediaType":"59","examples":"64","encodings":"65","schema":"66"},"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"67","description":"68"},{"default":"69","description":"70"},{"default":"71","description":"72"},{"default":"73","description":"74","enum":"75"},"92e9058075382","application/json",["76"],[],{"type":"77","x-examples":"78","properties":"79","$schema":"80","x-stoplight":"81"},"47360f886a44d",["82","83","84"],[],{"type":"77","properties":"85","required":"86","title":"87","$schema":"80","x-stoplight":"88"},"localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["73","89"],{"id":"90","key":"91","value":"92"},"object",{"Example 1":"93"},{"data":"94","offset":"95","next":"96"},"http://json-schema.org/draft-07/schema#",{"id":"97"},{"id":"98","key":"99","value":"100","summary":"101"},{"id":"102","key":"103","value":"104","summary":"105"},{"id":"106","key":"107","value":"108","summary":"109"},{"status":"110","message":"111"},["112","113"],"UnauthorizedError",{"id":"114"},"https","83658d4717e28","Tags response",{"data":"115","offset":"116","next":"117"},{"data":"118","offset":"119","next":"120"},{"type":"121","items":"122"},{"type":"123","description":"124","examples":"125"},{"type":"123","description":"124","examples":"126"},"38ba14ff65cef","b3868d560ae51","DuplicateApiKey",{"message":"101","status":401},"Duplicate API key found","81c9f6c63dff4","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","795e8882cc639","NoAPIKey",{"message":"127","status":401},"No API key found",{"type":"128"},{"type":"123"},"status","message","470b68e5f0549",["129"],"1fb491c4-f4a7-4bca-aeba-7f3bcee4d2f9","/tags/example?offset=1fb491c4-f4a7-4bca-aeba-7f3bcee4d2f9",["130"],"c47139f3-d780-483d-8a97-17e9adc5a7ab","/tags?offset=c47139f3-d780-483d-8a97-17e9adc5a7ab","array",{"type":"77","properties":"131"},"string","Pagination information",["116"],["117"],"No API key found in request","integer",{"entity_name":"132","entity_id":"133","tag":"134"},{"entity_name":"132","entity_id":"135","tag":"136"},{"entity_name":"137","entity_id":"138","tag":"139"},"services","c87440e1-0496-420b-b06f-dac59544bb6c","example","acf60b10-125c-4c1a-bffe-6ed55daefba4","s1",{"type":"123","description":"140","examples":"141"},{"type":"123","description":"142","examples":"143"},{"type":"123","description":"144","examples":"145"},"The name of the entity that corresponds to a tag",["132"],"The unique ID for the entity that is attached to the tag",["133"],"The tag",["134"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/get-tags-tags",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"List entity by tag",["18"],"c9e0b2546d921","get","/tags/{tags}",["19"],{},"get-tags-tags","Returns the entities that have been tagged with the specified tag.\n\nThe list of entities isn't restricted to a single entity type. All the entities tagged with tags are present in this list.","inheritedFromService",["20","21"],{"headers":"22","query":"23","cookie":"24","path":"25"},["26"],["27"],"Tags",{"id":"28","name":"18"},{"id":"29","code":"30","headers":"31","contents":"32","description":"33"},{"id":"34","code":"35","headers":"36","contents":"37","description":"38"},[],[],[],["39"],["40"],{"id":"41","url":"42","name":"43","description":"44","variables":"45"},"74c12741b988d","fce6fb3e1ede0","200",[],["46"],"Tags response body","6776faacaed4e","401",[],["47"],"Unauthorized",{"id":"48","name":"49","style":"50","examples":"51","description":"52","required":true,"schema":"53","explicitProperties":"54"},{"id":"55","key":"56","extensions":"57","description":"58","type":"59","name":"60","in":"61"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"62","path":"63","port":"64","protocol":"65"},{"id":"66","mediaType":"67","examples":"68","encodings":"69","schema":"70"},{"id":"71","mediaType":"67","examples":"72","encodings":"73","schema":"74"},"6809fe1f3bb75","tags","simple",[],"Tags are strings associated to entities in Kong.",{"type":"75","examples":"76","$schema":"77","x-stoplight":"78"},["79","80","81","82","83","84"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"85","description":"86"},{"default":"87","description":"88"},{"default":"89","description":"90"},{"default":"91","description":"92","enum":"93"},"b77754dd0953f","application/json",["94"],[],{"type":"95","x-examples":"96","properties":"97","$schema":"77","x-stoplight":"98"},"176dcd59c61b3",["99","100","101"],[],{"type":"95","properties":"102","required":"103","title":"104","$schema":"77","x-stoplight":"105"},"string",["106"],"http://json-schema.org/draft-07/schema#",{"id":"107"},"name","in","required","schema","description","title","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["91","108"],{"id":"109","key":"110","value":"111"},"object",{"Example 1":"112"},{"data":"113","offset":"114","next":"115"},{"id":"116"},{"id":"117","key":"118","value":"119","summary":"120"},{"id":"121","key":"122","value":"123","summary":"124"},{"id":"125","key":"126","value":"127","summary":"128"},{"status":"129","message":"130"},["131","132"],"UnauthorizedError",{"id":"133"},"example","4e46efeb64011","https","770fcfabee346","Tags response",{"data":"134","offset":"135","next":"136"},{"data":"137","offset":"138","next":"139"},{"type":"140","items":"141"},{"type":"75","description":"142","examples":"143"},{"type":"75","description":"142","examples":"144"},"38ba14ff65cef","2925b2605a5fe","DuplicateApiKey",{"message":"120","status":401},"Duplicate API key found","26ba498e6b3ed","InvalidAuthCred",{"message":"38","status":401},"Invalid authentication credentials","a4b661f2d4ee6","NoAPIKey",{"message":"145","status":401},"No API key found",{"type":"146"},{"type":"75"},"status","message","470b68e5f0549",["147"],"1fb491c4-f4a7-4bca-aeba-7f3bcee4d2f9","/tags/example?offset=1fb491c4-f4a7-4bca-aeba-7f3bcee4d2f9",["148"],"c47139f3-d780-483d-8a97-17e9adc5a7ab","/tags?offset=c47139f3-d780-483d-8a97-17e9adc5a7ab","array",{"type":"95","properties":"149"},"Pagination information",["135"],["136"],"No API key found in request","integer",{"entity_name":"150","entity_id":"151","tag":"106"},{"entity_name":"150","entity_id":"152","tag":"153"},{"entity_name":"154","entity_id":"155","tag":"156"},"services","c87440e1-0496-420b-b06f-dac59544bb6c","acf60b10-125c-4c1a-bffe-6ed55daefba4","s1",{"type":"75","description":"157","examples":"158"},{"type":"75","description":"159","examples":"160"},{"type":"75","description":"161","examples":"162"},"The name of the entity that corresponds to a tag",["150"],"The unique ID for the entity that is attached to the tag",["151"],"The tag",["106"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/post-schemas-vaults-validate",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Validate Vault Schema",["18"],"ad9a47a9f9ebe","post","/schemas/vaults/{vault_name}",["19"],{},"post-schemas-vaults-validate","Validates the given vault schema data against predefined validation rules.","inheritedFromService",["20","21","22"],{"body":"23","headers":"24","query":"25","cookie":"26","path":"27"},["28"],["29"],"Validation",{"id":"30","name":"18"},{"id":"31","code":"32","headers":"33","contents":"34","description":"35"},{"id":"36","code":"37","headers":"38","contents":"39","description":"40"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","contents":"47","required":true,"description":"48"},[],[],[],["49"],["50"],{"id":"51","url":"52","name":"53","description":"54","variables":"55"},"378e7c8e82699","ad3d05e62a823","200",[],["56"],"Validation successful","551d040967dab","400",[],[],"Bad request due to invalid schema data","556d040968524","405",[],[],"Method Not Allowed","56d2e39a1b8e2",["57"],"Payload containing the schema data to validate",{"id":"58","name":"59","style":"60","examples":"61","description":"62","required":true,"schema":"63","explicitProperties":"64"},{"id":"65","key":"66","extensions":"67","description":"68","type":"69","name":"70","in":"71"},"42f8f57f70108","{protocol}://{hostname}:{port}{path}","Enterprise Kong Admin API","Default Admin API URL",{"hostname":"72","path":"73","port":"74","protocol":"75"},{"id":"76","mediaType":"77","examples":"78","encodings":"79","schema":"80"},{"id":"81","mediaType":"77","examples":"82","encodings":"83","schema":"84"},"23e57f8bb817d","vault_name","simple",[],"The vault schema to be returned",{"type":"85","$schema":"86","x-stoplight":"87"},["88","89","90","91","92"],"77e1e5c2567de","kongAdminToken",{},"When RBAC is enabled, an admin token is required to use the Kong Admin API. \nThis token is passed in a `Kong-Admin-Token` header by default. \nTo configure the header name, adjust `rbac_auth_header` in `kong.conf`.\n<br><br>\nEach admin has their own token.\nThe admin associated with the token must have relevant permissions for the object they're interacting with.\nGenerate tokens using the `/admins` API.\n<br><br>\nIf RBAC isn't enabled, this token isn't required.\n","apiKey","Kong-Admin-Token","header",{"default":"93","description":"94"},{"default":"95","description":"96"},{"default":"97","description":"98"},{"default":"99","description":"100","enum":"101"},"832e47aaccc77","application/json",[],[],{"type":"102","properties":"103","$schema":"86","x-stoplight":"104"},"227f5113c19ba",[],[],{"type":"102","properties":"105","$schema":"86","x-stoplight":"106"},"string","http://json-schema.org/draft-07/schema#",{"id":"107"},"schema","name","in","required","description","localhost","Hostname for Kong's Admin API","/","Base path for Kong's Admin API","8001","Port for Kong's Admin API","http","Protocol for requests to Kong's Admin API",["99","108"],"object",{"validation":"109"},{"id":"110"},{"schemaData":"111"},{"id":"112"},"6ae8edef58f40","https",{"type":"113","description":"114"},"dd7f74f365399",{"type":"85","description":"115"},"3cad5f7305f9e","boolean","Indicates if the schema is valid","JSON string containing the vault schema data"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/Admin",{"type":"6","properties":"7","required":"8"},"Admin",[],"object",{"id":"9","created_at":"10","updated_at":"11","username":"12","username_lower":"13","custom_id":"14","email":"15","status":"16","rbac_token_enabled":"17","consumer":"18","rbac_user":"19"},["20","21","22","23","24"],{"type":"25","format":"26","description":"27"},{"type":"28","format":"29","description":"30"},{"type":"28","format":"29","description":"31"},{"type":"25","description":"32","uniqueItems":true},{"type":"25","description":"33"},{"type":"25","description":"34","uniqueItems":true},{"type":"25","format":"35","description":"36","uniqueItems":true},{"type":"25","description":"37","enum":"38"},{"type":"39","description":"40","default":true},{"type":"25","description":"41","format":"26"},{"type":"25","description":"42","format":"26"},"username","status","rbac_token_enabled","consumer","rbac_user","string","uuid","Unique identifier for the admin.","integer","timestamp","Timestamp when the admin was created.","Timestamp when the admin was last updated.","The admin's username.","The admin's username in lowercase.","The Admin’s custom ID.","email","The admin's email address.","The status of the admin.",["43","44"],"boolean","Allows the Admin to use and reset their RBAC token; true by default.","The ID of the associated consumer.","The ID of the associated RBAC user.","active","inactive"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/Group",{"type":"6","properties":"7","required":"8"},"Group",[],"object",{"id":"9","created_at":"10","updated_at":"11","name":"12","comment":"13"},["14"],{"type":"15","format":"16","description":"17"},{"type":"18","format":"19","description":"20"},{"type":"18","format":"19","description":"21"},{"type":"15","description":"22","uniqueItems":true},{"type":"15","description":"23"},"name","string","uuid","Unique identifier for the group.","integer","timestamp","Timestamp when the group was created.","Timestamp when the group was last updated.","The name of the group.","Any comments associated with the specific group."]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/UnauthorizedError",{"type":"6","properties":"7","required":"8","title":"4"},"UnauthorizedError",[],"object",{"status":"9","message":"10"},["11","12"],{"type":"13"},{"type":"14"},"status","message","integer","string"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/CA-Certificate",{"description":"6","example":"7","type":"8","properties":"9","title":"4"},"CA-Certificate",[],"A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate.",{"cert":"10","id":"11"},"object",{"cert":"12","cert_digest":"13","created_at":"14","id":"15","tags":"16"},"-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f260",{"description":"17","type":"18"},{"description":"19","type":"18"},{"description":"20","type":"21"},{"type":"18"},{"description":"22","type":"23","items":"24"},"PEM-encoded public certificate of the CA.","string","SHA256 hex digest of the public certificate. This field is read-only and it cannot be set by the caller, the value is automatically computed.","Unix epoch when the resource was created.","integer","An optional set of strings associated with the Certificate for grouping and filtering.","array",{"type":"18","example":"25"},"tag"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/Certificate",{"description":"6","example":"7","properties":"8","type":"9","title":"4"},"Certificate",[],"A certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service. Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames. If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string according to the following order, main certificate on the top, followed by any intermediates.",{"cert":"10","id":"11","key":"12"},{"cert":"13","cert_alt":"14","created_at":"15","id":"16","key":"17","key_alt":"18","tags":"19","updated_at":"20","snis":"21"},"object","-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","b2f34145-0343-41a4-9602-4c69dec2f269","-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----",{"description":"22","type":"23"},{"description":"24","type":"23"},{"description":"25","type":"26"},{"type":"23"},{"description":"27","type":"23"},{"description":"28","type":"23"},{"description":"29","items":"30","type":"31"},{"description":"32","type":"26"},{"description":"33","type":"31","items":"34"},"PEM-encoded public certificate chain of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","string","PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","Unix epoch when the resource was created.","integer","PEM-encoded private key of the SSL key pair. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is _referenceable_, which means it can be securely stored as a [secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started) in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).","An optional set of strings associated with the Certificate for grouping and filtering.",{"type":"23"},"array","Unix epoch when the resource was last updated.","A list of SNIs associated with the certificate.\n",{"type":"23","format":"35"},"hostname"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/Consumer",{"description":"6","example":"7","properties":"8","type":"9","x-examples":"10","title":"4"},"Consumer",[],"The Consumer object represents a consumer - or a user - of a Service. You can either rely on Kong as the primary datastore, or you can map the consumer list with your database to keep consistency between Kong and your existing primary datastore.",{"custom_id":"11","id":"12","tags":"13","username":"14"},{"created_at":"15","custom_id":"16","id":"17","tags":"18","updated_at":"19","username":"20"},"object",{"Consumer Object":"21"},"4200","8a388226-20e8-4027-a486-25e4f7db5d21",["22"],"bob-the-builder",{"description":"23","type":"24"},{"description":"25","type":"26"},{"type":"26"},{"description":"27","items":"28","type":"29"},{"description":"30","type":"24"},{"description":"31","type":"26"},{"custom_id":"11","id":"32","tags":"33","username":"14"},"silver-tier","Unix epoch when the resource was created.","integer","Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or `username` with the request.","string","An optional set of strings associated with the Consumer for grouping and filtering.",{"type":"26"},"array","Unix epoch when the resource was last updated.","The unique username of the Consumer. You must send either this field or `custom_id` with the request.","8a388226-80e8-4027-a486-25e4f7db5d21",["22"]]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ConsumerGroup",{"description":"6","type":"7","properties":"8","additionalProperties":false,"required":"9"},"ConsumerGroup",[],"Consumer groups enable the organization and categorization of consumers (users or applications) within an API ecosystem. By grouping consumers together, you eliminate the need to manage them individually, providing a scalable, efficient approach to managing configurations.","object",{"created_at":"10","id":"11","name":"12","tags":"13","updated_at":"14"},["15"],{"description":"16","type":"17"},{"type":"18","format":"19","description":"20","nullable":true},{"type":"18","description":"21"},{"description":"22","items":"23","type":"24"},{"description":"25","type":"17"},"name","Unix epoch when the resource was created.","integer","string","uuid","Unique identifier for the Consumer Group.","The name of the Consumer Group.","An optional set of strings associated with the Consumer Group for grouping and filtering.",{"type":"18"},"array","Unix epoch when the resource was last updated."]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/Event-Hooks",{"type":"6","description":"7","properties":"8","example":"9"},"Event-Hooks",[],"object","Event Hooks schema",{"data":"10","next":"11"},{"data":"12","next":null},{"type":"13","description":"14","items":"15"},{"type":"16","nullable":true},["17","18","19"],"array","List of event hooks",{"type":"6","properties":"20"},"string",{"config":"21","created_at":1627588552,"event":"22","handler":"23","id":"24","on_change":null,"snooze":null,"source":"25"},{"config":"26","created_at":1627581575,"event":"27","handler":"28","id":"29","on_change":null,"snooze":null,"source":"25"},{"config":"30","created_at":1627595513,"event":"27","handler":"31","id":"32","on_change":null,"snooze":null,"source":"25"},{"config":"33","created_at":"34","event":"35","handler":"36","id":"37","on_change":"38","snooze":"39","source":"40"},{"body":null,"body_format":true,"headers":"41","headers_format":false,"method":"42","payload":"43","payload_format":true,"secret":null,"ssl_verify":false,"url":"44"},"admins","webhook-custom","937df175-3db2-4e6d-8aa1-d95c94a76089","crud",{"headers":"45","secret":null,"ssl_verify":false,"url":"46"},"consumers","webhook","c57340ab-9fed-40fd-bb7e-1cef8d37c2df",{"functions":"47"},"lambda","c9fdd58d-5416-4d3a-9467-51e5cfe4ca0e",{"type":"6","description":"48","properties":"49"},{"type":"50"},{"type":"16"},{"type":"16"},{"type":"16"},{"type":"16","nullable":true},{"type":"50","nullable":true},{"type":"16"},{"content-type":"51"},"POST",{"text":"52"},"https://hooks.slack.com/services/foo/bar/baz",{},"https://webhook.site/a1b2c3-d4e5-g6h7-i8j9-k1l2m3n4o5p6",["53"],"Configuration for the event hook",{"body":"54","body_format":"55","headers":"56","headers_format":"57","method":"58","payload":"59","payload_format":"60","secret":"61","ssl_verify":"62","url":"63","functions":"64"},"integer","application/json","payload_text","return function (data, event, source, pid)\n local user = data.entity.username\n error(\"Event hook on consumer \" .. user .. \"\")\nend\n",{"type":"16","nullable":true},{"type":"65"},{"type":"6","nullable":true,"properties":"66"},{"type":"65"},{"type":"16"},{"type":"6","nullable":true,"properties":"67"},{"type":"65"},{"type":"16","nullable":true},{"type":"65"},{"type":"16"},{"type":"13","nullable":true,"items":"68"},"boolean",{"content-type":"69"},{"text":"70"},{"type":"16"},{"type":"16"},{"type":"16"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/Key",{"description":"6","example":"7","properties":"8","type":"9","title":"4"},"Key",[],"A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.",{"id":"10","jwk":"11","kid":"12","name":"13","pem":"14","set":"15"},{"created_at":"16","id":"17","jwk":"18","kid":"19","name":"20","pem":"21","set":"22","tags":"23","updated_at":"24"},"object","d958f66b-8e99-44d2-b0b4-edd5bbf24658","{\"alg\":\"RSA\", \"kid\": \"42\", ...}","42","a-key",{"private_key":"25","public_key":"25"},{"id":"26"},{"description":"27","type":"28"},{"type":"29"},{"description":"30","type":"29"},{"description":"31","type":"29"},{"description":"32","type":"29"},{"description":"33","properties":"34","type":"9"},{"additionalProperties":false,"description":"35","properties":"36","type":"9"},{"description":"37","items":"38","type":"39"},{"description":"40","type":"28"},"-----BEGIN","b86b331c-dcd0-4b3e-97ce-47c5a9543031","Unix epoch when the resource was created.","integer","string","A JSON Web Key represented as a string.","A unique identifier for a key.","The name to associate with the given keys.","A keypair in PEM format.",{"private_key":"41","public_key":"42"},"The id (an UUID) of the key-set with which to associate the key.",{"id":"43"},"An optional set of strings associated with the Key for grouping and filtering.",{"type":"29"},"array","Unix epoch when the resource was last updated.",{"type":"29"},{"type":"29"},{"type":"29"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/Key-set",{"example":"6","properties":"7","type":"8","title":"4"},"Key-set",[],{"id":"9","name":"10","tags":"11"},{"created_at":"12","id":"13","name":"14","tags":"15","updated_at":"16"},"object","b58c7d9d-e54f-444c-b24d-cdfc4159f61e","example-key-set",["17"],{"description":"18","type":"19"},{"type":"20"},{"type":"20"},{"items":"21","type":"22"},{"description":"23","type":"19"},"idp-keys","Unix epoch when the resource was created.","integer","string",{"type":"20"},"array","Unix epoch when the resource was last updated."]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/Plugin",{"description":"6","example":"7","properties":"8","type":"9","title":"4"},"Plugin",[],"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":"10","enabled":true,"id":"11","name":"12","protocols":"13"},{"config":"14","consumer":"15","consumer_group":"16","created_at":"17","enabled":"18","id":"19","name":"20","ordering":"21","protocols":"22","route":"23","service":"24","tags":"25","updated_at":"26"},"object",{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":"27","run_on_preflight":true},"3fd1eea1-885a-4011-b986-289943ff8177","key-auth",["28","29","30","31"],{"description":"32","type":"9"},{"additionalProperties":false,"description":"33","properties":"34","type":"9"},{"additionalProperties":false,"description":"35","properties":"36","type":"9"},{"description":"37","type":"38"},{"default":true,"description":"39","type":"40"},{"type":"41"},{"description":"42","type":"41"},{"type":"9"},{"default":"43","description":"44","items":"45","type":"46"},{"additionalProperties":false,"description":"47","properties":"48","type":"9"},{"additionalProperties":false,"description":"49","properties":"50","type":"9"},{"description":"51","items":"52","type":"46"},{"description":"53","type":"38"},["54"],"grpc","grpcs","http","https","The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).","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":"55"},"If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",{"id":"56"},"Unix epoch when the resource was created.","integer","Whether the plugin is applied.","boolean","string","The name of the plugin that's going to be added. The plugin must be installed in every Kong instance separately.",["28","29","30","31"],"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`.",{"type":"41"},"array","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":"57"},"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":"58"},"An optional set of strings associated with the plugin for grouping and filtering.",{"type":"41"},"Unix epoch when the resource was last updated.","apikey",{"type":"41"},{"type":"41"},{"type":"41"},{"type":"41"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/Route",{"description":"6","example":"7","properties":"8","type":"9","title":"4"},"Route",[],"Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.",{"hosts":"10","id":"11","name":"12","paths":"13","service":"14"},{"created_at":"15","destinations":"16","headers":"17","hosts":"18","https_redirect_status_code":"19","id":"20","methods":"21","name":"22","path_handling":"23","paths":"24","preserve_host":"25","protocols":"26","regex_priority":"27","request_buffering":"28","response_buffering":"29","service":"30","expression":"31","priority":"32","snis":"33","sources":"34","strip_path":"35","tags":"36","updated_at":"37"},"object",["38","39"],"56c4566c-14cc-4132-9011-4139fcbbe50a","example-route",["40","41"],{"id":"42"},{"description":"43","type":"44"},{"description":"45","items":"46","type":"47"},{"description":"48","type":"9"},{"description":"49","items":"50","type":"47"},{"default":426,"description":"51","type":"44"},{"type":"52"},{"description":"53","items":"54","type":"47"},{"description":"55","type":"52"},{"default":"56","description":"57","type":"52"},{"description":"58","items":"59","type":"47"},{"default":false,"description":"60","type":"61"},{"default":"62","description":"63","items":"64","type":"47"},{"default":0,"description":"65","type":"44"},{"default":true,"description":"66","type":"61"},{"default":true,"description":"67","type":"61"},{"additionalProperties":false,"description":"68","properties":"69","type":"9"},{"description":"70","type":"52"},{"description":"71","type":"44","default":0},{"description":"72","items":"73","type":"47"},{"description":"74","items":"75","type":"47"},{"default":true,"description":"76","type":"61"},{"description":"77","items":"78","type":"47"},{"description":"79","type":"44"},"foo.example.com","foo.example.us","/v1","/v2","bd380f99-659d-415e-b0e7-72ea05df3218","Unix epoch when the resource was created.","integer","A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"80","type":"9"},"array","One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this `attribute:` hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","A list of domain names that match this Route. Note that the hosts value is case sensitive.",{"type":"52"},"The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. This config applies only if the Route is configured to only accept the `https` protocol.","string","A list of HTTP methods that match this Route.",{"type":"52"},"The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named \"test\" and \"Test\".","v0","Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","A list of paths that match this Route.",{"type":"52"},"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","boolean",["81","82"],"An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `\"https\"`, HTTP requests are answered with an upgrade error. When set to only `\"http\"`, HTTPS requests are answered with an error.",{"type":"52"},"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","The Service this route is associated to. This is where the route proxies traffic to.",{"id":"83"},"The route expression used for advanced routing scenarios. This field is used to evaluate route matches based on complex criteria beyond the standard routing fields.","A number used to specify the matching order for expression routes. The higher the `priority`, the sooner a route will be evaluated. This field is ignored unless `expression` field is set. The value must be between 0 and 2^46 - 1.","A list of SNIs that match this route when using stream routing.",{"type":"52"},"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields \"ip\" (optionally in CIDR range notation) and/or \"port\".",{"properties":"84","type":"9"},"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","An optional set of strings associated with the route for grouping and filtering.",{"type":"52"},"Unix epoch when the resource was last updated.",{"default":"85"},"http","https",{"type":"52"},{"default":"86"},{},{}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/SNI",{"description":"6","example":"7","properties":"8","type":"9","title":"4"},"SNI",[],"An SNI object represents a many-to-one mapping of hostnames to a certificate. That is, a certificate object can have many hostnames associated with it; when Kong receives an SSL request, it uses the SNI field in the Client Hello to lookup the certificate object based on the SNI associated with the certificate.",{"certificate":"10","id":"11","name":"12"},{"certificate":"13","created_at":"14","id":"15","name":"16","tags":"17","updated_at":"18"},"object",{"id":"19"},"36c4566c-14cc-4132-9011-4139fcbbe50a","some.example.org",{"additionalProperties":false,"description":"20","properties":"21","type":"9"},{"description":"22","type":"23"},{"type":"24"},{"description":"25","type":"24"},{"description":"26","items":"27","type":"28"},{"description":"29","type":"23"},"bd380f99-659d-415e-b0e7-72ea05df3218","The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.",{"id":"30"},"Unix epoch when the resource was created.","integer","string","The SNI name to associate with the given certificate.","An optional set of strings associated with the SNIs for grouping and filtering.",{"type":"24"},"array","Unix epoch when the resource was last updated.",{"type":"24"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/Service",{"description":"6","example":"7","properties":"8","type":"9","title":"4"},"Service",[],"Service entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its `protocol`, `host`, `port` and `path` individually. Services are associated to routes (a Service can have many routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.",{"host":"10","id":"11","name":"12","path":"13","port":80,"protocol":"14"},{"ca_certificates":"15","client_certificate":"16","connect_timeout":"17","created_at":"18","enabled":"19","host":"20","id":"21","name":"22","path":"23","port":"24","protocol":"25","read_timeout":"26","retries":"27","tags":"28","tls_verify":"29","tls_verify_depth":"30","updated_at":"31","url":"32","write_timeout":"33"},"object","example.internal","49fd316e-c457-481c-9fc7-8079153e4f3c","example-service","/","http",{"description":"34","items":"35","type":"36"},{"additionalProperties":false,"description":"37","properties":"38","type":"9"},{"default":60000,"description":"39","type":"40"},{"description":"41","type":"40"},{"default":true,"description":"42","type":"43"},{"description":"44","type":"45"},{"type":"45"},{"description":"46","type":"45"},{"description":"47","type":"45"},{"default":80,"description":"48","type":"40"},{"default":"14","description":"49","type":"45"},{"default":60000,"description":"50","type":"40"},{"default":5,"description":"51","type":"40"},{"description":"52","items":"53","type":"36"},{"description":"54","type":"43"},{"description":"55","type":"40"},{"description":"56","type":"40"},{"description":"57","type":"45"},{"default":60000,"description":"58","type":"40"},"Array of `CA Certificate` object UUIDs that are used to build the trust store while verifying upstream servers TLS certificate. If set to `null` when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).",{"type":"45"},"array","Certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"59"},"The timeout in milliseconds for establishing a connection to the upstream server.","integer","Unix epoch when the resource was created.","Whether the Service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404).","boolean","The host of the upstream server. Note that the host value is case sensitive.","string","The Service name.","The path to be used in requests to the upstream server.","The upstream server port.","The protocol used to communicate with the upstream.","The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.","The number of retries to execute upon failure to proxy.","An optional set of strings associated with the Service for grouping and filtering.",{"type":"45"},"Whether to enable verification of upstream server TLS certificate. If set to `null`, then the Nginx default is respected.","Maximum depth of chain while verifying Upstream server's TLS certificate. If set to `null`, then the Nginx default is respected.","Unix epoch when the resource was last updated.","Helper field to set `protocol`, `host`, `port` and `path` using a URL. This field is write-only and is not returned in responses.","The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.",{"type":"45"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/Target",{"description":"6","example":"7","properties":"8","type":"9","title":"4"},"Target",[],"A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly. To disable a target, post a new one with `weight=0`; alternatively, use the `DELETE` convenience method to accomplish the same. The current target object definition is the one with the latest `created_at`.",{"id":"10","target":"11","upstream":"12","weight":100},{"created_at":"13","id":"14","tags":"15","target":"16","updated_at":"17","upstream":"18","weight":"19"},"object","089292a7-ba3d-4d88-acf0-97b4b2e2621a","203.0.113.42",{"id":"20"},{"description":"21","type":"22"},{"type":"23"},{"description":"24","items":"25","type":"26"},{"description":"27","type":"23"},{"description":"28","type":"22"},{"additionalProperties":false,"properties":"29","type":"9"},{"default":100,"description":"30","type":"31"},"5f1d7e76-2fed-4806-a6af-869984f025cb","Unix epoch when the resource was created.","number","string","An optional set of strings associated with the Target for grouping and filtering.",{"type":"23"},"array","The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the `port` value will be overridden by the value from the DNS record.","Unix epoch when the resource was last updated.",{"id":"32"},"The weight this target gets within the upstream loadbalancer (`0`-`65535`). If the hostname resolves to an SRV record, the `weight` value will be overridden by the value from the DNS record.","integer",{"type":"23"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/Upstream",{"description":"6","example":"7","properties":"8","type":"9","title":"4"},"Upstream",[],"The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets). So for example an upstream named `service.v1.xyz` for a Service object whose `host` is `service.v1.xyz`. Requests for this Service would be proxied to the targets defined within the upstream. An upstream also includes a [health checker][healthchecks], which is able to enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.",{"algorithm":"10","hash_fallback":"11","hash_on":"11","hash_on_cookie_path":"12","healthchecks":"13","id":"14","name":"15","slots":10000},{"algorithm":"16","client_certificate":"17","created_at":"18","hash_fallback":"19","hash_fallback_header":"20","hash_fallback_query_arg":"21","hash_fallback_uri_capture":"22","hash_on":"23","hash_on_cookie":"24","hash_on_cookie_path":"25","hash_on_header":"26","hash_on_query_arg":"27","hash_on_uri_capture":"28","healthchecks":"29","host_header":"30","id":"31","name":"32","slots":"33","tags":"34","updated_at":"35","use_srv_name":"36"},"object","round-robin","none","/",{"active":"37","passive":"38","threshold":0},"6eed5e9c-5398-4026-9a4c-d48f18a2431e","api.example.internal",{"description":"39","type":"40","default":"10","enum":"41","nullable":true},{"additionalProperties":false,"description":"42","properties":"43","type":"9"},{"description":"44","type":"45"},{"default":"11","description":"46","type":"40"},{"description":"47","type":"40"},{"description":"48","type":"40"},{"description":"49","type":"40"},{"default":"11","description":"50","type":"40"},{"description":"51","type":"40"},{"default":"12","description":"52","type":"40"},{"description":"53","type":"40"},{"description":"54","type":"40"},{"description":"55","type":"40"},{"properties":"56","type":"9"},{"description":"57","type":"40"},{"type":"40"},{"description":"58","type":"40"},{"default":10000,"description":"59","type":"45"},{"description":"60","items":"61","type":"62"},{"description":"63","type":"45"},{"default":false,"description":"64","type":"65"},{"concurrency":10,"healthy":"66","http_path":"12","https_verify_certificate":true,"timeout":1,"type":"67","unhealthy":"68"},{"healthy":"69","type":"67","unhealthy":"70"},"Which load balancing algorithm to use.","string",["71","72","10","73"],"If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.",{"id":"74"},"Unix epoch when the resource was created.","integer","What to use as hashing input if the primary `hash_on` does not return a hash (eg. header is missing, or no Consumer identified). Not available if `hash_on` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_fallback` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_fallback` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_fallback` is set to `uri_capture`.","What to use as hashing input. Using `none` results in a weighted-round-robin scheme with no hashing.","The cookie name to take the value from as hash input. Only required when `hash_on` or `hash_fallback` is set to `cookie`. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.","The cookie path to set in the response headers. Only required when `hash_on` or `hash_fallback` is set to `cookie`.","The header name to take the value from as hash input. Only required when `hash_on` is set to `header`.","The name of the query string argument to take the value from as hash input. Only required when `hash_on` is set to `query_arg`.","The name of the route URI capture to take the value from as hash input. Only required when `hash_on` is set to `uri_capture`.",{"active":"75","passive":"76","threshold":"77"},"The hostname to be used as `Host` header when proxying requests through Kong.","This is a hostname, which must be equal to the `host` of a Service.","The number of slots in the load balancer algorithm. If `algorithm` is set to `round-robin`, this setting determines the maximum number of slots. If `algorithm` is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range `10`-`65536`.","An optional set of strings associated with the Upstream for grouping and filtering.",{"type":"40"},"array","Unix epoch when the resource was last updated.","If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream `Host`.","boolean",{"http_statuses":"78","interval":0,"successes":0},"http",{"http_failures":0,"http_statuses":"79","interval":0,"tcp_failures":0,"timeouts":0},{"http_statuses":"80","successes":0},{"http_failures":0,"http_statuses":"81","tcp_failures":0,"timeouts":0},"consistent-hashing","least-connections","latency",{"type":"40"},{"properties":"82","type":"9"},{"properties":"83","type":"9"},{"default":0,"type":"84"},[200,302],[429,404,500,501,502,503,504,505],[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],[429,500,503],{"concurrency":"85","headers":"86","healthy":"87","http_path":"88","https_sni":"89","https_verify_certificate":"90","timeout":"91","type":"92","unhealthy":"93"},{"healthy":"94","type":"95","unhealthy":"96"},"number",{"default":10,"type":"45"},{"type":"9"},{"properties":"97","type":"9"},{"default":"12","type":"40"},{"type":"40"},{"default":true,"type":"65"},{"default":1,"type":"84"},{"default":"67","type":"40"},{"properties":"98","type":"9"},{"properties":"99","type":"9"},{"default":"67","type":"40"},{"properties":"100","type":"9"},{"http_statuses":"101","interval":"102","successes":"103"},{"http_failures":"104","http_statuses":"105","interval":"106","tcp_failures":"107","timeouts":"108"},{"http_statuses":"109","successes":"110"},{"http_failures":"111","http_statuses":"112","tcp_failures":"113","timeouts":"114"},{"default":"115","items":"116","type":"62"},{"default":0,"type":"84"},{"default":0,"type":"45"},{"default":0,"type":"45"},{"default":"117","items":"118","type":"62"},{"default":0,"type":"84"},{"default":0,"type":"45"},{"default":0,"type":"45"},{"default":"119","items":"120","type":"62"},{"default":0,"type":"45"},{"default":0,"type":"45"},{"default":"121","items":"122","type":"62"},{"default":0,"type":"45"},{"default":0,"type":"45"},[200,302],{"type":"45"},[429,404,500,501,502,503,504,505],{"type":"45"},[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],{"type":"45"},[429,500,503],{"type":"45"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/Vault",{"description":"6","type":"7","properties":"8","example":"9","additionalProperties":false,"required":"10","title":"4"},"Vault",[],"Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, HashiCorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.","object",{"config":"11","created_at":"12","description":"13","id":"14","name":"15","prefix":"16","tags":"17","updated_at":"18"},{"config":"19","description":"20","id":"21","name":"22","prefix":"22","tags":"23"},["24","25","26"],{"description":"27","type":"7","additionalProperties":true},{"description":"28","type":"29","readOnly":true},{"description":"30","type":"31","nullable":true},{"type":"31","nullable":true},{"description":"32","type":"31"},{"description":"33","type":"31"},{"description":"34","type":"35","items":"36"},{"description":"37","type":"29","readOnly":true},{"prefix":"38"},"environment variable based vault","2747d1e5-8246-4f65-a939-b392f1ee17f8","env",["39","40"],"name","prefix","config","The configuration properties for the Vault which can be found on the vaults' documentation page.","Unix epoch when the resource was created.","integer","The description of the Vault entity.","string","The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.","The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.","An optional set of strings associated with the Vault for grouping and filtering.","array",{"type":"31"},"Unix epoch when the resource was last updated.","ENV_PREFIX","foo","bar"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/Workspace",{"type":"6","properties":"7","x-examples":"8","description":"9","title":"4"},"Workspace",[],"object",{"comment":"10","config":"11","created_at":"12","id":"13","meta":"14","name":"15"},{"Example 1":"16"},"Workspaces provide a way to segment Kong entities.",{"type":"17"},{"type":"6","properties":"18"},{"description":"19","type":"20"},{"type":"17","description":"21"},{"type":"6","properties":"22"},{"type":"17"},{"comment":"17","config":"23","created_at":0,"id":"17","meta":"24","name":"17"},"string",{"meta":"25","portal":"26","portal_access_request_email":"27","portal_application_request_email":"28","portal_application_status_email":"29","portal_approved_email":"30","portal_auth":"31","portal_auth_conf":"32","portal_auto_approve":"33","portal_cors_origins":"34","portal_developer_meta_fields":"35","portal_emails_from":"36","portal_emails_reply_to":"37","portal_invite_email":"38","portal_is_legacy":"39","portal_reset_email":"40","portal_reset_success_email":"41","portal_session_conf":"42","portal_smtp_admin_emails":"43","portal_token_exp":"44"},"Unix epoch when the resource was created.","integer","The unique UUID for this resource.",{"color":"45","thumbnail":"46"},{"meta":"47","portal":false,"portal_access_request_email":true,"portal_application_request_email":true,"portal_application_status_email":true,"portal_approved_email":true,"portal_auth":"17","portal_auth_conf":"17","portal_auto_approve":true,"portal_cors_origins":"48","portal_developer_meta_fields":"49","portal_emails_from":"17","portal_emails_reply_to":"17","portal_invite_email":true,"portal_is_legacy":true,"portal_reset_email":true,"portal_reset_success_email":true,"portal_session_conf":"17","portal_smtp_admin_emails":"50","portal_token_exp":0},{"color":"17","thumbnail":"17"},{"type":"6"},{"default":false,"type":"51","description":"52"},{"type":"51"},{"type":"51"},{"type":"51"},{"type":"51"},{"type":"17"},{"type":"17"},{"type":"51"},{"type":"53","items":"54"},{"default":"49","type":"17"},{"type":"17"},{"type":"17"},{"type":"51"},{"type":"51"},{"type":"51"},{"type":"51"},{"type":"17"},{"type":"53","items":"55"},{"type":"20"},{"type":"17"},{"type":"17"},{},["17"],"[{\"label\":\"Full Name\",\"title\":\"full_name\",\"validator\":{\"required\":true,\"type\":\"string\"}}]",["17"],"boolean","Portal enabled","array",{"type":"17"},{"type":"17"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/pagination-offset-response",{"description":"6","type":"7","title":"4"},"pagination-offset-response",[],"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","string"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/Filter-chains",{"type":"6","x-examples":"7","description":"8","title":"4","properties":"9"},"Filter-chains",[],"object",{"Example 1":"10"},"A filter chain is the database entity representing one or more WebAssembly filters executed for each request to a particular service or route, each one with its configuration.",{"id":"11","name":"12","created_at":"13","updated_at":"14","enabled":"15","route":"16","service":"17","filters":"18","tags":"19"},{"id":"20","name":"21","created_at":1422386534,"updated_at":1422386534,"enabled":true,"route":null,"service":"22","filters":"23","tags":"24"},{"type":"25","description":"26","example":"20","format":"27"},{"type":"25","description":"28","example":"21"},{"type":"29","example":1422386534},{"type":"29","example":1422386534},{"type":"30","description":"31","default":true},{"description":"32","nullable":true},{"type":"25","description":"33","example":"22"},{"type":"34","description":"35","items":"36"},{"type":"34","items":"37"},"ce44eef5-41ed-47f6-baab-f725cecf98c7","my-chain","20487393-41ed-47f6-93a8-3407cade2002",["38","39"],["40"],"string","The unique identifier or the name attribute of the route that should be associated to the newly created filter chain.","uuid","The name of the filter chain.\n","integer","boolean","Whether the filter chain is applied. Default: true.\n","The route to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `route.id=<route id>` or `route.name=<route name>`. In JSON format, use `\"route\":{\"id\":\"<route id>\"}` or `\"route\":{\"name\":\"<route name>\"}`.","The service to which this chain is applied. A filter chain must be applied to either a single route or a single service. Default `null`. In form-encoded format, the notation is `service.id=<service id>` or `service.name=<service name>`. In JSON format, use `\"service\":{\"id\":\"<service id>\"}` or `\"service\":{\"name\":\"<service name>\"}`.","array","An array of filter definitions. Each filter is an object containing a mandatory name, an optional config, and a boolean enabled setting.",{"type":"6","properties":"41"},{"type":"25"},{"name":"42","enabled":true,"config":"43"},{"name":"44","enabled":true,"config":"45"},"my-tag",{"name":"46","enabled":"47","config":"48"},"go-rate-limiting","{ \"minute\": 30 }","rust-response-transformer","{ \"remove_header\": \"X-Example\" }",{"type":"25","description":"49","example":"42"},{"type":"30","description":"50"},{"type":"25","description":"51","example":"52"},"The name of the filter\n","Enable the filter","configuration filter headers","{ \\\"minute\\\": 30 }"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/RequestTimestampFilterSchema",{"oneOf":"6","title":"4"},"RequestTimestampFilterSchema",[],["7","8"],{"type":"9","pattern":"10"},{"type":"11"},"string","^(\\d+|\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z)$","integer"]