Konnect API Builder - OpenAPI Specifications

Catalog

The management API for building APIs for Konnect Dev Portals.

API Base URL

Server 1:https://us.api.konghq.com/v3[Konnect API Builder]
United-States Production region
Server 2:https://eu.api.konghq.com/v3[Konnect API Builder]
Europe Production region
Server 3:https://au.api.konghq.com/v3[Konnect API Builder]
Australia Production region
Server 4:https://me.api.konghq.com/v3[Konnect API Builder]
Middle-East Production region
Server 5:https://in.api.konghq.com/v3[Konnect API Builder]
India Production region

Security

konnectAccessToken (http)

The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.

personalAccessToken (http)

The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.
You can generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.
The PAT token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'

systemAccountAccessToken (http)

The system account access token is meant for automations and integrations that are not directly associated with a human identity.
You can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.
The access token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'

Additional Information

Contact Kong

Body

application/json

API

idstring(uuid)

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

namestringrequired

The name of your API. The name + version combination must be unique for each API you publish.

>= 1 characters<= 255 characters

Example:MyAPI

description[ "string", "null" ]

A description of your API. Will be visible on your live Portal.

version[ "string", "null" ]

An optional version for your API. Leave this empty if your API is unversioned.

>= 1 characters<= 255 characters

deprecatedboolean

Marks this API as deprecated.

Default:false

slug[ "string", "null" ]

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

Match pattern:^[\w-]+$

Example:my-api-v1

portalsarray[object]unique-items

The list of portals which this API is published to.

* Additional properties are NOT allowed.

Show Child Parameters

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

public_labelsobject

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"category":"finance"}

created_atstring(date-time)

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Response

application/json

API

idstring(uuid)required

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

namestringrequired

The name of your API. The name + version combination must be unique for each API you publish.

>= 1 characters<= 255 characters

Example:MyAPI

description[ "string", "null" ]

A description of your API. Will be visible on your live Portal.

version[ "string", "null" ]required

An optional version for your API. Leave this empty if your API is unversioned.

>= 1 characters<= 255 characters

deprecatedbooleanrequired

Marks this API as deprecated.

Default:false

slug[ "string", "null" ]required

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

Match pattern:^[\w-]+$

Example:my-api-v1

portalsarray[object]requiredunique-items

The list of portals which this API is published to.

* Additional properties are NOT allowed.

Show Child Parameters

labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

public_labelsobjectrequired

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"category":"finance"}

created_atstring(date-time)required

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)required

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

post/apis

Authentication

Path Parameters

Query Parameters

Headers

Body

{
"name": "myAPI"
}

