---
title: "Konnect API Catalog"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-dev-3/versions/b2fc1681-05e8-4b55-9b8c-8bbcc7654d1b"
---

# Konnect API Catalog

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Konnect API Catalog","version":"3.1.2","description":"The management API for creating, managing APIs in the Konnect API Catalog, and publishing APIs in Dev Portals.","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"servers":[{"url":"https://us.api.konghq.com/v3","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v3","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v3","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v3","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v3","description":"India Production region"},{"url":"https://sg.api.konghq.com/v3","description":"Singapore Production region"}],"paths":{"/apis":{"post":{"operationId":"create-api","summary":"Create API","description":"Creates an API.","requestBody":{"$ref":"#/components/requestBodies/CreateApiRequest"},"responses":{"201":{"$ref":"#/components/responses/ApiResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiNameBadRequestExample":{"$ref":"#/components/examples/ApiNameBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"tags":["API"]},"get":{"operationId":"list-apis","summary":"List APIs","description":"Returns a collection of all APIs.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ApiFilters"},{"$ref":"#/components/parameters/ApiSort"}],"responses":{"200":{"$ref":"#/components/responses/ListApiResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"InvalidApiSortQueryBadRequestExample":{"$ref":"#/components/examples/InvalidApiSortQueryNameBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API"]}},"/apis/{apiId}":{"parameters":[{"name":"apiId","in":"path","description":"The UUID API identifier","required":true,"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"}}],"get":{"operationId":"fetch-api","summary":"Get an API","description":"Get an API.","responses":{"200":{"$ref":"#/components/responses/ApiResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API"]},"patch":{"operationId":"update-api","summary":"Update API","description":"Updates an API.","parameters":[{"name":"force","in":"query","description":"If true, allows operations to be removed from the current version when using access control enforcement.\nIf false, operations removal will be rejected with a 409 error.\nOmitting the value means true.\n","schema":{"type":"string","default":"false","enum":["true","false"]}}],"requestBody":{"$ref":"#/components/requestBodies/UpdateApiRequest"},"responses":{"200":{"$ref":"#/components/responses/ApiResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiNameBadRequestExample":{"$ref":"#/components/examples/ApiNameBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/ApiVersionPatchConflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"tags":["API"]}},"/apis/_computed":{"get":{"operationId":"list-apis-computed","summary":"List APIs computed","description":"Returns a collection of all APIs with computed fields.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ApiFilters"},{"$ref":"#/components/parameters/ApiSort"}],"responses":{"200":{"$ref":"#/components/responses/ListApiComputedResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"InvalidApiSortQueryBadRequestExample":{"$ref":"#/components/examples/InvalidApiSortQueryNameBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API"]}},"/apis/{apiId}/versions":{"parameters":[{"$ref":"#/components/parameters/ApiId"}],"post":{"operationId":"create-api-version","summary":"Create API Version","description":"Creates a version (OpenAPI or AsyncAPI) for an API.\n","requestBody":{"$ref":"#/components/requestBodies/CreateApiVersionRequest"},"responses":{"201":{"$ref":"#/components/responses/ApiVersionResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiVersionBadRequestExample":{"$ref":"#/components/examples/ApiVersionBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/ApiSpecConflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"tags":["API Version"]},"get":{"operationId":"list-api-versions","summary":"List API Versions","description":"Returns a list of versions for an API. The version can be of type OpenAPI or AsyncAPI.\n**Note:** You can only have one version for an API.\n","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ApiVersionFilters"},{"$ref":"#/components/parameters/ApiVersionSort"}],"responses":{"200":{"$ref":"#/components/responses/ListApiVersionResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Version"]}},"/apis/{apiId}/versions/{versionId}":{"parameters":[{"$ref":"#/components/parameters/ApiId"},{"$ref":"#/components/parameters/VersionId"}],"get":{"operationId":"fetch-api-version","summary":"Get an API Version","description":"Fetches the version (OpenAPI or AsyncAPI) of an API.","responses":{"200":{"$ref":"#/components/responses/ApiVersionResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Version"]},"patch":{"operationId":"update-api-version","summary":"Update API Version","description":"Updates the version (OpenAPI or AsyncAPI) of an API.","parameters":[{"name":"force","in":"query","description":"If true, allows operations to be removed from the current version when using access control enforcement.\nIf false, operations removal will be rejected with a 409 error.\nOmitting the value (i.e., setting `?force`) means true.\n","schema":{"type":"string","default":"false","enum":["true","false"]}}],"requestBody":{"$ref":"#/components/requestBodies/UpdateApiVersionRequest"},"responses":{"200":{"$ref":"#/components/responses/ApiVersionResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"ApiVersionBadRequestExample":{"$ref":"#/components/examples/ApiVersionBadRequestExample"}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"},"409":{"$ref":"#/components/responses/ApiVersionPatchConflict"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"tags":["API Version"]}},"/apis/{apiId}/images/{imageType}":{"parameters":[{"$ref":"#/components/parameters/ApiId"},{"$ref":"#/components/parameters/ImageType"}],"put":{"operationId":"upsert-api-image","summary":"Create or Replace an API Image","description":"Create or Replace an API Image. The replacement image is not applied to the API until asynchronous validation completes successfully.","requestBody":{"$ref":"#/components/requestBodies/ReplaceApiImageRequest"},"responses":{"200":{"$ref":"#/components/responses/ApiImageResponse"},"201":{"$ref":"#/components/responses/ApiImageResponse"},"401":{"$ref":"#/components/responses/ApiImageUnauthorized"},"403":{"$ref":"#/components/responses/ApiImageForbidden"},"404":{"$ref":"#/components/responses/ApiImageNotFound"},"409":{"$ref":"#/components/responses/ApiImageConflict"}},"tags":["API Image"]},"get":{"operationId":"fetch-api-image","summary":"Get an API Image Status","description":"Retrieves the image status of an API. Returns the latest image if it has not yet been applied (status: uploading, validating, or invalid), otherwise returns the currently applied image (status: valid).","responses":{"200":{"$ref":"#/components/responses/ApiImageResponse"},"401":{"$ref":"#/components/responses/ApiImageUnauthorized"},"403":{"$ref":"#/components/responses/ApiImageForbidden"},"404":{"$ref":"#/components/responses/ApiImageNotFound"}},"tags":["API Image"]},"delete":{"operationId":"delete-api-image","summary":"Delete an API Image","description":"Delete an API Image.","responses":{"204":{"description":"API Image was deleted successfully."},"401":{"$ref":"#/components/responses/ApiImageUnauthorized"},"403":{"$ref":"#/components/responses/ApiImageForbidden"},"404":{"$ref":"#/components/responses/ApiImageNotFound"}},"tags":["API Image"]}},"/apis/{apiId}/images/{imageType}/raw":{"parameters":[{"$ref":"#/components/parameters/ApiId"},{"$ref":"#/components/parameters/ImageType"}],"get":{"operationId":"fetch-api-raw-image","summary":"Get an API Raw Image","description":"Retrieves the raw image of an API. Only the currently applied image (status: valid) can be retrieved.","responses":{"302":{"description":"Redirect to the image URL.","headers":{"Location":{"description":"The CDN URL of the image.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/ApiImageUnauthorized"},"403":{"$ref":"#/components/responses/ApiImageForbidden"},"404":{"$ref":"#/components/responses/ApiImageNotFound"}},"tags":["API Image"]}},"/api-packages":{"get":{"operationId":"list-api-packages","summary":"List API Packages","description":"List API packages","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ApiPackageFilters"},{"$ref":"#/components/parameters/ApiPackageSort"}],"responses":{"200":{"$ref":"#/components/responses/ListApiPackagesResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Packages"]},"post":{"operationId":"create-api-package","summary":"Create API Package","description":"Creates a package of APIs.\nAn API package is a collection of APIs that can be used to group related APIs together.\n","requestBody":{"$ref":"#/components/requestBodies/CreateApiPackageRequest"},"responses":{"201":{"$ref":"#/components/responses/ApiPackageResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Packages"]}},"/api-packages/{packageId}":{"parameters":[{"name":"packageId","in":"path","description":"The UUID API Package identifier","required":true,"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"}}],"get":{"operationId":"get-api-package","summary":"Get API Package","description":"Get details of a specific API package.","responses":{"200":{"$ref":"#/components/responses/ApiPackageResponse"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API Packages"]},"patch":{"operationId":"patch-api-package","summary":"Patch API Package","description":"Updates an existing API package.\nYou can modify the name, description and version of the API Package.\n","requestBody":{"$ref":"#/components/requestBodies/UpdateApiPackageRequest"},"responses":{"200":{"$ref":"#/components/responses/ApiPackageResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"}},"tags":["API Packages"]}},"/api-packages/{packageId}/images/{imageType}":{"parameters":[{"$ref":"#/components/parameters/ImageType"},{"name":"packageId","in":"path","description":"The UUID API Package identifier","required":true,"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"}}],"put":{"operationId":"upsert-api-package-image","summary":"Create or Replace an API Package Image","description":"Create or Replace an API Package Image. The replacement image is not applied to the API Package until asynchronous validation completes successfully.","requestBody":{"$ref":"#/components/requestBodies/ReplaceApiPackageImageRequest"},"responses":{"200":{"$ref":"#/components/responses/ApiPackageImageResponse"},"201":{"$ref":"#/components/responses/ApiPackageImageResponse"},"401":{"$ref":"#/components/responses/ApiPackageImageUnauthorized"},"403":{"$ref":"#/components/responses/ApiPackageImageForbidden"},"404":{"$ref":"#/components/responses/ApiPackageImageNotFound"},"409":{"$ref":"#/components/responses/ApiPackageImageConflict"}},"tags":["API Packages Image"]},"get":{"operationId":"fetch-api-package-image","summary":"Get an API Package Image Status","description":"Retrieves the image status of an API package. Returns the latest image if it has not yet been applied (status: uploading, validating, or invalid), otherwise returns the currently applied image (status: valid).","responses":{"200":{"$ref":"#/components/responses/ApiPackageImageResponse"},"401":{"$ref":"#/components/responses/ApiPackageImageUnauthorized"},"403":{"$ref":"#/components/responses/ApiPackageImageForbidden"},"404":{"$ref":"#/components/responses/ApiPackageImageNotFound"}},"tags":["API Packages Image"]},"delete":{"operationId":"delete-api-package-image","summary":"Delete an API Package Image","description":"Delete an API Package Image.","responses":{"204":{"description":"API Package Image was deleted successfully."},"401":{"$ref":"#/components/responses/ApiPackageImageUnauthorized"},"403":{"$ref":"#/components/responses/ApiPackageImageForbidden"},"404":{"$ref":"#/components/responses/ApiPackageImageNotFound"}},"tags":["API Packages Image"]}},"/api-packages/{packageId}/images/{imageType}/raw":{"parameters":[{"$ref":"#/components/parameters/ImageType"},{"name":"packageId","in":"path","description":"The UUID API Package identifier","required":true,"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"}}],"get":{"operationId":"fetch-api-package-raw-image","summary":"Get an API Package Raw Image","description":"Retrieves the raw image of an API Package. Only the currently applied image (status: valid) can be retrieved.","responses":{"302":{"description":"Redirect to the image URL.","headers":{"Location":{"description":"The CDN URL of the image.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/ApiPackageImageUnauthorized"},"403":{"$ref":"#/components/responses/ApiPackageImageForbidden"},"404":{"$ref":"#/components/responses/ApiPackageImageNotFound"}},"tags":["API Packages Image"]}},"/apis/{apiId}/registrations":{"parameters":[{"$ref":"#/components/parameters/ApiId"}],"get":{"operationId":"list-api-registrations","summary":"List API Registrations","description":"Returns a paginated list of registrations for an API.","parameters":[{"$ref":"#/components/parameters/ApiRegistrationsFilters"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ApiRegistrationsList"},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"403":{"$ref":"#/components/responses/ApiForbidden"},"404":{"$ref":"#/components/responses/ApiNotFound"}},"tags":["API"]}}},"components":{"parameters":{"ApiFilters":{"name":"filter","description":"Filters APIs in the response.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ApiFilterParameters"},"style":"deepObject"},"ApiId":{"schema":{"type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"},"name":"apiId","in":"path","required":true,"description":"The UUID API identifier"},"ApiPackageFilters":{"name":"filter","description":"Filters API Packages in the response.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ApiPackageFilterParameters"},"style":"deepObject"},"ApiPackageSort":{"name":"sort","description":"Sorts a collection of API Packages. Supported sort attributes are:\n  - name\n  - version\n  - created_at\n  - updated_at\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"ApiRegistrationsFilters":{"name":"filter","description":"Filters API registrations in the response.","required":false,"in":"query","schema":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/StringFieldFilter"},"portal_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"portal_name":{"$ref":"#/components/schemas/StringFieldFilter"},"application_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"application_name":{"$ref":"#/components/schemas/StringFieldFilter"},"application_owner_type":{"$ref":"#/components/schemas/StringFieldFilter"},"application_owner_id":{"$ref":"#/components/schemas/UuidFieldFilter"}}},"style":"deepObject"},"ApiSort":{"name":"sort","description":"Sorts a collection of APIs. Supported sort attributes are:\n  - name\n  - version\n  - created_at\n  - updated_at\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"ApiVersionFilters":{"name":"filter","description":"Filters API Version in the response.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ApiVersionFilterParameters"},"style":"deepObject"},"ApiVersionSort":{"name":"sort","description":"Sorts a collection of API versions. Supported sort attributes are:\n  - created_at\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"ImageType":{"schema":{"$ref":"#/components/schemas/ImageTypeSchema"},"name":"imageType","in":"path","required":true,"description":"The Supported image type."},"PageNumber":{"name":"page[number]","description":"Determines which page of the entities to retrieve.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":1}},"PageSize":{"name":"page[size]","description":"The maximum number of items to include per page. The last page of a collection may include fewer items.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":10}},"VersionId":{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"versionId","description":"The API version identifier","in":"path","required":true}},"schemas":{"ImageDataUri":{"example":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA","oneOf":[{"$ref":"#/components/schemas/ImagePNGDataUri"},{"$ref":"#/components/schemas/ImageJPGDataUri"},{"$ref":"#/components/schemas/ImageSVGDataUri"}],"title":"ImageDataUri"},"ImageTypeSchema":{"description":"The type of the image.","type":"string","example":"icon","enum":["icon"]},"ReplaceImageRequestSchema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImageDataUri"}},"additionalProperties":false,"required":["data"],"title":"Replace Image Payload"},"ApiResponseSchema":{"type":"object","properties":{"id":{"description":"The API identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"name":{"description":"The name of your API. The `name + version` combination must be unique for each API you publish.\n","type":"string","example":"MyAPI","maxLength":255,"minLength":1},"description":{"description":"A description of your API. Will be visible on your live Portal.","type":"string","nullable":true},"version":{"description":"An optional version for your API. Leave this empty if your API is unversioned.","type":"string","maxLength":255,"minLength":1,"nullable":true},"current_version_summary":{"$ref":"#/components/schemas/ApiVersionSummary"},"slug":{"description":"The `slug` is used in generated URLs to provide human readable paths.\n\nDefaults to `slugify(name + version)`\n","type":"string","example":"my-api-v1","nullable":true,"pattern":"^[\\w-]+$"},"api_spec_ids":{"description":"The list of API specification ids for the API.","type":"array","items":{"type":"string","format":"uuid","description":"The id of the API specification.","example":"123e4567-e89b-12d3-a456-426614174000"},"deprecated":true,"readOnly":true},"portals":{"description":"The list of portals which this API is published to.","type":"array","items":{"type":"object","additionalProperties":false,"required":["id","name","display_name"],"properties":{"id":{"description":"The portal identifier.","type":"string","format":"uuid","example":"25a2624c-49fc-4764-99e1-224ed819f200"},"name":{"description":"The name of the portal, used to distinguish it from other portals.","type":"string","example":"My Portal"},"display_name":{"description":"The display name of the portal. This value will be the portal's `name` in Portal API.","type":"string","example":"My Portal"}}},"nullable":false,"readOnly":true,"uniqueItems":true},"labels":{"$ref":"#/components/schemas/Labels"},"implementation_mode":{"description":"the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement","type":"string","nullable":true,"readOnly":true},"attributes":{"$ref":"#/components/schemas/ApiAttributes"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"images":{"type":"object","example":{"icon":{"uri":"/apis/ebbac5b0-ac89-45c3-9d2e-c4542c657e79/images/icon/raw"}},"additionalProperties":false,"nullable":true,"properties":{"icon":{"type":"object","additionalProperties":false,"nullable":true,"properties":{"uri":{"description":"The relative API path for retrieving the raw the icon image.","type":"string","format":"uri-reference","nullable":true,"pattern":"^/[^\\s]+/images/icon/raw$"}}}},"readOnly":true,"title":"Images"}},"additionalProperties":false,"required":["id","name","version","labels","created_at","updated_at","slug","portals","api_spec_ids","current_version_summary"],"title":"API"},"APIImage":{"type":"object","properties":{"error":{"description":"An error related to the image invalid status.","type":"string","example":null,"nullable":true,"readOnly":true},"status":{"description":"The status of the image.","type":"string","example":"valid","enum":["uploading","validating","valid","invalid"],"readOnly":true},"api_id":{"description":"The API identifier which the image belongs to.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","readOnly":true},"image_type":{"allOf":[{"$ref":"#/components/schemas/ImageTypeSchema"},{"readOnly":true}]},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["status","error","api_id","image_type","created_at","updated_at"],"title":"Image Status"},"ApiComputedSchema":{"type":"object","properties":{"id":{"description":"The API identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5"},"api_spec_validation_messages_count":{"description":"The number of validation messages for the API specification attached to the API. If there are no validation messages, the value will be 0, or if there are no API specifications, the value will be 0.","type":"integer","example":1}},"additionalProperties":false},"ApiVersion":{"type":"object","properties":{"id":{"description":"The API version identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"version":{"description":"The version of the api.","type":"string","example":"1.0.0"},"spec":{"type":"object","additionalProperties":false,"properties":{"content":{"description":"The raw content of your API spec, in json or yaml format (OpenAPI or AsyncAPI).\n","example":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}","type":"string"},"type":{"description":"The type of specification being stored. This allows us to render the specification correctly.\n","type":"string","example":"oas3","enum":["oas2","oas3","asyncapi"],"readOnly":true,"title":"API Spec Type"},"validation_messages":{"description":"The errors that occurred while parsing the API version spec.","type":"array","items":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string"}}},"readOnly":true},"provider":{"description":"The provider used to supply the spec content. In write requests, provide\nthis instead of or alongside content. If omitted on writes, the server\ninfers type raw from spec.content.\n","oneOf":[{"$ref":"#/components/schemas/RawApiSpecProvider"},{"$ref":"#/components/schemas/UrlApiSpecProvider"},{"$ref":"#/components/schemas/IntegrationApiSpecProviderPayload"},{"$ref":"#/components/schemas/ResourceBoundIntegrationApiSpecProviderPayload"}],"title":"ApiSpecProvider"}}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"title":"API Version"},"ApiVersionSummary":{"type":"object","properties":{"id":{"description":"The API version identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"version":{"description":"The version of this api spec.","type":"string"},"spec":{"type":"object","additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/ApiSpecType"},"provider":{"description":"Provenance of the spec for the current version. Present when a spec exists.","oneOf":[{"$ref":"#/components/schemas/RawApiSpecProvider"},{"$ref":"#/components/schemas/UrlApiSpecProvider"},{"$ref":"#/components/schemas/IntegrationApiSpecProviderPayload"},{"$ref":"#/components/schemas/ResourceBoundIntegrationApiSpecProviderPayload"}],"title":"ApiSpecProvider"}}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"nullable":true,"readOnly":true,"title":"API Version Summary"},"ApiSpecPayload":{"type":"object","oneOf":[{"$ref":"#/components/schemas/ApiSpecContentPayload"},{"$ref":"#/components/schemas/ApiSpecProviderPayload"}],"title":"ApiSpecPayload","writeOnly":true},"ApiSpecContentPayload":{"description":"The raw content of API specification, in json or yaml format (OpenAPI or AsyncAPI).\n","type":"object","properties":{"content":{"example":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}","type":"string"}},"additionalProperties":false,"required":["content"],"title":"ApiSpecContentPayload"},"ApiSpecProviderPayload":{"description":"Represent spec provider information used for fetching the API spec. For raw, provide the raw content in the `content` property instead of using this provider.\n","type":"object","properties":{"provider":{"oneOf":[{"$ref":"#/components/schemas/UrlApiSpecProvider"},{"$ref":"#/components/schemas/IntegrationApiSpecProviderPayload"},{"$ref":"#/components/schemas/ResourceBoundIntegrationApiSpecProviderPayload"}]}},"additionalProperties":false,"required":["provider"],"title":"ApiSpecProviderPayload"},"ApiAttributes":{"description":"A set of attributes that describe the API","type":"object","example":{"env":["production"],"domains":["web","mobile"]},"default":{},"additionalProperties":{"nullable":true,"description":"Set of attributes with unique keys. Each key can include lowercase letters, numbers, hyphens, and underscores.","type":"array","minItems":1,"maxItems":20,"items":{"type":"string","minLength":1,"maxLength":512,"pattern":"^[^,<>]*$"}},"nullable":false,"title":"API Attributes"},"ApiFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"version":{"$ref":"#/components/schemas/StringFieldFilter"},"labels":{"$ref":"#/components/schemas/LabelsFieldFilter"},"attributes":{"$ref":"#/components/schemas/AttributesFieldFilter"},"implementation_mode":{"$ref":"#/components/schemas/StringFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"title":"API Filter Parameters"},"ApiPackageFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"version":{"$ref":"#/components/schemas/StringFieldFilter"},"labels":{"$ref":"#/components/schemas/LabelsFieldFilter"},"attributes":{"$ref":"#/components/schemas/AttributesFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"title":"API Package Filter Parameters"},"ApiVersionFilterParameters":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/StringFieldFilter"},"version":{"$ref":"#/components/schemas/StringFieldFilter"}},"title":"API Spec Filter Parameters"},"ApiPackageResponseSchema":{"type":"object","properties":{"id":{"description":"The API Package identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"name":{"description":"The name of your API Package. The `name + version` combination must be unique for each API Package you publish.\n","type":"string","example":"MyAPIPackage","maxLength":255,"minLength":1},"description":{"description":"A description of your API Package. Will be visible on your live Portal.","type":"string","nullable":true},"slug":{"description":"The unique slug for your API Package, It should be unique across all APIs and API Packages.\n","type":"string","example":"my-api-package-v1","nullable":true,"pattern":"^[\\w-]+$"},"version":{"description":"An optional version for your API Package. Leave this empty if your API Package is unversioned.","type":"string","maxLength":255,"minLength":1,"nullable":true},"rate_limiting_config":{"$ref":"#/components/schemas/RateLimitingConfig"},"labels":{"$ref":"#/components/schemas/Labels"},"attributes":{"$ref":"#/components/schemas/ApiAttributes"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"images":{"type":"object","example":{"icon":{"uri":"/apis/ebbac5b0-ac89-45c3-9d2e-c4542c657e79/images/icon/raw"}},"additionalProperties":false,"nullable":true,"properties":{"icon":{"type":"object","additionalProperties":false,"nullable":true,"properties":{"uri":{"description":"The relative API path for retrieving the raw the icon image.","type":"string","format":"uri-reference","nullable":true,"pattern":"^/[^\\s]+/images/icon/raw$"}}}},"readOnly":true,"title":"Images"}},"additionalProperties":false,"required":["id","name","slug","version","labels","attributes","created_at","updated_at","rate_limiting_config"],"title":"API Package"},"RateLimitingConfig":{"description":"Rate limit configuration that can be applied to an API Package or an API Package Operation.","type":"object","properties":{"limit":{"description":"The amount of requests allowed for each operation within the specified duration.","type":"integer","minimum":0},"duration":{"description":"The timeframe to ensure that an application does not exceed the request limit.","type":"string","enum":["seconds","minutes","hours"]}},"additionalProperties":false,"nullable":true,"required":["limit","duration"],"title":"Rate Limiting configuration"},"APIPackageImage":{"type":"object","properties":{"error":{"description":"An error related to the image invalid status.","type":"string","example":null,"nullable":true,"readOnly":true},"status":{"description":"The status of the image.","type":"string","example":"valid","enum":["uploading","validating","valid","invalid"],"readOnly":true},"api_package_id":{"description":"The API identifier which the image belongs to.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","readOnly":true},"image_type":{"allOf":[{"$ref":"#/components/schemas/ImageTypeSchema"},{"readOnly":true}]},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["status","error","api_package_id","image_type","created_at","updated_at"],"title":"Image Status"},"ApiRegistrationsListResponse":{"description":"The response for a list of API registrations.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiRegistration"}}},"additionalProperties":false,"required":["data","meta"],"title":"ApiRegistrationsListResponse"},"ApiRegistration":{"description":"An API registration.","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"status":{"type":"string","enum":["approved","pending","rejected","revoked"]},"portal":{"type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"type":"string"}},"required":["id","name"]},"application":{"type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"type":"string"},"description":{"type":"string"},"owner":{"$ref":"#/components/schemas/ApplicationOwner"}},"required":["id","name","owner"]}},"additionalProperties":false,"required":["id","status","portal","application"],"title":"ApiRegistration"},"UuidFieldFilter":{"description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`","type":"object","properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=foo"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"},"neq":{"description":"The field does not match the provided value.","type":"string","example":"?filter[field_name_here][neq]=bar"}},"additionalProperties":false,"x-examples":{"example-1":{"oeq":"some-value,some-other-value","neq":"not-this-value"},"example-2":{"eq":"some-value"}}},"StringFieldFilter":{"oneOf":[{"title":"Filter by operator","description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`","x-examples":{"example-1":{"contains":"some-value","ocontains":"this-value,or-that-value","oeq":"some-value,some-other-value","neq":"not-this-value"},"example-2":{"eq":"some-value"}},"properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=foo"},"contains":{"description":"The field contains the provided value.","type":"string","example":"?filter[field_name_here][contains]=foo"},"ocontains":{"description":"The field contains any of the provided values.","type":"string","example":"?filter[field_name_here][ocontains]=foo,bar"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"},"neq":{"description":"The field does not match the provided value.","type":"string","example":"?filter[field_name_here][neq]=bar"}},"type":"object","additionalProperties":false},{"title":"Filter by exact string match","type":"string","description":"The field exactly matches the provided value.","example":"?filter[title]=foo"}]},"LabelsFieldFilter":{"allOf":[{"title":"LabelsFieldFilter","description":"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"},{"$ref":"#/components/schemas/StringFieldFilter"}]},"AttributesFieldFilter":{"allOf":[{"title":"AttributesFieldFilter","description":"Filters on the resource's `attributes` field. Filters must use dot-notation to identify\nthe attribute key that will be used to filter the results. For example:\n  - `filter[attributes.owner]`\n  - `filter[attributes.owner][neq]=kong`\n  - `filter[attributes.env]=dev`\n  - `filter[attributes.env][ocontains]=dev,test`\n"},{"$ref":"#/components/schemas/StringFieldFilter"}]},"DateTimeFieldFilter":{"description":"Filters on the given datetime (RFC-3339) field value.","oneOf":[{"type":"string","title":"DateTimeFieldImplicitEqualsFilter","format":"date-time","description":"Value strictly equals given RFC-3339 formatted timestamp in UTC","example":"2022-03-30T07:20:50Z"},{"type":"object","title":"DateTimeFieldEqualsFilter","additionalProperties":false,"properties":{"eq":{"description":"Value strictly equals given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["eq"]},{"type":"object","title":"DateTimeFieldLTFilter","additionalProperties":false,"properties":{"lt":{"description":"Value is less than the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["lt"]},{"type":"object","title":"DateTimeFieldLTEFilter","additionalProperties":false,"properties":{"lte":{"description":"Value is less than or equal to the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["lte"]},{"type":"object","title":"DateTimeFieldGTFilter","additionalProperties":false,"properties":{"gt":{"description":"Value is greater than the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["gt"]},{"type":"object","title":"DateTimeFieldGTEFilter","additionalProperties":false,"properties":{"gte":{"description":"Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["gte"]}],"title":"DateTimeFieldFilter","x-examples":{"datetime_field_1":"2022-03-30T07:20:50Z","datetime_field_2":{"eq":"2022-03-30T07:20:50Z"},"datetime_field_3":{"lt":"2022-03-30T07:20:50Z"},"datetime_field_4":{"lte":"2022-03-30T07:20:50Z"},"datetime_field_5":{"gt":"2022-03-30T07:20:50Z"},"datetime_field_6":{"gte":"2022-03-30T07:20:50Z"}}},"SortQuery":{"description":"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":"string","example":"created_at desc","title":"SortQuery"},"PageMeta":{"description":"Contains pagination query parameters and the total number of objects returned.","type":"object","properties":{"number":{"type":"number","example":1},"size":{"type":"number","example":10},"total":{"type":"number","example":100}},"required":["number","size","total"]},"PaginatedMeta":{"description":"returns the pagination information","type":"object","properties":{"page":{"$ref":"#/components/schemas/PageMeta"}},"required":["page"],"title":"PaginatedMeta"},"ApiSpecType":{"description":"The type of specification being stored. This allows us to render the specification correctly.\n","type":"string","example":"oas3","enum":["oas2","oas3","asyncapi"],"title":"API Spec Type"},"RawApiSpecProvider":{"type":"object","properties":{"type":{"type":"string","enum":["raw"]},"config":{"type":"object","additionalProperties":false,"maxProperties":0,"minProperties":0}},"required":["type","config"]},"UrlApiSpecProvider":{"type":"object","properties":{"type":{"type":"string","enum":["url"]},"config":{"type":"object","properties":{"url":{"description":"Public URL that resolves to the raw API spec contents.\nSupported formats are JSON and YAML.\n","type":"string","format":"uri","example":"https://api.petstore.com/v3/openapi.json"}},"required":["url"]}},"required":["type","config"]},"IntegrationApiSpecProviderPayload":{"description":"API spec provider registered by a catalog integration.\n\nIntegrations can function as API spec providers where they register a globally unique\n`type` and config schema which defines the shape of `config`.\n\nConsult integration documentation to learn more about available API spec providers.\n","type":"object","properties":{"type":{"description":"The globally unique API spec provider type that is registered by a given catalog integration.","type":"string","example":"swaggerhub_api_version","maxLength":120,"minLength":1},"config":{"description":"JSON object containing values as defined by integration provider's config schema.","type":"object","example":{"owner":"petco","api":"pet_store","version":"v3"},"additionalProperties":true,"minProperties":1},"integration_instance":{"description":"The integration instance id or name","type":"string"}},"required":["type","config","integration_instance"]},"ResourceBoundIntegrationApiSpecProviderPayload":{"description":"API spec provider registered by a catalog integration.\n\nThese providers differ from `IntegrationApiSpecProvider` in that they\ndenote a binding relationship between a resource type and the API spec.\nThis means that the API Spec will automatically be created/deleted for/from a service\nas resources of the given type are mapped/unmapped.\n\nConsult integration documentation to learn more about available API spec providers.\n","type":"object","properties":{"type":{"description":"The globally unique API spec provider type that is registered by a given catalog integration.\nResource-bound providers create a 1-to-1 mapping between a resource type and the API Spec.\n","type":"string","maxLength":120,"minLength":1},"config":{"type":"object","properties":{"resource_id":{"description":"ID of the associated Resource the API spec is bound to.","type":"string","example":"IqkHvMdyHukxcwAs"}},"required":["resource_id"]}},"required":["type","config"]},"CreatedAt":{"description":"An ISO-8601 timestamp representation of entity creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"UpdatedAt":{"description":"An ISO-8601 timestamp representation of entity update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"Labels":{"description":"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":"object","example":{"env":"test"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63},"maxProperties":50,"title":"Labels"},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"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","type":"integer","readOnly":true},"title":{"description":"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","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"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","type":"string","readOnly":true},"detail":{"description":"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":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["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"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"ForbiddenError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":403},"title":{"example":"Forbidden"},"type":{"example":"https://httpstatuses.com/403"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Forbidden"}}}]},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]},"UnsupportedMediaTypeError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":415},"title":{"example":"UnsupportedMediaType"},"type":{"example":"https://httpstatuses.com/415"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"UnsupportedMediaType"}}}]},"LabelsUpdate":{"description":"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","type":"object","example":{"env":"test"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63,"nullable":true},"maxProperties":50,"nullable":true,"writeOnly":true},"ConflictError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":409},"title":{"example":"Conflict"},"type":{"example":"https://httpstatuses.com/409"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Conflict"}}}]},"ImagePNGDataUri":{"description":"must be a data URL with base64 PNG image data, e.g., data:image/png;base64,<BASE64_IMAGE_DATA>","type":"string","format":"uri","example":"data:image/png,YW5faW1hZ2VfZmlsZQ==","pattern":"^data:image/png(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","title":"ImagePNGDataUri","x-validation-message":"must be a data URL with base64 PNG image data, e.g., data:image/png;base64,<BASE64_IMAGE_DATA>"},"ImageJPGDataUri":{"description":"must be a data URL with base64 JPEG image data, e.g., data:image/jpeg;base64,<BASE64_IMAGE_DATA>","type":"string","format":"uri","example":"data:image/jpeg,YW5faW1hZ2VfZmlsZQ==","pattern":"^data:image/jpeg(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","title":"ImageJPGDataUri","x-validation-message":"must be a data URL with base64 JPEG image data, e.g., data:image/jpeg;base64,<BASE64_IMAGE_DATA>"},"ImageSVGDataUri":{"description":"must be a data URL with base64 SVG image data, e.g., data:image/svg\\+xml;base64,<BASE64_IMAGE_DATA>","type":"string","format":"uri","example":"data:image/svg+xml,YW5faW1hZ2VfZmlsZQ==","pattern":"^data:image/svg\\+xml(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","title":"ImageSVGDataUri","x-validation-message":"must be a data URL with base64 SVG image data, e.g., data:image/svg\\+xml;base64,<BASE64_IMAGE_DATA>"},"UUID":{"description":"Contains a unique identifier used for this resource.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"ApplicationOwnerType":{"description":"The type of the owner of the application. Can be `developer` (individual developer) or `team`.","type":"string","enum":["developer","team"]},"ApplicationOwnerId":{"description":"The ID of the owner of the application. When type is `developer`, this is the developer ID. When type is `team`, this is the team ID.","type":"string","format":"uuid"},"ApplicationOwner":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ApplicationOwnerType"},"id":{"$ref":"#/components/schemas/ApplicationOwnerId"}},"additionalProperties":false,"required":["type","id"]}},"examples":{"ApiExample":{"value":{"id":"9f5061ce-78f6-4452-9108-ad7c02821fd5","name":"myAPI","version":"v1","labels":{"env":"test"},"description":"My API","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","slug":"my-api-v1","current_version_summary":{"id":"7710d5c4-d902-410b-992f-18b814155b53","version":"v1","spec":{"type":"oas3"},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"},"portals":[{"id":"25a2624c-49fc-4764-99e1-224ed819f200","name":"My-Portal","display_name":"My Portal"}],"api_spec_ids":["123e4567-e89b-12d3-a456-426614174000"],"images":{"icon":{"uri":"/apis/ebbac5b0-ac89-45c3-9d2e-c4542c657e79/images/icon/raw"}}}},"ApiPackageExample":{"value":{"id":"9f5061ce-78f6-4452-9108-ad7c02821fd5","name":"myAPIPackage","version":"v1","slug":"my-api-package-v1","description":"My API","rate_limiting_config":null,"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","labels":{"foo":"bar"},"attributes":{"env":["production"]},"images":{"icon":{"uri":"/apis/ebbac5b0-ac89-45c3-9d2e-c4542c657e79/images/icon/raw"}}}},"ApiPackageImageUnauthorizedExample":{"value":{"status":401,"title":"ApiPackageImageUnauthorized","instance":"kong:trace:8347343766220159418","detail":"ApiPackageImageUnauthorized"}},"ApiPackageImageNotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}},"ApiPackageImageForbiddenExample":{"value":{"status":403,"title":"ApiPackageImageForbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}},"ApiVersionExample":{"value":{"id":"7710d5c4-d902-410b-992f-18b814155b53","version":"1.9.32","spec":{"content":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.9.32\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}","type":"oas3","validation_messages":[{"message":"'#/components/schemas/shouldExist' does not exist"}]},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}},"ApiVersionExampleAsyncApi":{"summary":"API Spec Response (AsyncAPI)","value":{"id":"8821e6d5-e013-411c-a03a-29c925266c64","version":"1.9.32","spec":{"content":"{\"asyncapi\":\"2.6.0\",\"info\":{\"title\":\"Account Service\",\"version\":\"1.9.32\",\"description\":\"This service is in charge of processing user signups\"},\"channels\":{\"user/signedup\":{\"publish\":{\"summary\":\"Inform about signed up users\",\"operationId\":\"sendUserSignedUp\",\"message\":{\"name\":\"UserSignedUp\",\"payload\":{\"type\":\"object\",\"properties\":{\"displayName\":{\"type\":\"string\",\"description\":\"Name of the user\"},\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"Email of the user\"}}}}}}}}","type":"asyncapi","validation_messages":[]},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}},"ListApiVersionExample":{"value":{"data":[{"id":"7710d5c4-d902-410b-992f-18b814155b53","spec":{"type":"oas3"},"version":"1.0.0","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}],"meta":{"page":{"number":1,"size":1,"total":1}}}},"ListApiVersionExampleAsyncApi":{"summary":"List API Version Response (Mixed Types)","value":{"data":[{"id":"7710d5c4-d902-410b-992f-18b814155b53","spec":{"type":"oas3"},"version":"1.0.0","created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"},{"id":"8821e6d5-e013-411c-a03a-29c925266c64","spec":{"type":"asyncapi"},"version":"1.0.1","created_at":"2023-01-02T00:00:00.000Z","updated_at":"2023-01-02T00:00:00.000Z"}],"meta":{"page":{"number":1,"size":2,"total":2}}}},"CreateApiRequestMinimalExample":{"summary":"Create API Request (Minimal)","value":{"name":"myAPI"}},"CreateApiRequestFullExample":{"summary":"Create API Request (Full)","value":{"name":"myAPI","version":"v1","slug":"my-api-v1","labels":{"env":"test"}}},"CreateApiVersionRequestExampleJson":{"summary":"Create API Version Request (OAS3 JSON)","value":{"version":"1.0.0","spec":{"content":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}"}}},"CreateApiVersionRequestExampleYaml":{"summary":"Create API Version Request (OAS3 YAML)","value":{"version":"1.0.0","spec":{"content":"openapi: 3.0.3\\ninfo:\\n  title: Example API\\n  version: 1.0.0\\npaths:\\n  /example:\\n    get:\\n      summary: Example endpoint\\n      responses:\\n        \\\"200\\\":\\n          description: Successful response"}}},"CreateApiVersionRequestExampleAsyncApi":{"summary":"Create API Version Request (AsyncAPI JSON)","value":{"version":"1.0.0","spec":{"content":"{\"asyncapi\":\"2.6.0\",\"info\":{\"title\":\"Account Service\",\"version\":\"1.0.0\",\"description\":\"This service is in charge of processing user signups\"},\"channels\":{\"user/signedup\":{\"publish\":{\"summary\":\"Inform about signed up users\",\"operationId\":\"sendUserSignedUp\",\"message\":{\"name\":\"UserSignedUp\",\"payload\":{\"type\":\"object\",\"properties\":{\"displayName\":{\"type\":\"string\",\"description\":\"Name of the user\"},\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"Email of the user\"}}}}}}}}"}}},"UpdateApiNameRequestExample":{"summary":"Update API Name","value":{"name":"new API name"}},"UpdateApiVersionRequestExample":{"summary":"Update API Version","value":{"version":"v2"}},"UpdateApiVersionContentRequestExample":{"summary":"Update API Version Content (OAS3)","value":{"version":"1.0.1","spec":{"content":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.1\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}"}}},"ApiNameBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:8405749052424858251","detail":"Invalid Parameters","invalid_parameters":[{"field":"name","rule":"min_length","minimum":1,"reason":"name must be longer than or equal to 1 characters"}]}},"ApiVersionBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"version","rule":"missing_reference","reason":"version must be provided if not included in spec_content"}]}},"ApiUnauthorizedExample":{"value":{"status":401,"title":"ApiUnauthorized","instance":"kong:trace:8347343766220159418","detail":"ApiUnauthorized"}},"ApiNotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}},"ApiForbiddenExample":{"value":{"status":403,"title":"ApiForbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}},"ApiSpecConflictExample":{"value":{"status":409,"title":"Conflict","instance":"kong:trace:3169213858331814220","detail":"Specification for API '9f5061ce-78f6-4452-9108-ad7c02821fd5' already exists"}},"ApiSpecHiddenConflictExample":{"value":{"status":409,"title":"Conflict","instance":"kong:trace:9039922446017540182","detail":"Key (api_id, path)=(23380be0-c15e-4ca8-bcf7-43aadddc91b1, hidden.yaml) already exists."}},"ApiImageUnauthorizedExample":{"value":{"status":401,"title":"ApiImageUnauthorized","instance":"kong:trace:8347343766220159418","detail":"ApiImageUnauthorized"}},"ApiImageNotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}},"ApiImageForbiddenExample":{"value":{"status":403,"title":"ApiImageForbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}},"ApiImageConflictExample":{"value":{"status":409,"title":"Conflict","instance":"kong:trace:3169213858331814220","detail":"The image is currently being updated by another request"}},"ApiPackageImageConflictExample":{"value":{"status":409,"title":"Conflict","instance":"kong:trace:3169213858331814220","detail":"The image is currently being updated by another request"}},"ApiOperationsRemovalConflictExample":{"value":{"status":409,"title":"Conflict","instance":"kong:trace:1234567890123456789","detail":"Operations are not allowed to be removed from the current version when using access control enforcement"}},"InvalidApiSortQueryNameBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:4725061142075238974","detail":"Invalid Parameters","invalid_parameters":[{"field":"sort","rule":"enum","choices":["name"],"reason":"\"sort\" field must contain any of: [name]"}]}},"UpdateApiVersionContentRequestExampleAsyncApi":{"summary":"Update API Version Spec Content (AsyncAPI)","value":{"version":"1.0.2","spec":{"content":"{\"asyncapi\":\"2.6.0\",\"info\":{\"title\":\"Account Service Updated\",\"version\":\"1.0.1\",\"description\":\"This service is in charge of processing user signups (updated)\"},\"channels\":{\"user/signedup\":{\"publish\":{\"summary\":\"Inform about signed up users\",\"operationId\":\"sendUserSignedUp\",\"message\":{\"name\":\"UserSignedUp\",\"payload\":{\"type\":\"object\",\"properties\":{\"displayName\":{\"type\":\"string\",\"description\":\"Name of the user\"},\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"Email of the user\"}}}}}}}}"}}},"ApiRegistrationsListResponseExample":{"summary":"Example response for a list of API registrations","description":"Example response for a list of API registrations.\n","value":{"data":[{"id":"c200cc33-2d33-4754-b086-a98e0fcd36fb","status":"approved","portal":{"id":"56f637b7-cd95-478b-9b02-d770618f641c","name":"Great Portal"},"application":{"id":"e15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 1","owner":{"id":"6cd9feff-b4da-4a9f-ba49-cbe83c75ff22","type":"developer"}}}],"meta":{"page":{"number":1,"size":10,"total":2}}}},"UnsupportedMediaTypeExample":{"value":{"status":415,"title":"Unsupported Media Type","instance":"kong:trace:8347343766220159418","detail":"This API only supports requests with `Content-Type: application/json`"}}},"requestBodies":{"CreateApiRequest":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The API identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"name":{"description":"The name of your API. The `name + version` combination must be unique for each API you publish.\n","type":"string","example":"MyAPI","maxLength":255,"minLength":1},"description":{"description":"A description of your API. Will be visible on your live Portal.","type":"string","nullable":true},"version":{"description":"An optional version for your API. Leave this empty if your API is unversioned.","type":"string","maxLength":255,"minLength":1,"nullable":true},"current_version_summary":{"$ref":"#/components/schemas/ApiVersionSummary"},"slug":{"description":"The `slug` is used in generated URLs to provide human readable paths.\n\nDefaults to `slugify(name + version)`\n","type":"string","example":"my-api-v1","nullable":true,"pattern":"^[\\w-]+$"},"api_spec_ids":{"description":"The list of API specification ids for the API.","type":"array","items":{"type":"string","format":"uuid","description":"The id of the API specification.","example":"123e4567-e89b-12d3-a456-426614174000"},"deprecated":true,"readOnly":true},"portals":{"description":"The list of portals which this API is published to.","type":"array","items":{"type":"object","additionalProperties":false,"required":["id","name","display_name"],"properties":{"id":{"description":"The portal identifier.","type":"string","format":"uuid","example":"25a2624c-49fc-4764-99e1-224ed819f200"},"name":{"description":"The name of the portal, used to distinguish it from other portals.","type":"string","example":"My Portal"},"display_name":{"description":"The display name of the portal. This value will be the portal's `name` in Portal API.","type":"string","example":"My Portal"}}},"nullable":false,"readOnly":true,"uniqueItems":true},"labels":{"$ref":"#/components/schemas/Labels"},"implementation_mode":{"description":"the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement","type":"string","nullable":true,"readOnly":true},"attributes":{"$ref":"#/components/schemas/ApiAttributes"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"spec":{"$ref":"#/components/schemas/ApiSpecPayload"},"spec_content":{"description":"The content of the API specification. This is the raw content of the API specification, in json or yaml. By including this field, you can add a API specification without having to make a separate call to update the API specification.","type":"string","nullable":false,"writeOnly":true}},"additionalProperties":false,"required":["name"],"title":"API"},"examples":{"CreateApiMinimal":{"$ref":"#/components/examples/CreateApiRequestMinimalExample"},"CreateApiFull":{"$ref":"#/components/examples/CreateApiRequestFullExample"}}}}},"CreateApiPackageRequest":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The API Package identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"name":{"description":"The name of your API Package. The `name + version` combination must be unique for each API Package you publish.\n","type":"string","example":"MyAPIPackage","maxLength":255,"minLength":1},"description":{"description":"A description of your API Package. Will be visible on your live Portal.","type":"string","nullable":true},"slug":{"description":"The unique slug for your API Package, It should be unique across all APIs and API Packages.\n","type":"string","example":"my-api-package-v1","nullable":true,"pattern":"^[\\w-]+$"},"version":{"description":"An optional version for your API Package. Leave this empty if your API Package is unversioned.","type":"string","maxLength":255,"minLength":1,"nullable":true},"rate_limiting_config":{"$ref":"#/components/schemas/RateLimitingConfig"},"labels":{"$ref":"#/components/schemas/Labels"},"attributes":{"$ref":"#/components/schemas/ApiAttributes"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["name"],"title":"API Package"}}}},"CreateApiVersionRequest":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The API version identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"version":{"description":"The version of the api.","type":"string","example":"1.0.0"},"spec":{"type":"object","additionalProperties":false,"properties":{"content":{"description":"The raw content of your API spec, in json or yaml format (OpenAPI or AsyncAPI).\n","example":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}","type":"string"},"type":{"description":"The type of specification being stored. This allows us to render the specification correctly.\n","type":"string","example":"oas3","enum":["oas2","oas3","asyncapi"],"readOnly":true,"title":"API Spec Type"},"validation_messages":{"description":"The errors that occurred while parsing the API version spec.","type":"array","items":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string"}}},"readOnly":true},"provider":{"description":"The provider used to supply the spec content. In write requests, provide\nthis instead of or alongside content. If omitted on writes, the server\ninfers type raw from spec.content.\n","oneOf":[{"$ref":"#/components/schemas/RawApiSpecProvider"},{"$ref":"#/components/schemas/UrlApiSpecProvider"},{"$ref":"#/components/schemas/IntegrationApiSpecProviderPayload"},{"$ref":"#/components/schemas/ResourceBoundIntegrationApiSpecProviderPayload"}],"title":"ApiSpecProvider"}}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["spec"],"title":"API Version"},"examples":{"CreateApiVersionRequestExampleJson":{"$ref":"#/components/examples/CreateApiVersionRequestExampleJson"},"CreateApiVersionRequestExampleYaml":{"$ref":"#/components/examples/CreateApiVersionRequestExampleYaml"},"CreateApiVersionRequestExampleAsyncApi":{"$ref":"#/components/examples/CreateApiVersionRequestExampleAsyncApi"}}}}},"UpdateApiRequest":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The API identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"name":{"description":"The name of your API. The `name + version` combination must be unique for each API you publish.\n","type":"string","example":"MyAPI","maxLength":255,"minLength":1},"description":{"description":"A description of your API. Will be visible on your live Portal.","type":"string","nullable":true},"version":{"description":"An optional version for your API. Leave this empty if your API is unversioned.","type":"string","maxLength":255,"minLength":1,"nullable":true},"current_version_summary":{"$ref":"#/components/schemas/ApiVersionSummary"},"slug":{"description":"The `slug` is used in generated URLs to provide human readable paths.\n\nDefaults to `slugify(name + version)`\n","type":"string","example":"my-api-v1","nullable":true,"pattern":"^[\\w-]+$"},"api_spec_ids":{"description":"The list of API specification ids for the API.","type":"array","items":{"type":"string","format":"uuid","description":"The id of the API specification.","example":"123e4567-e89b-12d3-a456-426614174000"},"deprecated":true,"readOnly":true},"portals":{"description":"The list of portals which this API is published to.","type":"array","items":{"type":"object","additionalProperties":false,"required":["id","name","display_name"],"properties":{"id":{"description":"The portal identifier.","type":"string","format":"uuid","example":"25a2624c-49fc-4764-99e1-224ed819f200"},"name":{"description":"The name of the portal, used to distinguish it from other portals.","type":"string","example":"My Portal"},"display_name":{"description":"The display name of the portal. This value will be the portal's `name` in Portal API.","type":"string","example":"My Portal"}}},"nullable":false,"readOnly":true,"uniqueItems":true},"labels":{"$ref":"#/components/schemas/LabelsUpdate"},"implementation_mode":{"description":"the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement","type":"string","nullable":true,"readOnly":true},"attributes":{"$ref":"#/components/schemas/ApiAttributes"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"title":"API"},"examples":{"UpdateApiName":{"$ref":"#/components/examples/UpdateApiNameRequestExample"},"UpdateApiVersion":{"$ref":"#/components/examples/UpdateApiVersionRequestExample"}}}}},"UpdateApiPackageRequest":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The API Package identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"name":{"description":"The name of your API Package. The `name + version` combination must be unique for each API Package you publish.\n","type":"string","example":"MyAPIPackage","maxLength":255,"minLength":1},"description":{"description":"A description of your API Package. Will be visible on your live Portal.","type":"string","nullable":true},"slug":{"description":"The unique slug for your API Package, It should be unique across all APIs and API Packages.\n","type":"string","example":"my-api-package-v1","nullable":true,"pattern":"^[\\w-]+$"},"version":{"description":"An optional version for your API Package. Leave this empty if your API Package is unversioned.","type":"string","maxLength":255,"minLength":1,"nullable":true},"rate_limiting_config":{"$ref":"#/components/schemas/RateLimitingConfig"},"labels":{"$ref":"#/components/schemas/LabelsUpdate"},"attributes":{"$ref":"#/components/schemas/ApiAttributes"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"title":"API Package"}}}},"UpdateApiVersionRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiVersion"},"examples":{"UpdateApiVersionContentRequest":{"$ref":"#/components/examples/UpdateApiVersionContentRequestExample"},"UpdateApiVersionContentRequestAsyncApi":{"$ref":"#/components/examples/UpdateApiVersionContentRequestExampleAsyncApi"}}}}},"ReplaceApiImageRequest":{"required":true,"description":"Request body to upload an image base64 dataURI for API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceImageRequestSchema"}}}},"ReplaceApiPackageImageRequest":{"required":true,"description":"Request body to upload an image base64 dataURI for API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceImageRequestSchema"}}}}},"responses":{"ApiSpecConflict":{"description":"Conflict - An API may only have one specification","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"ApiSpecConflictExample":{"$ref":"#/components/examples/ApiSpecConflictExample"}}}}},"ApiVersionPatchConflict":{"description":"Conflict - May occur when constraints are violated","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"ApiOperationsRemovalConflictExample":{"$ref":"#/components/examples/ApiOperationsRemovalConflictExample"},"ApiSpecHiddenConflictExample":{"$ref":"#/components/examples/ApiSpecHiddenConflictExample"}}}}},"ApiUnauthorized":{"description":"ApiUnauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"ApiUnauthorizedExample":{"$ref":"#/components/examples/ApiUnauthorizedExample"}}}}},"ApiNotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"ApiNotFoundExample":{"$ref":"#/components/examples/ApiNotFoundExample"}}}}},"ApiForbidden":{"description":"ApiForbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"ApiForbiddenExample":{"$ref":"#/components/examples/ApiForbiddenExample"}}}}},"ApiResponse":{"description":"API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseSchema"},"examples":{"CreateApiResponse":{"$ref":"#/components/examples/ApiExample"}}}}},"ListApiResponse":{"description":"List of APIs","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiResponseSchema"}}},"additionalProperties":false,"required":["data","meta"],"title":"ListApiResponse"},"examples":{"ApiCollection":{"value":{"data":[{"id":"9f5061ce-78f6-4452-9108-ad7c02821fd5","name":"myAPI","version":"v1","labels":{"env":"test"},"slug":"my-api-v1","current_version_summary":{"id":"7710d5c4-d902-410b-992f-18b814155b53","version":"v1","spec":{"type":"oas3"},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"},"api_spec_ids":["123e4567-e89b-12d3-a456-426614174000"],"portals":[{"id":"25a2624c-49fc-4764-99e1-224ed819f200","name":"My-Portal","display_name":"My Portal"}],"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}],"meta":{"page":{"number":1,"size":1,"total":10}}}}}}}},"ApiPackageResponse":{"description":"API Package","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiPackageResponseSchema"},"examples":{"ApiPackageResponse":{"$ref":"#/components/examples/ApiPackageExample"}}}}},"ListApiPackagesResponse":{"description":"List of API Packages","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiPackageResponseSchema"}}},"additionalProperties":false,"required":["data","meta"],"title":"ListApiPackagesResponse"},"examples":{"ApiPackageCollection":{"value":{"data":[{"id":"9f5061ce-78f6-4452-9108-ad7c02821fd5","name":"myAPIPackage","version":"v1","slug":"my-api-package-v1","description":"This is an API package","rate_limiting_config":null,"labels":{"env":"test"},"attributes":{"env":["production"]},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}],"meta":{"page":{"number":1,"size":1,"total":10}}}}}}}},"ListApiComputedResponse":{"description":"List of APIs with computed fields","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiComputedSchema"}}},"additionalProperties":false,"required":["data","meta"],"title":"List Api Computed Response"}}}},"ApiVersionResponse":{"description":"API version (OpenAPI or AsyncAPI)","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The API version identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"version":{"description":"The version of the api.","type":"string","example":"1.0.0"},"spec":{"type":"object","additionalProperties":false,"properties":{"content":{"description":"The raw content of your API spec, in json or yaml format (OpenAPI or AsyncAPI).\n","example":"{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}","type":"string"},"type":{"description":"The type of specification being stored. This allows us to render the specification correctly.\n","type":"string","example":"oas3","enum":["oas2","oas3","asyncapi"],"readOnly":true,"title":"API Spec Type"},"validation_messages":{"description":"The errors that occurred while parsing the API version spec.","type":"array","items":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string"}}},"readOnly":true},"provider":{"description":"The provider used to supply the spec content. In write requests, provide\nthis instead of or alongside content. If omitted on writes, the server\ninfers type raw from spec.content.\n","oneOf":[{"$ref":"#/components/schemas/RawApiSpecProvider"},{"$ref":"#/components/schemas/UrlApiSpecProvider"},{"$ref":"#/components/schemas/IntegrationApiSpecProviderPayload"},{"$ref":"#/components/schemas/ResourceBoundIntegrationApiSpecProviderPayload"}],"title":"ApiSpecProvider"}}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","version","created_at","updated_at"],"title":"API Version"},"examples":{"ApiSpecResponse":{"$ref":"#/components/examples/ApiVersionExample"},"ApiSpecResponseAsyncApi":{"$ref":"#/components/examples/ApiVersionExampleAsyncApi"}}}}},"ListApiVersionResponse":{"description":"List of API specifications (OpenAPI or AsyncAPI)","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"title":"API Version Summary","type":"object","additionalProperties":false,"readOnly":true,"nullable":false,"properties":{"id":{"description":"The API version identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"version":{"description":"The version of this api spec.","type":"string"},"spec":{"type":"object","additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/ApiSpecType"},"provider":{"description":"Provenance of the spec for the current version. Present when a spec exists.","oneOf":[{"$ref":"#/components/schemas/RawApiSpecProvider"},{"$ref":"#/components/schemas/UrlApiSpecProvider"},{"$ref":"#/components/schemas/IntegrationApiSpecProviderPayload"},{"$ref":"#/components/schemas/ResourceBoundIntegrationApiSpecProviderPayload"}],"title":"ApiSpecProvider"}}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","version","created_at","updated_at"]}}},"additionalProperties":false,"required":["data","meta"],"title":"ListApiSpecResponse"},"examples":{"ListApiSpecResponse":{"$ref":"#/components/examples/ListApiVersionExample"},"ListApiSpecResponseAsyncApi":{"$ref":"#/components/examples/ListApiVersionExampleAsyncApi"}}}}},"ApiImageResponse":{"description":"ApiImageResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIImage"}}}},"ApiImageUnauthorized":{"description":"ApiImageUnauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"ApiUnauthorizedExample":{"$ref":"#/components/examples/ApiImageUnauthorizedExample"}}}}},"ApiImageNotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"ApiNotFoundExample":{"$ref":"#/components/examples/ApiImageNotFoundExample"}}}}},"ApiImageForbidden":{"description":"ApiImageForbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"ApiForbiddenExample":{"$ref":"#/components/examples/ApiImageForbiddenExample"}}}}},"ApiImageConflict":{"description":"Conflict - The image is currently being updated by another request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"ApiImageConflictExample":{"$ref":"#/components/examples/ApiImageConflictExample"}}}}},"ApiPackageImageResponse":{"description":"ApiPackageImageResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIPackageImage"}}}},"ApiPackageImageUnauthorized":{"description":"ApiPackageImageUnauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"ApiUnauthorizedExample":{"$ref":"#/components/examples/ApiPackageImageUnauthorizedExample"}}}}},"ApiPackageImageNotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"ApiNotFoundExample":{"$ref":"#/components/examples/ApiPackageImageNotFoundExample"}}}}},"ApiPackageImageForbidden":{"description":"ApiImageForbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"ApiForbiddenExample":{"$ref":"#/components/examples/ApiPackageImageForbiddenExample"}}}}},"ApiPackageImageConflict":{"description":"Conflict - The image is currently being updated by another request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"ApiPackageImageConflictExample":{"$ref":"#/components/examples/ApiPackageImageConflictExample"}}}}},"ApiRegistrationsList":{"description":"Paginated list of registrations for an API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRegistrationsListResponse"},"examples":{"ApiRegistrationsListResponseExample":{"$ref":"#/components/examples/ApiRegistrationsListResponseExample"}}}}},"UnsupportedMediaType":{"description":"Unsupported Media Type","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeError"},"examples":{"UnsupportedMediaTypeExample":{"$ref":"#/components/examples/UnsupportedMediaTypeExample"}}}}}},"securitySchemes":{"konnectAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.\n"},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"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/account/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"},"systemAccountAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"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"}}},"tags":[{"name":"API"},{"name":"API Packages"}],"security":[{"konnectAccessToken":[]},{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