application/json

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-api-document",{"id":"6","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 API Document",["18"],"f18de009d86a2","post","/apis/{apiId}/documents",["19"],{},"create-api-document","**Pre-release Endpoint**\nThis endpoint is currently in beta and is subject to change.\n\nPublish a new document attached to an API.\n\nAll configuration options may be provided in the frontmatter section of `content`. If you set values in both the `POST` request _and_ in the frontmatter, the values in the `POST` request will take precedence.","inheritedFromService",["20","21","22","23","24","25","26"],{"body":"27","headers":"28","query":"29","cookie":"30","path":"31"},["32","33","34"],["35","36","37","38","39"],"API Documentation",{"id":"40","name":"18"},{"id":"41","code":"42","headers":"43","contents":"44","description":"45"},{"id":"46","code":"47","headers":"48","contents":"49","description":"50"},{"id":"51","code":"52","headers":"53","contents":"54","description":"55"},{"id":"56","code":"57","headers":"58","contents":"59","description":"60"},{"id":"61","code":"62","headers":"63","contents":"64","description":"65"},{"id":"66","code":"67","headers":"68","contents":"69","description":"70"},{"id":"71","code":"72","headers":"73","contents":"74","description":"75"},{"id":"76","contents":"77","required":true},[],[],[],["78"],["79"],["80"],["81"],{"id":"82","url":"83","name":"84","description":"85"},{"id":"86","url":"87","name":"84","description":"88"},{"id":"89","url":"90","name":"84","description":"91"},{"id":"92","url":"93","name":"84","description":"94"},{"id":"95","url":"96","name":"84","description":"97"},"7bb42b6c52f63","4aef37cbf25fa","201",[],["98"],"API document","7d9f37235b3da","400",[],["99"],"Bad Request","7d8f37235b5a5","401",[],["100"],"ApiUnauthorized","7d6f37235b8c3","403",[],["101"],"ApiForbidden","7ddf37235cd26","404",[],["102"],"Not Found","7e0f37235c83d","409",[],["103"],"Conflict - `slug` property must be unique","4d8f372338b4c","415",[],["104"],"Unsupported Media Type","79e29c02faddc",["105"],{"id":"106","name":"107","style":"108","examples":"109","description":"110","required":true,"schema":"111","explicitProperties":"112"},{"id":"113","key":"114","extensions":"115","description":"116","type":"117","scheme":"118","bearerFormat":"119"},{"id":"120","key":"121","extensions":"122","description":"123","type":"117","scheme":"118","bearerFormat":"124"},{"id":"125","key":"126","extensions":"127","description":"128","type":"117","scheme":"118","bearerFormat":"124"},"0769d8e475a5e","https://us.api.konghq.com/v3","Konnect API Builder","United-States Production region","61342abe2f3cb","https://eu.api.konghq.com/v3","Europe Production region","84004808a9585","https://au.api.konghq.com/v3","Australia Production region","8fcbd9ea343fc","https://me.api.konghq.com/v3","Middle-East Production region","173b3c2295fb2","https://in.api.konghq.com/v3","India Production region",{"id":"129","mediaType":"130","examples":"131","encodings":"132","schema":"133"},{"id":"134","mediaType":"135","examples":"136","encodings":"137","schema":"138"},{"id":"139","mediaType":"135","examples":"140","encodings":"141","schema":"142"},{"id":"143","mediaType":"135","examples":"144","encodings":"145","schema":"146"},{"id":"147","mediaType":"135","examples":"148","encodings":"149","schema":"150"},{"id":"151","mediaType":"135","examples":"152","encodings":"153","schema":"154"},{"id":"155","mediaType":"135","examples":"156","encodings":"157","schema":"158"},{"id":"159","mediaType":"130","examples":"160","encodings":"161","schema":"162"},"014961bcc351f","apiId","simple",[],"The UUID API identifier",{"type":"163","format":"164","examples":"165","$schema":"166","x-stoplight":"167"},["168","169","170","171","172","173"],"d28ec3acb281b","konnectAccessToken",{},"The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.\n","http","bearer","JWT","d1dbedfe3d6a7","personalAccessToken",{},"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.\nYou can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'`\n","Token","cd0f7f0ee1553","systemAccountAccessToken",{},"The system account access token is meant for automations and integrations that are not directly associated with a human identity.\nYou can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.\nThe access token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'`\n","21ee684189b1b","application/json",["174"],[],{"type":"175","title":"176","additionalProperties":false,"properties":"177","required":"178","$schema":"166","x-stoplight":"179"},"ab2d6d4d06072","application/problem+json",["180"],[],{"allOf":"181","title":"182","$schema":"166","x-stoplight":"183"},"b81b1d3b5cbdc",["184"],[],{"allOf":"185","title":"186","$schema":"166","x-stoplight":"187"},"6ec28d1d0b700",["188"],[],{"allOf":"189","title":"190","$schema":"166","x-stoplight":"191"},"dffd7fd2f1d82",["192"],[],{"allOf":"193","title":"194","$schema":"166","x-stoplight":"195"},"453a0237f8fe9",["196"],[],{"type":"175","required":"197","properties":"198","$schema":"166","x-stoplight":"199"},"3b39635aee9e4",["200"],[],{"allOf":"201","title":"202","$schema":"166","x-stoplight":"203"},"842dfc16fe695",["204","205"],[],{"type":"175","title":"176","additionalProperties":false,"properties":"206","required":"207","$schema":"166","x-stoplight":"208"},"string","uuid",["209"],"http://json-schema.org/draft-07/schema#",{"id":"210"},"schema","name","in","required","description","title",{"id":"211","key":"212","value":"213"},"object","API Document",{"id":"214","content":"215","title":"216","slug":"217","status":"218","parent_document_id":"219","labels":"220","created_at":"221","updated_at":"222"},["223","224","173","225","226","227","228","229","230"],{"id":"231"},{"id":"232","key":"233","value":"234"},["235","236"],"BadRequestError",{"id":"237"},{"id":"238","key":"239","value":"240"},["235","241"],"UnauthorizedError",{"id":"242"},{"id":"243","key":"244","value":"245"},["235","246"],"ForbiddenError",{"id":"247"},{"id":"248","key":"249","value":"250"},["235","251"],"NotFoundError",{"id":"252"},{"id":"253","key":"254","value":"255"},["226","173","256"],{"status":"257","title":"258","type":"259","instance":"260"},{"id":"261"},{"id":"262","key":"263","value":"264"},["235","265"],"UnsupportedMediaTypeError",{"id":"266"},{"id":"267","key":"268","value":"269","summary":"270"},{"id":"271","key":"272","value":"273","summary":"274"},{"id":"214","content":"215","title":"216","slug":"217","status":"218","parent_document_id":"219","labels":"220","created_at":"221","updated_at":"222"},["227"],{"id":"275"},"9f5061ce-78f6-4452-9108-ad7c02821fd5","790aa80f7e626","87f226d86f112","CreateApiDocumentResponse",{"id":"276","parent_document_id":null,"title":"176","slug":"277","status":"278","content":"279","labels":"280","created_at":"281","updated_at":"281"},{"title":"282","type":"163","format":"164","description":"283","readOnly":true,"examples":"284"},{"title":"285","type":"163","description":"286"},{"title":"287","type":"163","description":"288","examples":"289"},{"title":"290","type":"163","pattern":"291","description":"292","examples":"293"},{"type":"163","enum":"294","description":"295","default":"296","title":"297"},{"title":"298","type":"299","format":"164","description":"300","examples":"301"},{"title":"302","type":"175","maxProperties":50,"description":"303","additionalProperties":"304","examples":"305"},{"type":"163","format":"306","description":"307","readOnly":true,"title":"308","examples":"309"},{"type":"163","format":"306","description":"310","readOnly":true,"title":"311","examples":"312"},"id","parent_document_id","slug","status","content","labels","updated_at","created_at","e6b343bf9b042","3757aba4bd165","ApiNameBadRequestExample",{"status":400,"title":"313","instance":"314","detail":"315","invalid_parameters":"316"},{"type":"175","title":"317","description":"318","required":"319","properties":"320"},{"type":"175","required":"321","properties":"322"},"8760545dffb8d","28639312fdaf8","ApiUnauthorizedExample",{"status":401,"title":"55","instance":"323","detail":"55"},{"type":"175","properties":"324"},"ffcfce43381c6","bf091a1eae960","ApiForbiddenExample",{"status":403,"title":"60","instance":"325","detail":"326"},{"type":"175","properties":"327"},"04be40c0018bb","68f6d4888c683","ApiNotFoundExample",{"status":404,"title":"65","instance":"328","detail":"65"},{"type":"175","properties":"329"},"3107d64213173","f775aa1775421","ApiSlugConflictExample",{"status":409,"title":"330","instance":"331"},"instance",{"type":"332"},{"type":"163"},{"type":"163"},{"type":"163"},"2ea91a427a34f","79f130bb7eb7d","UnsupportedMediaTypeExample",{"status":415,"title":"75","instance":"323","detail":"333"},{"type":"175","properties":"334"},"77eba89c47d24","95ee1b3e588e4","CreateApiDocumentRequestMinimalExample",{"slug":"277","status":"278","title":"176","content":"279"},"Create API Document Request (Minimal)","804ee0295a7ca","CreateApiDocumentRequestExample",{"slug":"277","status":"278","title":"176","content":"279","parent_document_id":"335"},"Create API Document Request","0722dcc242978","de5c9818-be5c-42e6-b514-e3d4bc30ddeb","api-document","published","# API Document Header",{"type":"336"},"2023-01-01T00:00:00.000Z","API Document ID","The API document identifier.",["276"],"API Document Content","Raw markdown content to display in your Portal","API Document Title","The title of the document. Used to populate the `<title>` tag for the page",["176"],"API Document Slug","^[\\w-]+$","The `slug` is used in generated URLs to provide human readable paths.\n\nDefaults to `slugify(title)`\n",["277"],["278","296"],"If `status=published` the document will be visible in your live portal","unpublished","ApiDocumentStatus","API Document Parent Document ID",["163","337"],"API Documents may be rendered as a tree of files.\n\nSpecify the `id` of another API Document as the `parent_document_id` to add some heirarchy do your documents.\n",[null],"Labels","Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n",{"type":"163","pattern":"338","minLength":1,"maxLength":63},["339"],"date-time","An ISO-8601 timestamp representation of entity creation date.","CreatedAt",["340"],"An ISO-8601 timestamp representation of entity update date.","UpdatedAt",["340"],"Invalid Request","kong:trace:5832302153563197721","Invalid Parameters",["341"],"Error","standard error",["226","173","256","342"],{"status":"343","title":"344","type":"345","instance":"346","detail":"347"},["348"],{"invalid_parameters":"349"},"kong:trace:8347343766220159418",{"status":"350","title":"351","type":"352","instance":"353","detail":"354"},"kong:trace:2723154947768991354","You do not have permission to perform this action",{"status":"355","title":"356","type":"357","instance":"358","detail":"359"},"kong:trace:6816496025408232265",{"status":"360","title":"361","type":"362","instance":"363","detail":"364"},"Conflict","kong:trace:3169213858331814220","number","This API only supports requests with `Content-Type: application/json`",{"status":"365","title":"366","type":"367","instance":"368","detail":"369"},"417a2aed-9a75-4eca-a943-fa7d88ed6a73","tutorial","null","^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$",{"env":"370"},"2022-11-04T20:10:06.927Z",{"field":"225","rule":"371","reason":"372"},"detail",{"type":"373","description":"374","readOnly":true},{"type":"163","description":"375","readOnly":true},{"type":"163","description":"376","readOnly":true},{"type":"163","description":"377","readOnly":true},{"type":"163","description":"378","readOnly":true},"invalid_parameters",{"type":"379","uniqueItems":true,"minItems":1,"description":"380","items":"381","title":"382","x-stoplight":"383"},{"examples":"384"},{"examples":"385"},{"examples":"386"},{"examples":"387"},{"examples":"388"},{"examples":"389"},{"examples":"390"},{"examples":"391"},{"examples":"392"},{"examples":"393"},{"examples":"394"},{"examples":"395"},{"examples":"396"},{"examples":"397"},{"examples":"398"},{"examples":"399"},{"examples":"400"},{"examples":"401"},{"examples":"402"},{"examples":"403"},"test","matches_regex","slug must match /^[\\w-]+$/ regular expression","integer","The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","The error type.","Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","array","invalid parameters",{"oneOf":"404"},"InvalidParameters",{"explicitProperties":"405"},[401],["406"],["407"],["408"],["409"],[403],["410"],["411"],["408"],["410"],[404],["65"],["412"],["408"],["413"],[415],["414"],["415"],["408"],["414"],["416","417","418","419","420"],["421","422","423","424","172","425","173"],"Unauthorized","https://httpstatuses.com/401","kong:trace:1234567890","Invalid credentials","Forbidden","https://httpstatuses.com/403","https://httpstatuses.com/404","Not found","UnsupportedMediaType","https://httpstatuses.com/415",{"type":"175","additionalProperties":false,"properties":"426","required":"427","title":"428"},{"type":"175","additionalProperties":false,"properties":"429","required":"430","title":"431"},{"type":"175","additionalProperties":false,"properties":"432","required":"433","title":"434"},{"type":"175","additionalProperties":false,"properties":"435","required":"436","title":"437"},{"type":"175","additionalProperties":false,"properties":"438","required":"439","title":"440"},"type","nullable","uniqueItems","minItems","items",{"field":"441","rule":"442","source":"443","reason":"444"},["445","446"],"InvalidParameterStandard",{"field":"447","rule":"448","minimum":"449","source":"450","reason":"451"},["445","446","452","453"],"InvalidParameterMinimumLength",{"field":"454","rule":"455","maximum":"456","source":"457","reason":"458"},["445","446","452","459"],"InvalidParameterMaximumLength",{"field":"460","rule":"461","reason":"462","choices":"463","source":"464"},["445","446","452","465"],"InvalidParameterChoiceItem",{"field":"466","rule":"467","reason":"468","dependents":"469","source":"470"},["445","452","446","471"],"InvalidParameterDependentItem",{"type":"163","readOnly":true,"examples":"472"},{"description":"473","type":"474","readOnly":true,"enum":"475","title":"476"},{"type":"163","examples":"477"},{"type":"163","readOnly":true,"examples":"478"},"field","reason",{"type":"163","readOnly":true,"examples":"479"},{"description":"473","type":"163","readOnly":true,"enum":"480","x-stoplight":"481"},{"type":"373","examples":"482"},{"type":"163","examples":"483"},{"type":"163","readOnly":true,"examples":"484"},"rule","minimum",{"type":"163","readOnly":true,"examples":"485"},{"description":"473","type":"163","readOnly":true,"enum":"486","x-stoplight":"487"},{"type":"373","examples":"488"},{"type":"163","examples":"489"},{"type":"163","readOnly":true,"examples":"490"},"maximum",{"type":"163","readOnly":true,"examples":"491"},{"description":"473","type":"163","readOnly":true,"enum":"492","x-stoplight":"493"},{"type":"163","readOnly":true,"examples":"494"},{"type":"379","uniqueItems":true,"readOnly":true,"minItems":1,"items":"495","x-stoplight":"496"},{"type":"163","examples":"497"},"choices",{"type":"163","readOnly":true,"examples":"498"},{"description":"473","type":"499","readOnly":true,"enum":"500"},{"type":"163","readOnly":true,"examples":"501"},{"type":"502","uniqueItems":true,"items":"503","readOnly":true},{"type":"163","examples":"504"},"dependents",["169"],"invalid parameters rules",["163","337"],["171","505","506","507","508","509","510","511","512","513","514","515","516","517","518","519","371","520","521","522","523",null],"InvalidRules",["524"],["525"],["169"],["526","527","528","529","530","531","532"],{"explicitProperties":"533"},[8],["524"],["534"],["169"],["535","536","537"],{"explicitProperties":"538"},[8],["524"],["539"],["169"],["540"],{"explicitProperties":"541"},["525"],{},{"explicitProperties":"542"},["524"],["169"],["163","337"],["543",null],["525"],["379","337"],{},["524"],"is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","body","is a required field","min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min",["172","421","544","422","540"],"must have at least 8 characters","max_length","max_items","max",["172","421","544","422","540"],"must not have more than 8 characters","enum",["172","421","544","422","540"],["421","423","544","422","424","425"],"dependent_fields","readOnly"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/move-api-document",{"id":"6","method":"7","path":"8","tags":"9","extensions":"10","iid":"11","description":"12","summary":"4","securityDeclarationType":"13","responses":"14","request":"15","security":"16","servers":"17"},"Move API Documentation",["18"],"2a8c54d3b7443","put","/apis/{apiId}/documents/{documentId}/move",["19"],{},"move-api-document","**Pre-release Endpoint**\nThis endpoint is currently in beta and is subject to change.\n\nThis api allows the user to move a document within the document tree using the parameters parent_document_id and index. If parent_document_id is not provided, the document will be placed at the top level of the document tree. index represents a zero-indexed document order relative to its siblings under the same parent. For example, if we want to put the document at top level in first position we would send parent_document_id: null and index: 0. This api also supports using a negative index to count backwards from the end of the document list, which means you can put the document in last position by using index: -1.","inheritedFromService",["20","21","22","23","24"],{"body":"25","headers":"26","query":"27","cookie":"28","path":"29"},["30","31","32"],["33","34","35","36","37"],"API Documentation",{"id":"38","name":"18"},{"id":"39","code":"40","headers":"41","contents":"42","description":"43"},{"id":"44","code":"45","headers":"46","contents":"47","description":"48"},{"id":"49","code":"50","headers":"51","contents":"52","description":"53"},{"id":"54","code":"55","headers":"56","contents":"57","description":"58"},{"id":"59","code":"60","headers":"61","contents":"62","description":"63"},{"id":"64","contents":"65","required":true,"description":"66"},[],[],[],["67","68"],["69"],["70"],["71"],{"id":"72","url":"73","name":"74","description":"75"},{"id":"76","url":"77","name":"74","description":"78"},{"id":"79","url":"80","name":"74","description":"81"},{"id":"82","url":"83","name":"74","description":"84"},{"id":"85","url":"86","name":"74","description":"87"},"7bb42b6c52f63","2354f42663919","204",[],[],"Document for the API was moved successfully.","7b24f6032442e","401",[],["88"],"ApiUnauthorized","7b04f603240b0","403",[],["89"],"ApiForbidden","7af4f60324105","404",[],["90"],"Not Found","7ba4f603257b6","409",[],["91"],"Conflict","8b618c1cfe34a",["92"],"move document",{"id":"93","name":"94","style":"95","examples":"96","description":"97","required":true,"schema":"98","explicitProperties":"99"},{"id":"100","name":"101","style":"95","examples":"102","description":"103","required":true,"schema":"104","explicitProperties":"105"},{"id":"106","key":"107","extensions":"108","description":"109","type":"110","scheme":"111","bearerFormat":"112"},{"id":"113","key":"114","extensions":"115","description":"116","type":"110","scheme":"111","bearerFormat":"117"},{"id":"118","key":"119","extensions":"120","description":"121","type":"110","scheme":"111","bearerFormat":"117"},"0769d8e475a5e","https://us.api.konghq.com/v3","Konnect API Builder","United-States Production region","61342abe2f3cb","https://eu.api.konghq.com/v3","Europe Production region","84004808a9585","https://au.api.konghq.com/v3","Australia Production region","8fcbd9ea343fc","https://me.api.konghq.com/v3","Middle-East Production region","173b3c2295fb2","https://in.api.konghq.com/v3","India Production region",{"id":"122","mediaType":"123","examples":"124","encodings":"125","schema":"126"},{"id":"127","mediaType":"123","examples":"128","encodings":"129","schema":"130"},{"id":"131","mediaType":"123","examples":"132","encodings":"133","schema":"134"},{"id":"135","mediaType":"123","examples":"136","encodings":"137","schema":"138"},{"id":"139","mediaType":"140","examples":"141","encodings":"142","schema":"143"},"ecd68ebec1670","apiId","simple",[],"The UUID API identifier",{"type":"144","format":"145","examples":"146","$schema":"147","x-stoplight":"148"},["149","150","151","152","153","154"],"113c052a47982","documentId",[],"The document identifier related to the API",{"type":"144","format":"145","examples":"155","$schema":"147","x-stoplight":"156"},["149","150","153","151","152","154"],"d28ec3acb281b","konnectAccessToken",{},"The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.\n","http","bearer","JWT","d1dbedfe3d6a7","personalAccessToken",{},"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.\nYou can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'`\n","Token","cd0f7f0ee1553","systemAccountAccessToken",{},"The system account access token is meant for automations and integrations that are not directly associated with a human identity.\nYou can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.\nThe access token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'`\n","7d90d4b44be88","application/problem+json",["157"],[],{"allOf":"158","title":"159","$schema":"147","x-stoplight":"160"},"6237b19aef8d3",["161"],[],{"allOf":"162","title":"163","$schema":"147","x-stoplight":"164"},"3fc85cc00317b",["165"],[],{"allOf":"166","title":"167","$schema":"147","x-stoplight":"168"},"6e0b4e0c27efd",[],[],{"allOf":"169","title":"170","$schema":"147","x-stoplight":"171"},"130f5863258f8","application/json",[],[],{"type":"172","title":"173","description":"174","properties":"175","$schema":"147","x-stoplight":"176"},"string","uuid",["177"],"http://json-schema.org/draft-07/schema#",{"id":"178"},"schema","name","in","required","description","title",["179"],{"id":"180"},{"id":"181","key":"182","value":"183"},["184","185"],"UnauthorizedError",{"id":"186"},{"id":"187","key":"188","value":"189"},["184","190"],"ForbiddenError",{"id":"191"},{"id":"192","key":"193","value":"194"},["184","195"],"NotFoundError",{"id":"196"},["184","197"],"ConflictError",{"id":"198"},"object","Move document","move document request payload",{"parent_document_id":"199","index":"200"},{"id":"201"},"9f5061ce-78f6-4452-9108-ad7c02821fd5","42febc8ed51f1","de5c9818-be5c-42e6-b514-e3d4bc30ddeb","3df79ce3e2056","1dbb7ff78991f","ApiUnauthorizedExample",{"status":401,"title":"48","instance":"202","detail":"48"},{"type":"172","title":"203","description":"204","required":"205","properties":"206"},{"type":"172","properties":"207"},"ffcfce43381c6","0febb2dcc3f6e","ApiForbiddenExample",{"status":403,"title":"53","instance":"208","detail":"209"},{"type":"172","properties":"210"},"04be40c0018bb","334d41b29b0fa","ApiNotFoundExample",{"status":404,"title":"58","instance":"211","detail":"58"},{"type":"172","properties":"212"},"3107d64213173",{"type":"172","properties":"213"},"cb6cb4cf5e9ac",{"type":"144","format":"145","description":"214","examples":"215"},{"type":"216","description":"217","examples":"218"},"06cf85e450cae","kong:trace:8347343766220159418","Error","standard error",["219","154","220","221"],{"status":"222","title":"223","type":"224","instance":"225","detail":"226"},{"status":"227","title":"228","type":"229","instance":"230","detail":"231"},"kong:trace:2723154947768991354","You do not have permission to perform this action",{"status":"232","title":"233","type":"234","instance":"235","detail":"236"},"kong:trace:6816496025408232265",{"status":"237","title":"238","type":"239","instance":"240","detail":"241"},{"status":"242","title":"243","type":"244","instance":"245","detail":"246"},"parent document id",["247"],"integer","index of the document in the parent document's children",[1],"status","instance","detail",{"type":"216","description":"248","readOnly":true},{"type":"144","description":"249","readOnly":true},{"type":"144","description":"250","readOnly":true},{"type":"144","description":"251","readOnly":true},{"type":"144","description":"252","readOnly":true},{"examples":"253"},{"examples":"254"},{"examples":"255"},{"examples":"256"},{"examples":"257"},{"examples":"258"},{"examples":"259"},{"examples":"260"},{"examples":"261"},{"examples":"262"},{"examples":"263"},{"examples":"264"},{"examples":"265"},{"examples":"266"},{"examples":"267"},{"examples":"268"},{"examples":"269"},{"examples":"270"},{"examples":"271"},{"examples":"272"},"dd4e1b98-3629-4dd3-acc0-759a726ffee2","The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","The error type.","Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n",[401],["273"],["274"],["275"],["276"],[403],["277"],["278"],["275"],["277"],[404],["58"],["279"],["275"],["280"],[409],["63"],["281"],["275"],["63"],"Unauthorized","https://httpstatuses.com/401","kong:trace:1234567890","Invalid credentials","Forbidden","https://httpstatuses.com/403","https://httpstatuses.com/404","Not found","https://httpstatuses.com/409"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"http_operation","/operations/create-api-implementation",{"id":"6","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 API Implementation",["18"],"72457b0a8631b","post","/apis/{apiId}/implementations",["19"],{},"create-api-implementation","**Pre-release Endpoint**\nThis endpoint is currently in beta and is subject to change.\n\nCreates an implementation for an API.\nAn API can be implemented by a single Gateway Service.","inheritedFromService",["20","21","22","23","24","25"],{"body":"26","headers":"27","query":"28","cookie":"29","path":"30"},["31","32","33"],["34","35","36","37","38"],"API Implementation",{"id":"39","name":"18"},{"id":"40","code":"41","headers":"42","contents":"43","description":"44"},{"id":"45","code":"46","headers":"47","contents":"48","description":"49"},{"id":"50","code":"51","headers":"52","contents":"53","description":"54"},{"id":"55","code":"56","headers":"57","contents":"58","description":"59"},{"id":"60","code":"61","headers":"62","contents":"63","description":"64"},{"id":"65","code":"66","headers":"67","contents":"68","description":"69"},{"id":"70","contents":"71","required":true},[],[],[],["72"],["73"],["74"],["75"],{"id":"76","url":"77","name":"78","description":"79"},{"id":"80","url":"81","name":"78","description":"82"},{"id":"83","url":"84","name":"78","description":"85"},{"id":"86","url":"87","name":"78","description":"88"},{"id":"89","url":"90","name":"78","description":"91"},"f871d7648e8d2","af4e7d1a076cb","201",[],["92"],"An API implementation","077e7ef6ca2a7","400",[],["93"],"Bad Request","076e7ef6c9cd0","401",[],["94"],"ApiUnauthorized","074e7ef6c994e","403",[],["95"],"ApiForbidden","073e7ef6c9bfb","404",[],["96"],"Not Found","07ee7ef6cae48","409",[],["97"],"Conflict - A gateway service can only be linked to a single API","bf2e734e56f81",["98"],{"id":"99","name":"100","style":"101","examples":"102","description":"103","required":true,"schema":"104","explicitProperties":"105"},{"id":"106","key":"107","extensions":"108","description":"109","type":"110","scheme":"111","bearerFormat":"112"},{"id":"113","key":"114","extensions":"115","description":"116","type":"110","scheme":"111","bearerFormat":"117"},{"id":"118","key":"119","extensions":"120","description":"121","type":"110","scheme":"111","bearerFormat":"117"},"0769d8e475a5e","https://us.api.konghq.com/v3","Konnect API Builder","United-States Production region","61342abe2f3cb","https://eu.api.konghq.com/v3","Europe Production region","84004808a9585","https://au.api.konghq.com/v3","Australia Production region","8fcbd9ea343fc","https://me.api.konghq.com/v3","Middle-East Production region","173b3c2295fb2","https://in.api.konghq.com/v3","India Production region",{"id":"122","mediaType":"123","examples":"124","encodings":"125","schema":"126"},{"id":"127","mediaType":"128","examples":"129","encodings":"130","schema":"131"},{"id":"132","mediaType":"128","examples":"133","encodings":"134","schema":"135"},{"id":"136","mediaType":"128","examples":"137","encodings":"138","schema":"139"},{"id":"140","mediaType":"128","examples":"141","encodings":"142","schema":"143"},{"id":"144","mediaType":"128","examples":"145","encodings":"146","schema":"147"},{"id":"148","mediaType":"123","examples":"149","encodings":"150","schema":"151"},"48e0e3a43525e","apiId","simple",[],"The UUID API identifier",{"type":"152","format":"153","examples":"154","$schema":"155","x-stoplight":"156"},["157","158","159","160","161","162"],"d28ec3acb281b","konnectAccessToken",{},"The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.\n","http","bearer","JWT","d1dbedfe3d6a7","personalAccessToken",{},"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.\nYou can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'`\n","Token","cd0f7f0ee1553","systemAccountAccessToken",{},"The system account access token is meant for automations and integrations that are not directly associated with a human identity.\nYou can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.\nThe access token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'`\n","de730ac5ea2db","application/json",[],[],{"title":"18","type":"163","description":"164","additionalProperties":false,"required":"165","properties":"166","$schema":"155","x-stoplight":"167"},"e13f8586dd06f","application/problem+json",["168"],[],{"allOf":"169","title":"170","$schema":"155","x-stoplight":"171"},"209370b0b2f79",["172"],[],{"allOf":"173","title":"174","$schema":"155","x-stoplight":"175"},"6af60acfb0f65",["176"],[],{"allOf":"177","title":"178","$schema":"155","x-stoplight":"179"},"ec03b7c351169",["180"],[],{"allOf":"181","title":"182","$schema":"155","x-stoplight":"183"},"da610b9b17976",["184","185"],[],{"allOf":"186","title":"187","$schema":"155","x-stoplight":"188"},"408d2589b252a",["189"],[],{"title":"18","type":"163","description":"164","additionalProperties":false,"required":"190","properties":"191","$schema":"155","x-stoplight":"192"},"string","uuid",["193"],"http://json-schema.org/draft-07/schema#",{"id":"194"},"schema","name","in","required","description","title","object","An entity that implements an API",["195","196","197","198"],{"id":"199","created_at":"200","updated_at":"201","service":"202"},{"id":"203"},{"id":"204","key":"205","value":"206"},["207","208"],"BadRequestError",{"id":"209"},{"id":"210","key":"211","value":"212"},["207","213"],"UnauthorizedError",{"id":"214"},{"id":"215","key":"216","value":"217"},["207","218"],"ForbiddenError",{"id":"219"},{"id":"220","key":"221","value":"222"},["207","223"],"NotFoundError",{"id":"224"},{"id":"225","key":"226","value":"227"},{"id":"228","key":"229","value":"230"},["207","231"],"ConflictError",{"id":"232"},{"id":"233","key":"234","value":"235"},["195"],{"id":"199","created_at":"200","updated_at":"201","service":"202"},{"id":"236"},"9f5061ce-78f6-4452-9108-ad7c02821fd5","a04ea714215ac","service","id","created_at","updated_at",{"type":"152","format":"153","description":"237","readOnly":true,"title":"238","examples":"239"},{"type":"152","format":"240","description":"241","readOnly":true,"title":"242","examples":"243"},{"type":"152","format":"240","description":"244","readOnly":true,"title":"245","examples":"246"},{"title":"247","type":"163","description":"248","additionalProperties":false,"required":"249","properties":"250"},"bc44c3ef48cc7","543c3919e7642","ApiImplementationBadRequestExample",{"status":400,"title":"251","instance":"252","detail":"253","invalid_parameters":"254"},{"type":"163","title":"255","description":"256","required":"257","properties":"258"},{"type":"163","required":"259","properties":"260"},"8760545dffb8d","aea7c6a0a9d5d","ApiUnauthorizedExample",{"status":401,"title":"54","instance":"261","detail":"54"},{"type":"163","properties":"262"},"ffcfce43381c6","a877e36800765","ApiForbiddenExample",{"status":403,"title":"59","instance":"263","detail":"264"},{"type":"163","properties":"265"},"04be40c0018bb","4bc596ebac0fc","ApiNotFoundExample",{"status":404,"title":"64","instance":"266","detail":"64"},{"type":"163","properties":"267"},"3107d64213173","3d90ad025d2ed","ApiImplementationServiceConflictExample",{"status":409,"title":"268","instance":"269","detail":"270"},"eea6947f84690","ApiImplementationCountConflictExample",{"status":409,"title":"268","instance":"269","detail":"271"},{"type":"163","properties":"272"},"cb6cb4cf5e9ac","305ae3f00323f","CreateApiImplementationRequest",{"service":"273"},"df1038364b9e8","Contains a unique identifier used for this resource.","UUID",["274"],"date-time","An ISO-8601 timestamp representation of entity creation date.","CreatedAt",["275"],"An ISO-8601 timestamp representation of entity update date.","UpdatedAt",["275"],"API Implementation Service","A Gateway service that implements an API",["276","196"],{"control_plane_id":"277","id":"278"},"Invalid Request","kong:trace:1433447772874964729","Invalid Parameters",["279"],"Error","standard error",["280","162","281","282"],{"status":"283","title":"284","type":"285","instance":"286","detail":"287"},["288"],{"invalid_parameters":"289"},"kong:trace:8347343766220159418",{"status":"290","title":"291","type":"292","instance":"293","detail":"294"},"kong:trace:2723154947768991354","You do not have permission to perform this action",{"status":"295","title":"296","type":"297","instance":"298","detail":"299"},"kong:trace:6816496025408232265",{"status":"300","title":"301","type":"302","instance":"303","detail":"304"},"Conflict","kong:trace:3169213858331814220","This gateway service is already linked to another API","An implementation already exists for this API",{"status":"305","title":"306","type":"307","instance":"308","detail":"309"},{"control_plane_id":"310","id":"311"},"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","2022-11-04T20:10:06.927Z","control_plane_id",{"type":"152","format":"153","examples":"312"},{"type":"152","format":"153","examples":"313"},{"field":"314","rule":"315","reason":"316"},"status","instance","detail",{"type":"317","description":"318","readOnly":true},{"type":"152","description":"319","readOnly":true},{"type":"152","description":"320","readOnly":true},{"type":"152","description":"321","readOnly":true},{"type":"152","description":"322","readOnly":true},"invalid_parameters",{"type":"323","uniqueItems":true,"minItems":1,"description":"324","items":"325","title":"326","x-stoplight":"327"},{"examples":"328"},{"examples":"329"},{"examples":"330"},{"examples":"331"},{"examples":"332"},{"examples":"333"},{"examples":"334"},{"examples":"335"},{"examples":"336"},{"examples":"337"},{"examples":"338"},{"examples":"339"},{"examples":"340"},{"examples":"341"},{"examples":"342"},{"examples":"343"},{"examples":"344"},{"examples":"345"},{"examples":"346"},{"examples":"347"},"fd4e1b98-3629-4dd3-acc0-759a726ffee2","dd4e1b98-3629-4dd3-acc0-759a726ffee2",["193"],["348"],"service.id","missing_reference","Service not found","integer","The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","The error type.","Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","array","invalid parameters",{"oneOf":"349"},"InvalidParameters",{"explicitProperties":"350"},[401],["351"],["352"],["353"],["354"],[403],["355"],["356"],["353"],["355"],[404],["64"],["357"],["353"],["358"],[409],["268"],["359"],["353"],["268"],"7710d5c4-d902-410b-992f-18b814155b53",["360","361","362","363","364"],["365","366","367","368","161","369","162"],"Unauthorized","https://httpstatuses.com/401","kong:trace:1234567890","Invalid credentials","Forbidden","https://httpstatuses.com/403","https://httpstatuses.com/404","Not found","https://httpstatuses.com/409",{"type":"163","additionalProperties":false,"properties":"370","required":"371","title":"372"},{"type":"163","additionalProperties":false,"properties":"373","required":"374","title":"375"},{"type":"163","additionalProperties":false,"properties":"376","required":"377","title":"378"},{"type":"163","additionalProperties":false,"properties":"379","required":"380","title":"381"},{"type":"163","additionalProperties":false,"properties":"382","required":"383","title":"384"},"type","nullable","uniqueItems","minItems","items",{"field":"385","rule":"386","source":"387","reason":"388"},["389","390"],"InvalidParameterStandard",{"field":"391","rule":"392","minimum":"393","source":"394","reason":"395"},["389","390","396","397"],"InvalidParameterMinimumLength",{"field":"398","rule":"399","maximum":"400","source":"401","reason":"402"},["389","390","396","403"],"InvalidParameterMaximumLength",{"field":"404","rule":"405","reason":"406","choices":"407","source":"408"},["389","390","396","409"],"InvalidParameterChoiceItem",{"field":"410","rule":"411","reason":"412","dependents":"413","source":"414"},["389","396","390","415"],"InvalidParameterDependentItem",{"type":"152","readOnly":true,"examples":"416"},{"description":"417","type":"418","readOnly":true,"enum":"419","title":"420"},{"type":"152","examples":"421"},{"type":"152","readOnly":true,"examples":"422"},"field","reason",{"type":"152","readOnly":true,"examples":"423"},{"description":"417","type":"152","readOnly":true,"enum":"424","x-stoplight":"425"},{"type":"317","examples":"426"},{"type":"152","examples":"427"},{"type":"152","readOnly":true,"examples":"428"},"rule","minimum",{"type":"152","readOnly":true,"examples":"429"},{"description":"417","type":"152","readOnly":true,"enum":"430","x-stoplight":"431"},{"type":"317","examples":"432"},{"type":"152","examples":"433"},{"type":"152","readOnly":true,"examples":"434"},"maximum",{"type":"152","readOnly":true,"examples":"435"},{"description":"417","type":"152","readOnly":true,"enum":"436","x-stoplight":"437"},{"type":"152","readOnly":true,"examples":"438"},{"type":"323","uniqueItems":true,"readOnly":true,"minItems":1,"items":"439","x-stoplight":"440"},{"type":"152","examples":"441"},"choices",{"type":"152","readOnly":true,"examples":"442"},{"description":"417","type":"443","readOnly":true,"enum":"444"},{"type":"152","readOnly":true,"examples":"445"},{"type":"446","uniqueItems":true,"items":"447","readOnly":true},{"type":"152","examples":"448"},"dependents",["158"],"invalid parameters rules",["152","449"],["160","450","451","452","453","454","455","456","457","458","459","460","461","462","315","463","464","465","466","467","468",null],"InvalidRules",["469"],["470"],["158"],["471","472","473","474","475","476","477"],{"explicitProperties":"478"},[8],["469"],["479"],["158"],["480","481","482"],{"explicitProperties":"483"},[8],["469"],["484"],["158"],["485"],{"explicitProperties":"486"},["470"],{},{"explicitProperties":"487"},["469"],["158"],["152","449"],["488",null],["470"],["323","449"],{},["469"],"null","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","body","is a required field","min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min",["161","365","489","366","485"],"must have at least 8 characters","max_length","max_items","max",["161","365","489","366","485"],"must not have more than 8 characters","enum",["161","365","489","366","485"],["365","367","489","366","368","369"],"dependent_fields","readOnly"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiResponseSchema",{"title":"4","type":"6","additionalProperties":false,"properties":"7","required":"8"},"API",[],"object",{"id":"9","name":"10","description":"11","version":"12","deprecated":"13","slug":"14","portals":"15","labels":"16","public_labels":"17","created_at":"18","updated_at":"19"},["20","21","22","23","24","25","26","27","28","29"],{"type":"30","format":"31","example":"32","description":"33","readOnly":true},{"type":"30","maxLength":255,"minLength":1,"description":"34","example":"35"},{"type":"30","description":"36","nullable":true},{"type":"30","maxLength":255,"minLength":1,"description":"37","nullable":true},{"type":"38","default":false,"description":"39"},{"type":"30","pattern":"40","description":"41","example":"42","nullable":true},{"readOnly":true,"type":"43","nullable":false,"uniqueItems":true,"description":"44","items":"45"},{"title":"46","type":"6","example":"47","maxProperties":50,"description":"48","additionalProperties":"49"},{"title":"50","type":"6","example":"51","maxProperties":50,"description":"52","additionalProperties":"53"},{"type":"30","format":"54","example":"55","description":"56","readOnly":true,"title":"57"},{"type":"30","format":"54","example":"55","description":"58","readOnly":true,"title":"59"},"id","name","version","labels","public_labels","deprecated","created_at","updated_at","slug","portals","string","uuid","9f5061ce-78f6-4452-9108-ad7c02821fd5","The API identifier.","The name of your API. The `name + version` combination must be unique for each API you publish.\n","MyAPI","A description of your API. Will be visible on your live Portal.","An optional version for your API. Leave this empty if your API is unversioned.","boolean","Marks this API as deprecated.","^[\\w-]+$","The `slug` is used in generated URLs to provide human readable paths.\n\nDefaults to `slugify(name + version)`\n","my-api-v1","array","The list of portals which this API is published to.",{"type":"6","additionalProperties":false,"required":"60","properties":"61"},"Labels",{"env":"62"},"Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n",{"type":"30","pattern":"63","minLength":1,"maxLength":63},"PublicLabels",{"category":"64"},"Public labels store information about an entity that can be used for filtering a list of objects.\n\nPublic labels are intended to store **PUBLIC** metadata. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n",{"type":"30","pattern":"63","minLength":1,"maxLength":63},"date-time","2022-11-04T20:10:06.927Z","An ISO-8601 timestamp representation of entity creation date.","CreatedAt","An ISO-8601 timestamp representation of entity update date.","UpdatedAt",["20","21","65"],{"id":"66","name":"67","display_name":"68"},"test","^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$","finance","display_name",{"type":"30","format":"31","example":"69","description":"70"},{"type":"30","example":"71","description":"72"},{"type":"30","example":"71","description":"73"},"25a2624c-49fc-4764-99e1-224ed819f200","The portal identifier.","My Portal","The name of the portal, used to distinguish it from other portals.","The display name of the portal. This value will be the portal's `name` in Portal API."]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiDocumentId",{"title":"4","type":"6","format":"7","example":"8","description":"9","readOnly":true},"API Document ID",[],"string","uuid","de5c9818-be5c-42e6-b514-e3d4bc30ddeb","The API document identifier."]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiDocumentContent",{"title":"4","type":"6","description":"7"},"API Document Content",[],"string","Raw markdown content to display in your Portal"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiDocumentTitle",{"title":"4","type":"6","description":"7","example":"8"},"API Document Title",[],"string","The title of the document. Used to populate the `<title>` tag for the page","API Document"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiDocumentStatus",{"type":"6","enum":"7","description":"8","default":"9","title":"4"},"ApiDocumentStatus",[],"string",["10","9"],"If `status=published` the document will be visible in your live portal","unpublished","published"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiDocumentParentDocumentId",{"title":"4","type":"6","format":"7","nullable":true,"description":"8","example":null},"API Document Parent Document ID",[],"string","uuid","API Documents may be rendered as a tree of files.\n\nSpecify the `id` of another API Document as the `parent_document_id` to add some heirarchy do your documents.\n"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiDocumentSlug",{"title":"4","type":"6","pattern":"7","description":"8","example":"9"},"API Document Slug",[],"string","^[\\w-]+$","The `slug` is used in generated URLs to provide human readable paths.\n\nDefaults to `slugify(title)`\n","api-document"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiDocumentSummaryWithChildren",{"title":"4","type":"6","additionalProperties":false,"required":"7","properties":"8"},"API Document Summary",[],"object",["9","10","11","12","13","14","15","16","17"],{"id":"18","title":"19","slug":"20","status":"21","parent_document_id":"22","labels":"23","created_at":"24","updated_at":"25","children":"26"},"id","title","slug","status","parent_document_id","labels","created_at","updated_at","children",{"title":"27","type":"28","format":"29","example":"30","description":"31","readOnly":true},{"title":"32","type":"28","description":"33","example":"34"},{"title":"35","type":"28","pattern":"36","description":"37","example":"38"},{"type":"28","enum":"39","description":"40","default":"41","title":"42"},{"title":"43","type":"28","format":"29","nullable":true,"description":"44","example":null},{"title":"45","type":"6","example":"46","maxProperties":50,"description":"47","additionalProperties":"48"},{"type":"28","format":"49","example":"50","description":"51","readOnly":true,"title":"52"},{"type":"28","format":"49","example":"50","description":"53","readOnly":true,"title":"54"},{"type":"55","items":"3"},"API Document ID","string","uuid","de5c9818-be5c-42e6-b514-e3d4bc30ddeb","The API document identifier.","API Document Title","The title of the document. Used to populate the `<title>` tag for the page","API Document","API Document Slug","^[\\w-]+$","The `slug` is used in generated URLs to provide human readable paths.\n\nDefaults to `slugify(title)`\n","api-document",["56","41"],"If `status=published` the document will be visible in your live portal","unpublished","ApiDocumentStatus","API Document Parent Document ID","API Documents may be rendered as a tree of files.\n\nSpecify the `id` of another API Document as the `parent_document_id` to add some heirarchy do your documents.\n","Labels",{"env":"57"},"Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n",{"type":"28","pattern":"58","minLength":1,"maxLength":63},"date-time","2022-11-04T20:10:06.927Z","An ISO-8601 timestamp representation of entity creation date.","CreatedAt","An ISO-8601 timestamp representation of entity update date.","UpdatedAt","array","published","test","^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiDocument",{"type":"6","title":"4","additionalProperties":false,"properties":"7"},"API Document",[],"object",{"id":"8","content":"9","title":"10","slug":"11","status":"12","parent_document_id":"13","labels":"14","created_at":"15","updated_at":"16"},{"title":"17","type":"18","format":"19","example":"20","description":"21","readOnly":true},{"title":"22","type":"18","description":"23"},{"title":"24","type":"18","description":"25","example":"4"},{"title":"26","type":"18","pattern":"27","description":"28","example":"29"},{"type":"18","enum":"30","description":"31","default":"32","title":"33"},{"title":"34","type":"18","format":"19","nullable":true,"description":"35","example":null},{"title":"36","type":"6","example":"37","maxProperties":50,"description":"38","additionalProperties":"39"},{"type":"18","format":"40","example":"41","description":"42","readOnly":true,"title":"43"},{"type":"18","format":"40","example":"41","description":"44","readOnly":true,"title":"45"},"API Document ID","string","uuid","de5c9818-be5c-42e6-b514-e3d4bc30ddeb","The API document identifier.","API Document Content","Raw markdown content to display in your Portal","API Document Title","The title of the document. Used to populate the `<title>` tag for the page","API Document Slug","^[\\w-]+$","The `slug` is used in generated URLs to provide human readable paths.\n\nDefaults to `slugify(title)`\n","api-document",["46","32"],"If `status=published` the document will be visible in your live portal","unpublished","ApiDocumentStatus","API Document Parent Document ID","API Documents may be rendered as a tree of files.\n\nSpecify the `id` of another API Document as the `parent_document_id` to add some heirarchy do your documents.\n","Labels",{"env":"47"},"Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n",{"type":"18","pattern":"48","minLength":1,"maxLength":63},"date-time","2022-11-04T20:10:06.927Z","An ISO-8601 timestamp representation of entity creation date.","CreatedAt","An ISO-8601 timestamp representation of entity update date.","UpdatedAt","published","test","^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/MoveDocumentRequestPayload",{"type":"6","title":"4","description":"7","properties":"8"},"Move document",[],"object","move document request payload",{"parent_document_id":"9","index":"10"},{"type":"11","format":"12","description":"13","example":"14"},{"type":"15","description":"16","example":1},"string","uuid","parent document id","dd4e1b98-3629-4dd3-acc0-759a726ffee2","integer","index of the document in the parent document's children"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiSpec",{"title":"4","type":"6","additionalProperties":false,"properties":"7"},"API Specification",[],"object",{"id":"8","content":"9","type":"10","created_at":"11","updated_at":"12"},{"type":"13","format":"14","example":"15","description":"16","readOnly":true},{"type":"13","description":"17","example":"18"},{"title":"19","type":"13","example":"20","description":"21","enum":"22"},{"type":"13","format":"23","example":"24","description":"25","readOnly":true,"title":"26"},{"type":"13","format":"23","example":"24","description":"27","readOnly":true,"title":"28"},"string","uuid","7710d5c4-d902-410b-992f-18b814155b53","The API specification identifier.","The raw content of your API specification.\n","{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}","API Spec Type","oas3","The type of specification being stored. This allows us to render the specification correctly.\n\nIf this field is not set, it will be autodetected from `content`\n",["20","29"],"date-time","2022-11-04T20:10:06.927Z","An ISO-8601 timestamp representation of entity creation date.","CreatedAt","An ISO-8601 timestamp representation of entity update date.","UpdatedAt","asyncapi"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiPublicationVisibility",{"title":"4","type":"6","enum":"7","default":"8","description":"9"},"API Publication Visibility",[],"string",["10","8"],"private","The visibility of the API in the portal.\nPublic API publications do not require authentication to view and retrieve information about them.\nPrivate API publications require authentication to retrieve information about them.\n","public"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiPublicationAuthStrategyIds",{"title":"4","type":"6","nullable":true,"description":"7","maxItems":1,"minItems":1,"items":"8"},"API Publication Auth Strategy IDs",[],"array","The auth strategy the API enforces for applications in the portal.\nOmitting this property means the portal's default application auth strategy will be used.\nSetting to null means the API will not require application authentication.\nDCR support for application registration is currently in development.\n",{"type":"9","format":"10"},"string","uuid"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiPublicationListItem",{"title":"4","type":"6","description":"7","additionalProperties":false,"required":"8","properties":"9"},"API Publication List Item",[],"object","An API publication in a portal",["10","11","12","13","14","15"],{"api_id":"16","portal_id":"17","visibility":"18","auth_strategy_ids":"19","created_at":"20","updated_at":"21"},"api_id","portal_id","visibility","created_at","updated_at","auth_strategy_ids",{"type":"22","format":"23","example":"24","description":"25","readOnly":true},{"type":"22","format":"23","example":"26","description":"27","readOnly":true},{"title":"28","type":"22","enum":"29","default":"30","description":"31"},{"title":"32","type":"33","nullable":true,"description":"34","maxItems":1,"minItems":1,"items":"35"},{"type":"22","format":"36","example":"37","description":"38","readOnly":true,"title":"39"},{"type":"22","format":"36","example":"37","description":"40","readOnly":true,"title":"41"},"string","uuid","9f5061ce-78f6-4452-9108-ad7c02821fd5","The API identifier.","7710d5c4-d902-410b-992f-18b814155b53","The portal identifier.","API Publication Visibility",["42","30"],"private","The visibility of the API in the portal.\nPublic API publications do not require authentication to view and retrieve information about them.\nPrivate API publications require authentication to retrieve information about them.\n","API Publication Auth Strategy IDs","array","The auth strategy the API enforces for applications in the portal.\nOmitting this property means the portal's default application auth strategy will be used.\nSetting to null means the API will not require application authentication.\nDCR support for application registration is currently in development.\n",{"type":"22","format":"23"},"date-time","2022-11-04T20:10:06.927Z","An ISO-8601 timestamp representation of entity creation date.","CreatedAt","An ISO-8601 timestamp representation of entity update date.","UpdatedAt","public"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/AutoApproveRegistrations",{"title":"4","description":"6","type":"7"},"Auto Approve Registrations",[],"Whether the application registration auto approval on this portal for the api is enabled. If set to false, fallbacks on portal's auto_approve_applications value.","boolean"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiPublication",{"title":"4","type":"6","description":"7","additionalProperties":false,"properties":"8"},"API Publication",[],"object","An API publication in a portal",{"auto_approve_registrations":"9","auth_strategy_ids":"10","visibility":"11","created_at":"12","updated_at":"13"},{"title":"14","description":"15","type":"16"},{"title":"17","type":"18","nullable":true,"description":"19","maxItems":1,"minItems":1,"items":"20"},{"title":"21","type":"22","enum":"23","default":"24","description":"25"},{"type":"22","format":"26","example":"27","description":"28","readOnly":true,"title":"29"},{"type":"22","format":"26","example":"27","description":"30","readOnly":true,"title":"31"},"Auto Approve Registrations","Whether the application registration auto approval on this portal for the api is enabled. If set to false, fallbacks on portal's auto_approve_applications value.","boolean","API Publication Auth Strategy IDs","array","The auth strategy the API enforces for applications in the portal.\nOmitting this property means the portal's default application auth strategy will be used.\nSetting to null means the API will not require application authentication.\nDCR support for application registration is currently in development.\n",{"type":"22","format":"32"},"API Publication Visibility","string",["33","24"],"private","The visibility of the API in the portal.\nPublic API publications do not require authentication to view and retrieve information about them.\nPrivate API publications require authentication to retrieve information about them.\n","date-time","2022-11-04T20:10:06.927Z","An ISO-8601 timestamp representation of entity creation date.","CreatedAt","An ISO-8601 timestamp representation of entity update date.","UpdatedAt","uuid","public"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiImplementationService",{"title":"4","type":"6","description":"7","additionalProperties":false,"required":"8","properties":"9"},"API Implementation Service",[],"object","A Gateway service that implements an API",["10","11"],{"control_plane_id":"12","id":"13"},"control_plane_id","id",{"type":"14","format":"15","example":"16"},{"type":"14","format":"15","example":"17"},"string","uuid","9f5061ce-78f6-4452-9108-ad7c02821fd5","7710d5c4-d902-410b-992f-18b814155b53"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiImplementationListItem",{"title":"4","type":"6","description":"7","additionalProperties":false,"required":"8","properties":"9"},"API Implementation List Item",[],"object","An entity that implements an API",["10","11","12","13","14"],{"id":"15","created_at":"16","updated_at":"17","api_id":"18","service":"19"},"id","api_id","created_at","updated_at","service",{"type":"20","format":"21","example":"22","description":"23","readOnly":true,"title":"24"},{"type":"20","format":"25","example":"26","description":"27","readOnly":true,"title":"28"},{"type":"20","format":"25","example":"26","description":"29","readOnly":true,"title":"30"},{"type":"20","format":"21","example":"31","description":"32","readOnly":true},{"title":"33","type":"6","description":"34","additionalProperties":false,"required":"35","properties":"36"},"string","uuid","5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","Contains a unique identifier used for this resource.","UUID","date-time","2022-11-04T20:10:06.927Z","An ISO-8601 timestamp representation of entity creation date.","CreatedAt","An ISO-8601 timestamp representation of entity update date.","UpdatedAt","9f5061ce-78f6-4452-9108-ad7c02821fd5","The API identifier.","API Implementation Service","A Gateway service that implements an API",["37","10"],{"control_plane_id":"38","id":"39"},"control_plane_id",{"type":"20","format":"21","example":"31"},{"type":"20","format":"21","example":"40"},"7710d5c4-d902-410b-992f-18b814155b53"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiImplementation",{"title":"4","type":"6","description":"7","additionalProperties":false,"required":"8","properties":"9"},"API Implementation",[],"object","An entity that implements an API",["10"],{"id":"11","created_at":"12","updated_at":"13","service":"14"},"service",{"type":"15","format":"16","example":"17","description":"18","readOnly":true,"title":"19"},{"type":"15","format":"20","example":"21","description":"22","readOnly":true,"title":"23"},{"type":"15","format":"20","example":"21","description":"24","readOnly":true,"title":"25"},{"title":"26","type":"6","description":"27","additionalProperties":false,"required":"28","properties":"29"},"string","uuid","5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","Contains a unique identifier used for this resource.","UUID","date-time","2022-11-04T20:10:06.927Z","An ISO-8601 timestamp representation of entity creation date.","CreatedAt","An ISO-8601 timestamp representation of entity update date.","UpdatedAt","API Implementation Service","A Gateway service that implements an API",["30","31"],{"control_plane_id":"32","id":"33"},"control_plane_id","id",{"type":"15","format":"16","example":"34"},{"type":"15","format":"16","example":"35"},"9f5061ce-78f6-4452-9108-ad7c02821fd5","7710d5c4-d902-410b-992f-18b814155b53"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiDocumentFilterParameters",{"title":"4","type":"6","properties":"7"},"API Document Filter Parameters",[],"object",{"status":"8"},{"title":"9","description":"10","oneOf":"11","x-examples":"12"},"StringFieldFilter","Filters on the given string field value by either exact or fuzzy match.",["13","14","15","16","17"],{"example-1":"18","example-2":"19","example-3":"20","example-4":"21","example-5":"22","example-6":"23"},{"title":"24","description":"25","oneOf":"26","x-examples":"27"},{"title":"28","description":"29","type":"6","additionalProperties":false,"properties":"30","required":"31","x-examples":"32"},{"title":"33","description":"34","type":"6","additionalProperties":false,"properties":"35","required":"36","x-examples":"37"},{"title":"38","description":"39","type":"6","additionalProperties":false,"properties":"40","required":"41","x-examples":"42"},{"title":"43","description":"44","type":"6","additionalProperties":false,"properties":"45","required":"46","x-examples":"47"},"equals-some-value",{"eq":"48"},{"contains":"48"},{"ocontains":"49"},{"oeq":"49"},{"neq":"50"},"StringFieldEqualsFilter","Filters on the given string field value by exact match.",["51","52"],{"example-1":"18","example-2":"53"},"StringFieldContainsFilter","Filters on the given string field value by fuzzy match.",{"contains":"54"},["55"],{"example-1":"56"},"StringFieldOContainsFilter","Returns entities that fuzzy-match any of the comma-delimited phrases in the filter string.",{"ocontains":"57"},["58"],{"example-1":"59"},"StringFieldOEQFilter","Returns entities that exact match any of the comma-delimited phrases in the filter string.",{"oeq":"60"},["61"],{"example-1":"62"},"StringFieldNEQFilter","Filters on the given string field value by exact match inequality.",{"neq":"63"},["64"],{"example-1":"65"},"some-value","some-potential,value","not-this-value",{"type":"66"},{"type":"6","title":"67","additionalProperties":false,"properties":"68","required":"69"},{"eq":"48"},{"type":"66"},"contains",{"contains":"48"},{"type":"66"},"ocontains",{"ocontains":"70"},{"type":"66"},"oeq",{"oeq":"71"},{"type":"66"},"neq",{"neq":"50"},"string","StringFieldEqualsComparison",{"eq":"72"},["73"],"this-value,or-that-value","some-value,some-other-value",{"type":"66"},"eq"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiSpecFilterParameters",{"title":"4","type":"6","properties":"7"},"API Spec Filter Parameters",[],"object",{"type":"8"},{"title":"9","description":"10","oneOf":"11","x-examples":"12"},"StringFieldFilter","Filters on the given string field value by either exact or fuzzy match.",["13","14","15","16","17"],{"example-1":"18","example-2":"19","example-3":"20","example-4":"21","example-5":"22","example-6":"23"},{"title":"24","description":"25","oneOf":"26","x-examples":"27"},{"title":"28","description":"29","type":"6","additionalProperties":false,"properties":"30","required":"31","x-examples":"32"},{"title":"33","description":"34","type":"6","additionalProperties":false,"properties":"35","required":"36","x-examples":"37"},{"title":"38","description":"39","type":"6","additionalProperties":false,"properties":"40","required":"41","x-examples":"42"},{"title":"43","description":"44","type":"6","additionalProperties":false,"properties":"45","required":"46","x-examples":"47"},"equals-some-value",{"eq":"48"},{"contains":"48"},{"ocontains":"49"},{"oeq":"49"},{"neq":"50"},"StringFieldEqualsFilter","Filters on the given string field value by exact match.",["51","52"],{"example-1":"18","example-2":"53"},"StringFieldContainsFilter","Filters on the given string field value by fuzzy match.",{"contains":"54"},["55"],{"example-1":"56"},"StringFieldOContainsFilter","Returns entities that fuzzy-match any of the comma-delimited phrases in the filter string.",{"ocontains":"57"},["58"],{"example-1":"59"},"StringFieldOEQFilter","Returns entities that exact match any of the comma-delimited phrases in the filter string.",{"oeq":"60"},["61"],{"example-1":"62"},"StringFieldNEQFilter","Filters on the given string field value by exact match inequality.",{"neq":"63"},["64"],{"example-1":"65"},"some-value","some-potential,value","not-this-value",{"type":"66"},{"type":"6","title":"67","additionalProperties":false,"properties":"68","required":"69"},{"eq":"48"},{"type":"66"},"contains",{"contains":"48"},{"type":"66"},"ocontains",{"ocontains":"70"},{"type":"66"},"oeq",{"oeq":"71"},{"type":"66"},"neq",{"neq":"50"},"string","StringFieldEqualsComparison",{"eq":"72"},["73"],"this-value,or-that-value","some-value,some-other-value",{"type":"66"},"eq"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiPublicationFilterParameters",{"title":"4","type":"6","properties":"7"},"API Publication Filter Parameters",[],"object",{"portal_id":"8","portal_name":"9","api_id":"8","api_name":"9","auth_strategy_id":"8"},{"title":"10","description":"11","oneOf":"12","x-examples":"13"},{"title":"14","description":"15","oneOf":"16","x-examples":"17"},"UuidFieldFilter","Filters on the given UUID field value by exact match.",["18","19","20"],{"example-1":"21","example-2":"22","example-3":"23","example-4":"24"},"StringFieldFilter","Filters on the given string field value by either exact or fuzzy match.",["18","25","26","19","20"],{"example-1":"27","example-2":"28","example-3":"29","example-4":"30","example-5":"31","example-6":"32"},{"title":"33","description":"34","oneOf":"35","x-examples":"36"},{"title":"37","description":"38","type":"6","additionalProperties":false,"properties":"39","required":"40","x-examples":"41"},{"title":"42","description":"43","type":"6","additionalProperties":false,"properties":"44","required":"45","x-examples":"46"},"3bbfd3a-e9ab-48a9-9881-ed589e4615d1",{"eq":"21"},{"oeq":"21"},{"neq":"21"},{"title":"47","description":"48","type":"6","additionalProperties":false,"properties":"49","required":"50","x-examples":"51"},{"title":"52","description":"53","type":"6","additionalProperties":false,"properties":"54","required":"55","x-examples":"56"},"equals-some-value",{"eq":"57"},{"contains":"57"},{"ocontains":"58"},{"oeq":"58"},{"neq":"59"},"StringFieldEqualsFilter","Filters on the given string field value by exact match.",["60","61"],{"example-1":"27","example-2":"62"},"StringFieldOEQFilter","Returns entities that exact match any of the comma-delimited phrases in the filter string.",{"oeq":"63"},["64"],{"example-1":"65"},"StringFieldNEQFilter","Filters on the given string field value by exact match inequality.",{"neq":"66"},["67"],{"example-1":"68"},"StringFieldContainsFilter","Filters on the given string field value by fuzzy match.",{"contains":"69"},["70"],{"example-1":"71"},"StringFieldOContainsFilter","Returns entities that fuzzy-match any of the comma-delimited phrases in the filter string.",{"ocontains":"72"},["73"],{"example-1":"74"},"some-value","some-potential,value","not-this-value",{"type":"75"},{"type":"6","title":"76","additionalProperties":false,"properties":"77","required":"78"},{"eq":"57"},{"type":"75"},"oeq",{"oeq":"79"},{"type":"75"},"neq",{"neq":"59"},{"type":"75"},"contains",{"contains":"57"},{"type":"75"},"ocontains",{"ocontains":"80"},"string","StringFieldEqualsComparison",{"eq":"81"},["82"],"some-value,some-other-value","this-value,or-that-value",{"type":"75"},"eq"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiImplementationFilterParameters",{"title":"4","type":"6","properties":"7"},"API Implementation Filter Parameters",[],"object",{"id":"8","api_id":"8","service_id":"8","control_plane_id":"8","created_at":"9","updated_at":"9"},{"title":"10","description":"11","oneOf":"12","x-examples":"13"},{"title":"14","description":"15","oneOf":"16","x-examples":"17"},"UuidFieldFilter","Filters on the given UUID field value by exact match.",["18","19","20"],{"example-1":"21","example-2":"22","example-3":"23","example-4":"24"},"DateTimeFieldFilter","Filters on the given datetime (RFC-3339) field value.",["25","26","27","28","29","30"],{"datetime_field_1":"31","datetime_field_2":"32","datetime_field_3":"33","datetime_field_4":"34","datetime_field_5":"35","datetime_field_6":"36"},{"title":"37","description":"38","oneOf":"39","x-examples":"40"},{"title":"41","description":"42","type":"6","additionalProperties":false,"properties":"43","required":"44","x-examples":"45"},{"title":"46","description":"47","type":"6","additionalProperties":false,"properties":"48","required":"49","x-examples":"50"},"3bbfd3a-e9ab-48a9-9881-ed589e4615d1",{"eq":"21"},{"oeq":"21"},{"neq":"21"},{"type":"51","format":"52","description":"53","example":"31"},{"type":"6","title":"54","additionalProperties":false,"properties":"55","required":"56"},{"type":"6","title":"57","additionalProperties":false,"properties":"58","required":"59"},{"type":"6","title":"60","additionalProperties":false,"properties":"61","required":"62"},{"type":"6","title":"63","additionalProperties":false,"properties":"64","required":"65"},{"type":"6","title":"66","additionalProperties":false,"properties":"67","required":"68"},"2022-03-30T07:20:50Z",{"eq":"31"},{"lt":"31"},{"lte":"31"},{"gt":"31"},{"gte":"31"},"StringFieldEqualsFilter","Filters on the given string field value by exact match.",["69","70"],{"example-1":"71","example-2":"72"},"StringFieldOEQFilter","Returns entities that exact match any of the comma-delimited phrases in the filter string.",{"oeq":"73"},["74"],{"example-1":"75"},"StringFieldNEQFilter","Filters on the given string field value by exact match inequality.",{"neq":"76"},["77"],{"example-1":"78"},"string","date-time","Value strictly equals given RFC-3339 formatted timestamp in UTC","DateTimeFieldEqualsFilter",{"eq":"79"},["80"],"DateTimeFieldLTFilter",{"lt":"81"},["82"],"DateTimeFieldLTEFilter",{"lte":"83"},["84"],"DateTimeFieldGTFilter",{"lt":"85"},["86"],"DateTimeFieldGTEFilter",{"lte":"87"},["88"],{"type":"51"},{"type":"6","title":"89","additionalProperties":false,"properties":"90","required":"91"},"equals-some-value",{"eq":"92"},{"type":"51"},"oeq",{"oeq":"93"},{"type":"51"},"neq",{"neq":"94"},{"type":"51","format":"52","description":"53","example":"31"},"eq",{"type":"51","format":"52","description":"95","example":"31"},"lt",{"type":"51","format":"52","description":"96","example":"31"},"lte",{"type":"51","format":"52","description":"97","example":"31"},"gt",{"type":"51","format":"52","description":"98","example":"31"},"gte","StringFieldEqualsComparison",{"eq":"99"},["80"],"some-value","some-value,some-other-value","not-this-value","Value is less than the given RFC-3339 formatted timestamp in UTC","Value is less than or equal to the given RFC-3339 formatted timestamp in UTC","Value is greater than the given RFC-3339 formatted timestamp in UTC","Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC",{"type":"51"}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/StringFieldEqualsFilter",{"title":"4","description":"6","oneOf":"7","x-examples":"8"},"StringFieldEqualsFilter",[],"Filters on the given string field value by exact match.",["9","10"],{"example-1":"11","example-2":"12"},{"type":"13"},{"type":"14","title":"15","additionalProperties":false,"properties":"16","required":"17"},"equals-some-value",{"eq":"18"},"string","object","StringFieldEqualsComparison",{"eq":"19"},["20"],"some-value",{"type":"13"},"eq"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/StringFieldOEQFilter",{"title":"4","description":"6","type":"7","additionalProperties":false,"properties":"8","required":"9","x-examples":"10"},"StringFieldOEQFilter",[],"Returns entities that exact match any of the comma-delimited phrases in the filter string.","object",{"oeq":"11"},["12"],{"example-1":"13"},{"type":"14"},"oeq",{"oeq":"15"},"string","some-value,some-other-value"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/StringFieldNEQFilter",{"title":"4","description":"6","type":"7","additionalProperties":false,"properties":"8","required":"9","x-examples":"10"},"StringFieldNEQFilter",[],"Filters on the given string field value by exact match inequality.","object",{"neq":"11"},["12"],{"example-1":"13"},{"type":"14"},"neq",{"neq":"15"},"string","not-this-value"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/UuidFieldFilter",{"title":"4","description":"6","oneOf":"7","x-examples":"8"},"UuidFieldFilter",[],"Filters on the given UUID field value by exact match.",["9","10","11"],{"example-1":"12","example-2":"13","example-3":"14","example-4":"15"},{"title":"16","description":"17","oneOf":"18","x-examples":"19"},{"title":"20","description":"21","type":"22","additionalProperties":false,"properties":"23","required":"24","x-examples":"25"},{"title":"26","description":"27","type":"22","additionalProperties":false,"properties":"28","required":"29","x-examples":"30"},"3bbfd3a-e9ab-48a9-9881-ed589e4615d1",{"eq":"12"},{"oeq":"12"},{"neq":"12"},"StringFieldEqualsFilter","Filters on the given string field value by exact match.",["31","32"],{"example-1":"33","example-2":"34"},"StringFieldOEQFilter","Returns entities that exact match any of the comma-delimited phrases in the filter string.","object",{"oeq":"35"},["36"],{"example-1":"37"},"StringFieldNEQFilter","Filters on the given string field value by exact match inequality.",{"neq":"38"},["39"],{"example-1":"40"},{"type":"41"},{"type":"22","title":"42","additionalProperties":false,"properties":"43","required":"44"},"equals-some-value",{"eq":"45"},{"type":"41"},"oeq",{"oeq":"46"},{"type":"41"},"neq",{"neq":"47"},"string","StringFieldEqualsComparison",{"eq":"48"},["49"],"some-value","some-value,some-other-value","not-this-value",{"type":"41"},"eq"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/StringFieldContainsFilter",{"title":"4","description":"6","type":"7","additionalProperties":false,"properties":"8","required":"9","x-examples":"10"},"StringFieldContainsFilter",[],"Filters on the given string field value by fuzzy match.","object",{"contains":"11"},["12"],{"example-1":"13"},{"type":"14"},"contains",{"contains":"15"},"string","some-value"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/StringFieldOContainsFilter",{"title":"4","description":"6","type":"7","additionalProperties":false,"properties":"8","required":"9","x-examples":"10"},"StringFieldOContainsFilter",[],"Returns entities that fuzzy-match any of the comma-delimited phrases in the filter string.","object",{"ocontains":"11"},["12"],{"example-1":"13"},{"type":"14"},"ocontains",{"ocontains":"15"},"string","this-value,or-that-value"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/StringFieldFilter",{"title":"4","description":"6","oneOf":"7","x-examples":"8"},"StringFieldFilter",[],"Filters on the given string field value by either exact or fuzzy match.",["9","10","11","12","13"],{"example-1":"14","example-2":"15","example-3":"16","example-4":"17","example-5":"18","example-6":"19"},{"title":"20","description":"21","oneOf":"22","x-examples":"23"},{"title":"24","description":"25","type":"26","additionalProperties":false,"properties":"27","required":"28","x-examples":"29"},{"title":"30","description":"31","type":"26","additionalProperties":false,"properties":"32","required":"33","x-examples":"34"},{"title":"35","description":"36","type":"26","additionalProperties":false,"properties":"37","required":"38","x-examples":"39"},{"title":"40","description":"41","type":"26","additionalProperties":false,"properties":"42","required":"43","x-examples":"44"},"equals-some-value",{"eq":"45"},{"contains":"45"},{"ocontains":"46"},{"oeq":"46"},{"neq":"47"},"StringFieldEqualsFilter","Filters on the given string field value by exact match.",["48","49"],{"example-1":"14","example-2":"50"},"StringFieldContainsFilter","Filters on the given string field value by fuzzy match.","object",{"contains":"51"},["52"],{"example-1":"53"},"StringFieldOContainsFilter","Returns entities that fuzzy-match any of the comma-delimited phrases in the filter string.",{"ocontains":"54"},["55"],{"example-1":"56"},"StringFieldOEQFilter","Returns entities that exact match any of the comma-delimited phrases in the filter string.",{"oeq":"57"},["58"],{"example-1":"59"},"StringFieldNEQFilter","Filters on the given string field value by exact match inequality.",{"neq":"60"},["61"],{"example-1":"62"},"some-value","some-potential,value","not-this-value",{"type":"63"},{"type":"26","title":"64","additionalProperties":false,"properties":"65","required":"66"},{"eq":"45"},{"type":"63"},"contains",{"contains":"45"},{"type":"63"},"ocontains",{"ocontains":"67"},{"type":"63"},"oeq",{"oeq":"68"},{"type":"63"},"neq",{"neq":"47"},"string","StringFieldEqualsComparison",{"eq":"69"},["70"],"this-value,or-that-value","some-value,some-other-value",{"type":"63"},"eq"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/LabelsFieldFilter",{"allOf":"6","title":"4"},"LabelsFieldFilter",[],["7","8"],{"title":"4","description":"9"},{"title":"10","description":"11","oneOf":"12","x-examples":"13"},"Filters on the resource's `labels` field. Filters must use dot-notation to identify\nthe label key that will be used to filter the results. For example:\n - `filter[labels.owner]`\n - `filter[labels.owner][neq]=kong`\n - `filter[labels.env]=dev`\n - `filter[labels.env][ocontains]=dev,test`\n","StringFieldFilter","Filters on the given string field value by either exact or fuzzy match.",["14","15","16","17","18"],{"example-1":"19","example-2":"20","example-3":"21","example-4":"22","example-5":"23","example-6":"24"},{"title":"25","description":"26","oneOf":"27","x-examples":"28"},{"title":"29","description":"30","type":"31","additionalProperties":false,"properties":"32","required":"33","x-examples":"34"},{"title":"35","description":"36","type":"31","additionalProperties":false,"properties":"37","required":"38","x-examples":"39"},{"title":"40","description":"41","type":"31","additionalProperties":false,"properties":"42","required":"43","x-examples":"44"},{"title":"45","description":"46","type":"31","additionalProperties":false,"properties":"47","required":"48","x-examples":"49"},"equals-some-value",{"eq":"50"},{"contains":"50"},{"ocontains":"51"},{"oeq":"51"},{"neq":"52"},"StringFieldEqualsFilter","Filters on the given string field value by exact match.",["53","54"],{"example-1":"19","example-2":"55"},"StringFieldContainsFilter","Filters on the given string field value by fuzzy match.","object",{"contains":"56"},["57"],{"example-1":"58"},"StringFieldOContainsFilter","Returns entities that fuzzy-match any of the comma-delimited phrases in the filter string.",{"ocontains":"59"},["60"],{"example-1":"61"},"StringFieldOEQFilter","Returns entities that exact match any of the comma-delimited phrases in the filter string.",{"oeq":"62"},["63"],{"example-1":"64"},"StringFieldNEQFilter","Filters on the given string field value by exact match inequality.",{"neq":"65"},["66"],{"example-1":"67"},"some-value","some-potential,value","not-this-value",{"type":"68"},{"type":"31","title":"69","additionalProperties":false,"properties":"70","required":"71"},{"eq":"50"},{"type":"68"},"contains",{"contains":"50"},{"type":"68"},"ocontains",{"ocontains":"72"},{"type":"68"},"oeq",{"oeq":"73"},{"type":"68"},"neq",{"neq":"52"},"string","StringFieldEqualsComparison",{"eq":"74"},["75"],"this-value,or-that-value","some-value,some-other-value",{"type":"68"},"eq"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/PublicLabelsFieldFilter",{"title":"4","description":"6","oneOf":"7","x-examples":"8"},"StringFieldFilter",[],"Filters on the given string field value by either exact or fuzzy match.",["9","10","11","12","13"],{"example-1":"14","example-2":"15","example-3":"16","example-4":"17","example-5":"18","example-6":"19"},{"title":"20","description":"21","oneOf":"22","x-examples":"23"},{"title":"24","description":"25","type":"26","additionalProperties":false,"properties":"27","required":"28","x-examples":"29"},{"title":"30","description":"31","type":"26","additionalProperties":false,"properties":"32","required":"33","x-examples":"34"},{"title":"35","description":"36","type":"26","additionalProperties":false,"properties":"37","required":"38","x-examples":"39"},{"title":"40","description":"41","type":"26","additionalProperties":false,"properties":"42","required":"43","x-examples":"44"},"equals-some-value",{"eq":"45"},{"contains":"45"},{"ocontains":"46"},{"oeq":"46"},{"neq":"47"},"StringFieldEqualsFilter","Filters on the given string field value by exact match.",["48","49"],{"example-1":"14","example-2":"50"},"StringFieldContainsFilter","Filters on the given string field value by fuzzy match.","object",{"contains":"51"},["52"],{"example-1":"53"},"StringFieldOContainsFilter","Returns entities that fuzzy-match any of the comma-delimited phrases in the filter string.",{"ocontains":"54"},["55"],{"example-1":"56"},"StringFieldOEQFilter","Returns entities that exact match any of the comma-delimited phrases in the filter string.",{"oeq":"57"},["58"],{"example-1":"59"},"StringFieldNEQFilter","Filters on the given string field value by exact match inequality.",{"neq":"60"},["61"],{"example-1":"62"},"some-value","some-potential,value","not-this-value",{"type":"63"},{"type":"26","title":"64","additionalProperties":false,"properties":"65","required":"66"},{"eq":"45"},{"type":"63"},"contains",{"contains":"45"},{"type":"63"},"ocontains",{"ocontains":"67"},{"type":"63"},"oeq",{"oeq":"68"},{"type":"63"},"neq",{"neq":"47"},"string","StringFieldEqualsComparison",{"eq":"69"},["70"],"this-value,or-that-value","some-value,some-other-value",{"type":"63"},"eq"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/BooleanFieldFilter",{"title":"4","description":"6","type":"7","x-examples":"8"},"BooleanFieldFilter",[],"Filter by a boolean value (true/false).","boolean",{"example-1":true}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/DateTimeFieldFilter",{"title":"4","description":"6","oneOf":"7","x-examples":"8"},"DateTimeFieldFilter",[],"Filters on the given datetime (RFC-3339) field value.",["9","10","11","12","13","14"],{"datetime_field_1":"15","datetime_field_2":"16","datetime_field_3":"17","datetime_field_4":"18","datetime_field_5":"19","datetime_field_6":"20"},{"type":"21","format":"22","description":"23","example":"15"},{"type":"24","title":"25","additionalProperties":false,"properties":"26","required":"27"},{"type":"24","title":"28","additionalProperties":false,"properties":"29","required":"30"},{"type":"24","title":"31","additionalProperties":false,"properties":"32","required":"33"},{"type":"24","title":"34","additionalProperties":false,"properties":"35","required":"36"},{"type":"24","title":"37","additionalProperties":false,"properties":"38","required":"39"},"2022-03-30T07:20:50Z",{"eq":"15"},{"lt":"15"},{"lte":"15"},{"gt":"15"},{"gte":"15"},"string","date-time","Value strictly equals given RFC-3339 formatted timestamp in UTC","object","DateTimeFieldEqualsFilter",{"eq":"40"},["41"],"DateTimeFieldLTFilter",{"lt":"42"},["43"],"DateTimeFieldLTEFilter",{"lte":"44"},["45"],"DateTimeFieldGTFilter",{"lt":"46"},["47"],"DateTimeFieldGTEFilter",{"lte":"48"},["49"],{"type":"21","format":"22","description":"23","example":"15"},"eq",{"type":"21","format":"22","description":"50","example":"15"},"lt",{"type":"21","format":"22","description":"51","example":"15"},"lte",{"type":"21","format":"22","description":"52","example":"15"},"gt",{"type":"21","format":"22","description":"53","example":"15"},"gte","Value is less than the given RFC-3339 formatted timestamp in UTC","Value is less than or equal to the given RFC-3339 formatted timestamp in UTC","Value is greater than the given RFC-3339 formatted timestamp in UTC","Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/SortQuery",{"title":"4","type":"6","example":"7","description":"8"},"SortQuery",[],"string","name,created_at desc","The `asc` suffix is optional as the default sort order is ascending.\nThe `desc` suffix is used to specify a descending order.\nMultiple sort attributes may be provided via a comma separated list.\nJSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').\n"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/PageMeta",{"type":"6","description":"7","required":"8","properties":"9","title":"4"},"PageMeta",[],"object","Contains pagination query parameters and the total number of objects returned.",["10","11","12"],{"number":"13","size":"14","total":"15"},"number","size","total",{"type":"10","example":1},{"type":"10","example":10},{"type":"10","example":100}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/PaginatedMeta",{"type":"6","title":"4","description":"7","properties":"8","required":"9"},"PaginatedMeta",[],"object","returns the pagination information",{"page":"10"},["11"],{"type":"6","description":"12","required":"13","properties":"14","title":"15"},"page","Contains pagination query parameters and the total number of objects returned.",["16","17","18"],{"number":"19","size":"20","total":"21"},"PageMeta","number","size","total",{"type":"16","example":1},{"type":"16","example":10},{"type":"16","example":100}]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/Labels",{"title":"4","type":"6","example":"7","maxProperties":50,"description":"8","additionalProperties":"9"},"Labels",[],"object",{"env":"10"},"Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n",{"type":"11","pattern":"12","minLength":1,"maxLength":63},"test","string","^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/PublicLabels",{"title":"4","type":"6","example":"7","maxProperties":50,"description":"8","additionalProperties":"9"},"PublicLabels",[],"object",{"category":"10"},"Public labels store information about an entity that can be used for filtering a list of objects.\n\nPublic labels are intended to store **PUBLIC** metadata. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n",{"type":"11","pattern":"12","minLength":1,"maxLength":63},"finance","string","^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/CreatedAt",{"type":"6","format":"7","example":"8","description":"9","readOnly":true,"title":"4"},"CreatedAt",[],"string","date-time","2022-11-04T20:10:06.927Z","An ISO-8601 timestamp representation of entity creation date."]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/UpdatedAt",{"type":"6","format":"7","example":"8","description":"9","readOnly":true,"title":"4"},"UpdatedAt",[],"string","date-time","2022-11-04T20:10:06.927Z","An ISO-8601 timestamp representation of entity update date."]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/BaseError",{"type":"6","title":"4","description":"7","required":"8","properties":"9"},"Error",[],"object","standard error",["10","11","12","13"],{"status":"14","title":"15","type":"16","instance":"17","detail":"18"},"status","title","instance","detail",{"type":"19","description":"20","readOnly":true},{"type":"21","description":"22","readOnly":true},{"type":"21","description":"23","readOnly":true},{"type":"21","description":"24","readOnly":true},{"type":"21","description":"25","readOnly":true},"integer","The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","string","A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","The error type.","Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/InvalidRules",{"description":"6","type":"7","readOnly":true,"nullable":true,"enum":"8","title":"4"},"InvalidRules",[],"invalid parameters rules","string",["9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29"],"required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/InvalidParameterStandard",{"type":"6","additionalProperties":false,"properties":"7","required":"8","title":"4"},"InvalidParameterStandard",[],"object",{"field":"9","rule":"10","source":"11","reason":"12"},["13","14"],{"type":"15","example":"16","readOnly":true},{"description":"17","type":"15","readOnly":true,"nullable":true,"enum":"18","title":"19"},{"type":"15","example":"20"},{"type":"15","example":"21","readOnly":true},"field","reason","string","name","invalid parameters rules",["22","23","24","25","26","27","28","29","30","31","32","33","34","35","36","37","38","39","40","41","42"],"InvalidRules","body","is a required field","required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/InvalidParameterMinimumLength",{"type":"6","additionalProperties":false,"properties":"7","required":"8","title":"4"},"InvalidParameterMinimumLength",[],"object",{"field":"9","rule":"10","minimum":"11","source":"12","reason":"13"},["14","15","16","17"],{"type":"18","example":"19","readOnly":true},{"description":"20","type":"18","readOnly":true,"nullable":false,"enum":"21"},{"type":"22","example":8},{"type":"18","example":"23"},{"type":"18","example":"24","readOnly":true},"field","reason","rule","minimum","string","name","invalid parameters rules",["25","26","27","28","29","30","31"],"integer","body","must have at least 8 characters","min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/InvalidParameterMaximumLength",{"type":"6","additionalProperties":false,"properties":"7","required":"8","title":"4"},"InvalidParameterMaximumLength",[],"object",{"field":"9","rule":"10","maximum":"11","source":"12","reason":"13"},["14","15","16","17"],{"type":"18","example":"19","readOnly":true},{"description":"20","type":"18","readOnly":true,"nullable":false,"enum":"21"},{"type":"22","example":8},{"type":"18","example":"23"},{"type":"18","example":"24","readOnly":true},"field","reason","rule","maximum","string","name","invalid parameters rules",["25","26","27"],"integer","body","must not have more than 8 characters","max_length","max_items","max"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/InvalidParameterChoiceItem",{"type":"6","additionalProperties":false,"properties":"7","required":"8","title":"4"},"InvalidParameterChoiceItem",[],"object",{"field":"9","rule":"10","reason":"11","choices":"12","source":"13"},["14","15","16","17"],{"type":"18","example":"19","readOnly":true},{"description":"20","type":"18","readOnly":true,"nullable":false,"enum":"21"},{"type":"18","example":"22","readOnly":true},{"type":"23","uniqueItems":true,"readOnly":true,"nullable":false,"minItems":1,"items":"24"},{"type":"18","example":"25"},"field","reason","rule","choices","string","name","invalid parameters rules",["26"],"is a required field","array",{},"body","enum"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/InvalidParameterDependentItem",{"type":"6","additionalProperties":false,"properties":"7","required":"8","title":"4"},"InvalidParameterDependentItem",[],"object",{"field":"9","rule":"10","reason":"11","dependents":"12","source":"13"},["14","15","16","17"],{"type":"18","example":"19","readOnly":true},{"description":"20","type":"18","readOnly":true,"nullable":true,"enum":"21"},{"type":"18","example":"22","readOnly":true},{"type":"23","uniqueItems":true,"nullable":true,"items":"24","readOnly":true},{"type":"18","example":"25"},"field","rule","reason","dependents","string","name","invalid parameters rules",["26"],"is a required field","array",{},"body","dependent_fields"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/InvalidParameters",{"type":"6","nullable":false,"uniqueItems":true,"minItems":1,"description":"7","items":"8","title":"4"},"InvalidParameters",[],"array","invalid parameters",{"oneOf":"9"},["10","11","12","13","14"],{"type":"15","additionalProperties":false,"properties":"16","required":"17","title":"18"},{"type":"15","additionalProperties":false,"properties":"19","required":"20","title":"21"},{"type":"15","additionalProperties":false,"properties":"22","required":"23","title":"24"},{"type":"15","additionalProperties":false,"properties":"25","required":"26","title":"27"},{"type":"15","additionalProperties":false,"properties":"28","required":"29","title":"30"},"object",{"field":"31","rule":"32","source":"33","reason":"34"},["35","36"],"InvalidParameterStandard",{"field":"37","rule":"38","minimum":"39","source":"40","reason":"41"},["35","36","42","43"],"InvalidParameterMinimumLength",{"field":"44","rule":"45","maximum":"46","source":"47","reason":"48"},["35","36","42","49"],"InvalidParameterMaximumLength",{"field":"50","rule":"51","reason":"52","choices":"53","source":"54"},["35","36","42","55"],"InvalidParameterChoiceItem",{"field":"56","rule":"57","reason":"58","dependents":"59","source":"60"},["35","42","36","61"],"InvalidParameterDependentItem",{"type":"62","example":"63","readOnly":true},{"description":"64","type":"62","readOnly":true,"nullable":true,"enum":"65","title":"66"},{"type":"62","example":"67"},{"type":"62","example":"68","readOnly":true},"field","reason",{"type":"62","example":"63","readOnly":true},{"description":"64","type":"62","readOnly":true,"nullable":false,"enum":"69"},{"type":"70","example":8},{"type":"62","example":"67"},{"type":"62","example":"71","readOnly":true},"rule","minimum",{"type":"62","example":"63","readOnly":true},{"description":"64","type":"62","readOnly":true,"nullable":false,"enum":"72"},{"type":"70","example":8},{"type":"62","example":"67"},{"type":"62","example":"73","readOnly":true},"maximum",{"type":"62","example":"63","readOnly":true},{"description":"64","type":"62","readOnly":true,"nullable":false,"enum":"74"},{"type":"62","example":"68","readOnly":true},{"type":"6","uniqueItems":true,"readOnly":true,"nullable":false,"minItems":1,"items":"75"},{"type":"62","example":"67"},"choices",{"type":"62","example":"63","readOnly":true},{"description":"64","type":"62","readOnly":true,"nullable":true,"enum":"76"},{"type":"62","example":"68","readOnly":true},{"type":"6","uniqueItems":true,"nullable":true,"items":"77","readOnly":true},{"type":"62","example":"67"},"dependents","string","name","invalid parameters rules",["78","79","80","81","82","83","84","85","86","87","88","89","90","91","92","93","94","95","96","97","98"],"InvalidRules","body","is a required field",["99","100","101","102","103","104","105"],"integer","must have at least 8 characters",["106","107","108"],"must not have more than 8 characters",["109"],{},["110"],{},"required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min","max_length","max_items","max","enum","dependent_fields"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/BadRequestError",{"allOf":"6","title":"4"},"BadRequestError",[],["7","8"],{"type":"9","title":"10","description":"11","required":"12","properties":"13"},{"type":"9","required":"14","properties":"15"},"object","Error","standard error",["16","17","18","19"],{"status":"20","title":"21","type":"22","instance":"23","detail":"24"},["25"],{"invalid_parameters":"26"},"status","title","instance","detail",{"type":"27","description":"28","readOnly":true},{"type":"29","description":"30","readOnly":true},{"type":"29","description":"31","readOnly":true},{"type":"29","description":"32","readOnly":true},{"type":"29","description":"33","readOnly":true},"invalid_parameters",{"type":"34","nullable":false,"uniqueItems":true,"minItems":1,"description":"35","items":"36","title":"37"},"integer","The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","string","A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","The error type.","Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","array","invalid parameters",{"oneOf":"38"},"InvalidParameters",["39","40","41","42","43"],{"type":"9","additionalProperties":false,"properties":"44","required":"45","title":"46"},{"type":"9","additionalProperties":false,"properties":"47","required":"48","title":"49"},{"type":"9","additionalProperties":false,"properties":"50","required":"51","title":"52"},{"type":"9","additionalProperties":false,"properties":"53","required":"54","title":"55"},{"type":"9","additionalProperties":false,"properties":"56","required":"57","title":"58"},{"field":"59","rule":"60","source":"61","reason":"62"},["63","64"],"InvalidParameterStandard",{"field":"65","rule":"66","minimum":"67","source":"68","reason":"69"},["63","64","70","71"],"InvalidParameterMinimumLength",{"field":"72","rule":"73","maximum":"74","source":"75","reason":"76"},["63","64","70","77"],"InvalidParameterMaximumLength",{"field":"78","rule":"79","reason":"80","choices":"81","source":"82"},["63","64","70","83"],"InvalidParameterChoiceItem",{"field":"84","rule":"85","reason":"86","dependents":"87","source":"88"},["63","70","64","89"],"InvalidParameterDependentItem",{"type":"29","example":"90","readOnly":true},{"description":"91","type":"29","readOnly":true,"nullable":true,"enum":"92","title":"93"},{"type":"29","example":"94"},{"type":"29","example":"95","readOnly":true},"field","reason",{"type":"29","example":"90","readOnly":true},{"description":"91","type":"29","readOnly":true,"nullable":false,"enum":"96"},{"type":"27","example":8},{"type":"29","example":"94"},{"type":"29","example":"97","readOnly":true},"rule","minimum",{"type":"29","example":"90","readOnly":true},{"description":"91","type":"29","readOnly":true,"nullable":false,"enum":"98"},{"type":"27","example":8},{"type":"29","example":"94"},{"type":"29","example":"99","readOnly":true},"maximum",{"type":"29","example":"90","readOnly":true},{"description":"91","type":"29","readOnly":true,"nullable":false,"enum":"100"},{"type":"29","example":"95","readOnly":true},{"type":"34","uniqueItems":true,"readOnly":true,"nullable":false,"minItems":1,"items":"101"},{"type":"29","example":"94"},"choices",{"type":"29","example":"90","readOnly":true},{"description":"91","type":"29","readOnly":true,"nullable":true,"enum":"102"},{"type":"29","example":"95","readOnly":true},{"type":"34","uniqueItems":true,"nullable":true,"items":"103","readOnly":true},{"type":"29","example":"94"},"dependents","name","invalid parameters rules",["104","105","106","107","108","109","110","111","112","113","114","115","116","117","118","119","120","121","122","123","124"],"InvalidRules","body","is a required field",["125","126","127","128","129","130","131"],"must have at least 8 characters",["132","133","134"],"must not have more than 8 characters",["135"],{},["136"],{},"required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min","max_length","max_items","max","enum","dependent_fields"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/UnauthorizedError",{"allOf":"6","title":"4"},"UnauthorizedError",[],["7","8"],{"type":"9","title":"10","description":"11","required":"12","properties":"13"},{"type":"9","properties":"14"},"object","Error","standard error",["15","16","17","18"],{"status":"19","title":"20","type":"21","instance":"22","detail":"23"},{"status":"24","title":"25","type":"26","instance":"27","detail":"28"},"status","title","instance","detail",{"type":"29","description":"30","readOnly":true},{"type":"31","description":"32","readOnly":true},{"type":"31","description":"33","readOnly":true},{"type":"31","description":"34","readOnly":true},{"type":"31","description":"35","readOnly":true},{"example":401},{"example":"36"},{"example":"37"},{"example":"38"},{"example":"39"},"integer","The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","string","A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","The error type.","Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","Unauthorized","https://httpstatuses.com/401","kong:trace:1234567890","Invalid credentials"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ForbiddenError",{"allOf":"6","title":"4"},"ForbiddenError",[],["7","8"],{"type":"9","title":"10","description":"11","required":"12","properties":"13"},{"type":"9","properties":"14"},"object","Error","standard error",["15","16","17","18"],{"status":"19","title":"20","type":"21","instance":"22","detail":"23"},{"status":"24","title":"25","type":"26","instance":"27","detail":"28"},"status","title","instance","detail",{"type":"29","description":"30","readOnly":true},{"type":"31","description":"32","readOnly":true},{"type":"31","description":"33","readOnly":true},{"type":"31","description":"34","readOnly":true},{"type":"31","description":"35","readOnly":true},{"example":403},{"example":"36"},{"example":"37"},{"example":"38"},{"example":"36"},"integer","The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","string","A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","The error type.","Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","Forbidden","https://httpstatuses.com/403","kong:trace:1234567890"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/NotFoundError",{"allOf":"6","title":"4"},"NotFoundError",[],["7","8"],{"type":"9","title":"10","description":"11","required":"12","properties":"13"},{"type":"9","properties":"14"},"object","Error","standard error",["15","16","17","18"],{"status":"19","title":"20","type":"21","instance":"22","detail":"23"},{"status":"24","title":"25","type":"26","instance":"27","detail":"28"},"status","title","instance","detail",{"type":"29","description":"30","readOnly":true},{"type":"31","description":"32","readOnly":true},{"type":"31","description":"33","readOnly":true},{"type":"31","description":"34","readOnly":true},{"type":"31","description":"35","readOnly":true},{"example":404},{"example":"36"},{"example":"37"},{"example":"38"},{"example":"39"},"integer","The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","string","A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","The error type.","Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","Not Found","https://httpstatuses.com/404","kong:trace:1234567890","Not found"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/UnsupportedMediaTypeError",{"allOf":"6","title":"4"},"UnsupportedMediaTypeError",[],["7","8"],{"type":"9","title":"10","description":"11","required":"12","properties":"13"},{"type":"9","properties":"14"},"object","Error","standard error",["15","16","17","18"],{"status":"19","title":"20","type":"21","instance":"22","detail":"23"},{"status":"24","title":"25","type":"26","instance":"27","detail":"28"},"status","title","instance","detail",{"type":"29","description":"30","readOnly":true},{"type":"31","description":"32","readOnly":true},{"type":"31","description":"33","readOnly":true},{"type":"31","description":"34","readOnly":true},{"type":"31","description":"35","readOnly":true},{"example":415},{"example":"36"},{"example":"37"},{"example":"38"},{"example":"36"},"integer","The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","string","A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","The error type.","Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","UnsupportedMediaType","https://httpstatuses.com/415","kong:trace:1234567890"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/LabelsUpdate",{"type":"6","nullable":true,"description":"7","example":"8","maxProperties":50,"additionalProperties":"9","writeOnly":true,"title":"4"},"LabelsUpdate",[],"object","Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nLabels are intended to store **INTERNAL** metadata.\n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n",{"env":"10"},{"type":"11","pattern":"12","minLength":1,"maxLength":63,"nullable":true},"test","string","^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/PublicLabelsUpdate",{"title":"4","type":"6","example":"7","maxProperties":50,"description":"8","additionalProperties":"9","writeOnly":true},"PublicLabelsUpdate",[],"object",{"category":"10"},"Public labels store information about an entity that can be used for filtering a list of objects.\n\nPublic labels are intended to store **PUBLIC** metadata.\n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n",{"type":"11","pattern":"12","minLength":1,"maxLength":63,"nullable":true},"finance","string","^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ConflictError",{"allOf":"6","title":"4"},"ConflictError",[],["7","8"],{"type":"9","title":"10","description":"11","required":"12","properties":"13"},{"type":"9","properties":"14"},"object","Error","standard error",["15","16","17","18"],{"status":"19","title":"20","type":"21","instance":"22","detail":"23"},{"status":"24","title":"25","type":"26","instance":"27","detail":"28"},"status","title","instance","detail",{"type":"29","description":"30","readOnly":true},{"type":"31","description":"32","readOnly":true},{"type":"31","description":"33","readOnly":true},{"type":"31","description":"34","readOnly":true},{"type":"31","description":"35","readOnly":true},{"example":409},{"example":"36"},{"example":"37"},{"example":"38"},{"example":"36"},"integer","The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","string","A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","The error type.","Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","Conflict","https://httpstatuses.com/409","kong:trace:1234567890"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/ApiSpecType",{"title":"4","type":"6","example":"7","description":"8","enum":"9"},"API Spec Type",[],"string","oas3","The type of specification being stored. This allows us to render the specification correctly.\n\nIf this field is not set, it will be autodetected from `content`\n",["7","10"],"asyncapi"]

[{"type":"1","uri":"2","data":"3","name":"4","tags":"5"},"model","/schemas/UUID",{"type":"6","format":"7","example":"8","description":"9","readOnly":true,"title":"4"},"UUID",[],"string","uuid","5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","Contains a unique identifier used for this resource."]