---
title: "Portal API Catalog"
url: "https://nov18-dev.movespot.fyi/apis/portal-api-catalog-3/versions/d7aa963d-b594-41d6-a905-3097c44bd297"
---

# Portal API Catalog

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Portal API Catalog","version":"3.0.11","description":"N/A (this description is removed during bundling)","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"paths":{"/api/v3/apis/{apiIdOrSlug}":{"get":{"operationId":"fetch-api","summary":"Get API","description":"Gets the details for an existing published API.","parameters":[{"$ref":"#/components/parameters/ApiIdOrSlug"}],"responses":{"200":{"$ref":"#/components/responses/ApiGet"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]},{}],"tags":["APIs"]}},"/api/v3/apis":{"get":{"operationId":"list-apis","summary":"List APIs","description":"Returns a paginated list of published APIs.","parameters":[{"$ref":"#/components/parameters/ApiFilters"},{"$ref":"#/components/parameters/ApiSort"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ApiList"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}},"security":[{"portalAccessToken":[]},{}],"tags":["APIs"]}},"/api/v3/apis/{apiIdOrSlug}/specifications":{"get":{"operationId":"list-api-specs","summary":"List API Specs","description":"Returns the API specification documents (OpenAPI or AsyncAPI) attached to the API.","parameters":[{"$ref":"#/components/parameters/ApiIdOrSlug"}],"responses":{"200":{"$ref":"#/components/responses/ApiSpecList"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"deprecated":true,"security":[{"portalAccessToken":[]},{}],"tags":["API Docs"]}},"/api/v3/apis/{apiIdOrSlug}/specifications/{specId}":{"get":{"operationId":"fetch-api-spec","summary":"Get API Spec","description":"Returns an API specification document (OpenAPI or AsyncAPI) for an API.","parameters":[{"$ref":"#/components/parameters/ApiIdOrSlug"},{"$ref":"#/components/parameters/SpecId"}],"responses":{"200":{"$ref":"#/components/responses/ApiSpecGet"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"deprecated":true,"security":[{"portalAccessToken":[]},{}],"tags":["API Docs"]}},"/api/v3/apis/{apiIdOrSlug}/specifications/{specId}/raw":{"get":{"operationId":"fetch-api-spec-raw","summary":"Get Raw API Spec","description":"Returns an API specification content (OpenAPI or AsyncAPI) for an API.","parameters":[{"$ref":"#/components/parameters/ApiIdOrSlug"},{"$ref":"#/components/parameters/SpecId"}],"responses":{"200":{"$ref":"#/components/responses/ApiSpecGetRaw"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"deprecated":true,"security":[{"portalAccessToken":[]},{}],"tags":["API Docs"]}},"/api/v3/apis/{apiIdOrSlug}/versions":{"get":{"operationId":"list-api-version-specs","summary":"List API Versions","description":"Returns the API specification documents (OpenAPI or AsyncAPI) attached to the API.","parameters":[{"$ref":"#/components/parameters/ApiIdOrSlug"}],"responses":{"200":{"$ref":"#/components/responses/ApiVersionList"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]},{}],"tags":["API Docs"]}},"/api/v3/apis/{apiIdOrSlug}/versions/{versionId}":{"get":{"operationId":"fetch-api-version-spec","summary":"Get API Version Spec","description":"Returns an API version specification document (OpenAPI or AsyncAPI) for an API.","parameters":[{"$ref":"#/components/parameters/ApiIdOrSlug"},{"$ref":"#/components/parameters/VersionId"}],"responses":{"200":{"$ref":"#/components/responses/ApiVersionGet"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]},{}],"tags":["API Docs"]}},"/api/v3/apis/{apiIdOrSlug}/versions/{versionId}/raw":{"get":{"operationId":"fetch-api-version-spec-raw","summary":"Get Raw API Version Spec","description":"Returns an API version specification content (OpenAPI or AsyncAPI) for an API.","parameters":[{"$ref":"#/components/parameters/ApiIdOrSlug"},{"$ref":"#/components/parameters/VersionId"}],"responses":{"200":{"$ref":"#/components/responses/ApiVersionGetRaw"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]},{}],"tags":["API Docs"]}},"/api/v3/apis/{apiIdOrSlug}/documents":{"get":{"operationId":"list-api-documents","summary":"List API Docs","description":"Returns a tree view of documents that are associated with an API.","parameters":[{"$ref":"#/components/parameters/ApiIdOrSlug"}],"responses":{"200":{"$ref":"#/components/responses/ApiDocumentList"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]},{}],"tags":["API Docs"]}},"/api/v3/apis/{apiIdOrSlug}/documents/{documentIdOrSlug}":{"get":{"operationId":"fetch-api-document","summary":"Get API Doc","description":"Returns the specified document from the API's document tree.","parameters":[{"name":"Accept","in":"header","schema":{"$ref":"#/components/schemas/DocumentFormatContentTypeEnum"}},{"$ref":"#/components/parameters/ApiIdOrSlug"},{"$ref":"#/components/parameters/DocumentIdOrSlug"}],"responses":{"200":{"$ref":"#/components/responses/ApiDocumentGet"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]},{}],"tags":["API Docs"]}},"/api/v3/apis/{apiIdOrSlug}/actions":{"parameters":[{"$ref":"#/components/parameters/ApiIdOrSlug"}],"get":{"operationId":"get-api-actions","summary":"List API Actions","description":"Get a set of actions that the current developer is allowed to perform on an API.","responses":{"200":{"$ref":"#/components/responses/ApiActions"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["APIs"]}},"/api/v3/apis/{apiIdOrSlug}/applications":{"parameters":[{"$ref":"#/components/parameters/ApiIdOrSlug"},{"$ref":"#/components/parameters/QueryUnregisteredApplications"},{"$ref":"#/components/parameters/ApplicationFilters"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"get":{"operationId":"get-api-applications","summary":"List API Applications","description":"Get applications that have a registration for a given API.\nAny registration will count, regardless of status (i.e. even if it is pending, rejected, or revoked).\nUse the unregistered query param to return the inverse, only including applicatons that do not have a registration (regardless of status).\n","responses":{"200":{"$ref":"#/components/responses/ApiListApplications"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["APIs"]}},"/api/v3/api-attributes":{"get":{"operationId":"get-paginated-api-attributes","summary":"List API Attributes","description":"Get a paginated list of all attributes across APIs in the portal.\nIf authenticated, results will include attributes of APIs visible to the authenticated user.\nIf not authenticated, results will include only attributes of publicly visible APIs.\n\nWhen the `selected` query parameter is provided, the response will include a `selected_api_count`\nfield for each attribute value, indicating how many APIs would match that attribute value\nwhen combined with the currently selected filters.\n","parameters":[{"$ref":"#/components/parameters/ApiAttributeFilters"},{"$ref":"#/components/parameters/SelectedApiAttributes"}],"responses":{"200":{"$ref":"#/components/responses/ListApiAttributes"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Attributes"]}}},"components":{"parameters":{"ApiAttributeFilters":{"name":"filter","description":"Filters API attributes in the response.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ApiAttributeFilterParameters"},"style":"deepObject"},"ApiFilters":{"name":"filter","description":"Filters APIs in the response.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ApiFilterParameters"},"style":"deepObject"},"ApiIdOrSlug":{"name":"apiIdOrSlug","schema":{"oneOf":[{"$ref":"#/components/schemas/ApiId"},{"$ref":"#/components/schemas/ApiSlug"}]},"in":"path","required":true,"description":"The API identifier, either ApiId or Api Slug"},"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"}},"ApplicationFilters":{"name":"applicationfilter","description":"Filters Applications to retrieve.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ApplicationFilterParameter"},"style":"deepObject"},"DocumentIdOrSlug":{"name":"documentIdOrSlug","schema":{"oneOf":[{"$ref":"#/components/schemas/DocumentId"},{"$ref":"#/components/schemas/DocumentSlug"}]},"in":"path","required":true,"description":"The document identifier, either DocumentId or Document Slug"},"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}},"QueryUnregisteredApplications":{"name":"unregistered","description":"Return applications that do **not** have a registration for the API (regardless of registration status).","in":"query","required":false,"schema":{"type":"boolean"},"allowEmptyValue":true},"SelectedApiAttributes":{"name":"selected","description":"Specifies selected attribute values to calculate filtered API counts.\nUse the format: selected[<attribute_key>]=<attribute_value_1>,<attribute_value_2>\nWhen provided, the response will include selected_api_count for each attribute value.\n","required":false,"in":"query","schema":{"type":"object","example":{"domain":"airlines,flights","visibility":"external"},"additionalProperties":{"type":"string","description":"Comma-separated list of selected values for this attribute key"}},"style":"deepObject"},"SpecId":{"name":"specId","in":"path","required":true,"description":"Contains a unique identifier for this resource.","schema":{"type":"string","format":"uuid"}},"VersionId":{"name":"versionId","in":"path","required":true,"description":"Contains a unique identifier for this resource.","schema":{"type":"string","format":"uuid"}}},"schemas":{"ApiSlug":{"description":"The Api `slug` is used in generated URLs to provide human readable paths.\n\nDefaults to `slugify(name + version)`\n","type":"string","example":"my-api-v1","pattern":"^[\\w-]+$"},"ApiId":{"description":"The API identifier.","type":"string","format":"uuid","example":"9f5061ce-78f6-4452-9108-ad7c02821fd5","readOnly":true},"ApiActionsResponse":{"type":"object","properties":{"actions":{"description":"List of actions that can be performed on the API","type":"object","additionalProperties":false,"properties":{"view":{"type":"boolean"},"register":{"type":"boolean"},"view_documentation":{"type":"boolean"}},"required":["view","register","view_documentation"]}},"example":{"actions":{"view":true,"register":false,"view_documentation":true}},"additionalProperties":false,"required":["actions"],"title":"API Actions Response"},"Api":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"name":{"description":"Name of API.","type":"string","example":"Billing"},"version":{"description":"Version of API.","type":"string","example":"v1","nullable":true},"description":{"type":"string","example":"V1 API for billing functions","nullable":true},"visibility":{"description":"Visibility of the API listing.\nPublic APIs are visible to anyone and do not require authentication to view and retrieve information about them.\nPrivate APIs are only visible to authenticated developers who have been granted access.\n","type":"string","enum":["public","private"]},"slug":{"description":"The API `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":false,"pattern":"^[\\w-]+$"},"auth_strategies":{"description":"Configurations for how the API is able to be registered for by applications.","type":"array","items":{"$ref":"#/components/schemas/AuthStrategy"}},"specifications":{"description":"Returns a list of specifications for an API.\n**Note:** This Beta property is deprecated and will be removed in a GA release.\n","type":"array","items":{"type":"object","required":["id","type"],"properties":{"id":{"description":"The API specification identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"type":{"$ref":"#/components/schemas/ApiSpecType"}}},"deprecated":true},"current_version_summary":{"description":"Summary of the current version (version string of api.version matches version)\n","type":"object","additionalProperties":false,"nullable":true,"properties":{"id":{"description":"The API version identifier.","type":"string","format":"uuid","example":"7710d5c4-d902-410b-992f-18b814155b53","readOnly":true},"spec":{"type":"object","additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/ApiSpecType"}},"required":["type"]}},"required":["id","spec"]},"attributes":{"description":"A set of attributes that describe the API","type":"object","example":{"availability":["general"],"domain":["financial","billing"]},"additionalProperties":{"description":"Set of unique attribute names","type":"array","items":{"description":"A value associated with the attribute","type":"string"}}}},"additionalProperties":false,"required":["id","created_at","updated_at","name","version","description","visibility","slug","specifications","attributes"],"title":"Api"},"ApiListPage":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Api"}}},"required":["meta","data"],"title":"ApiListPage"},"ApiListApplicationsPage":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiApplication"}}},"additionalProperties":false,"required":["meta","data"],"title":"ApiListApplicationsPage"},"ApiApplication":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"The name of the application","type":"string"},"registration_id":{"$ref":"#/components/schemas/NullableUUID"},"registration_status":{"type":"string","enum":["approved","pending","rejected","revoked"],"nullable":true},"auth_strategy":{"$ref":"#/components/schemas/AuthStrategy"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","name","created_at","updated_at","registration_status","registration_id"],"title":"ApiApplication"},"ApiVersionSummary":{"description":"Summary of an API version.","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"version":{"description":"The version string of the API version .","type":"string","example":"v1.0.0"},"spec":{"type":"object","additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/ApiSpecType"}},"required":["type"]}},"additionalProperties":false,"required":["id","version","spec"],"title":"ApiVersionSummary"},"ApiSpecDocumentSummary":{"description":"Info about an API specification document.","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"api_type":{"$ref":"#/components/schemas/ApiSpecType"}},"required":["id","api_type"],"title":"ApiSpecDocumentSummary"},"ApiSpecDocument":{"description":"API specification document.","type":"object","properties":{"api_type":{"$ref":"#/components/schemas/ApiSpecType"},"content":{"type":"string"}},"required":["api_type","content"],"title":"ApiSpecDocument"},"ApiVersion":{"description":"Singular version of an API","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"version":{"description":"The version string of the API version .","type":"string","example":"v1.0.0"},"spec":{"type":"object","additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/ApiSpecType"},"content":{"description":"The JSON string or YAML content of the API specification.","type":"string"}},"required":["type"]}},"additionalProperties":false,"required":["id","version","spec"],"title":"ApiVersion"},"ApiDocument":{"description":"A document for an API. This is a document that is not a part of the API specification.","type":"object","properties":{"id":{"description":"Unique identifier of the document.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"parent_document_id":{"description":"Unique identifier of the parent document.","type":"string","format":"uuid","example":"dd4e1b98-3629-4dd3-acc0-759a726ffee2","nullable":true},"slug":{"description":"Slug of the document. This is used in the URL to identify the document.","type":"string","example":"getting-started"},"content":{"description":"Markdown document","example":"# My Kong api\n\nThis api is powered by Konnect\n","type":"string"},"title":{"description":"Title of the document.","type":"string","example":"Hello World"}},"additionalProperties":false,"required":["id","slug","title","content"],"title":"ApiDocument"},"ApiDocumentTree":{"description":"a document tree","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"parent_document_id":{"type":"string","format":"uuid","example":"dd4e1b98-3629-4dd3-acc0-759a726ffee2","nullable":true},"title":{"description":"the title of the document","type":"string","example":"Getting Started"},"slug":{"description":"the slug of the document","type":"string","example":"getting-started"},"children":{"type":"array","items":{"$ref":"#/components/schemas/ApiDocumentTree"}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","title","slug","children","updated_at","created_at"],"title":"ApiDocumentTree"},"ListApiAttributesPage":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiAttributeItem"}}},"additionalProperties":false,"required":["meta","data"],"title":"ListApiAttributesPage"},"ApiAttributeItem":{"type":"object","properties":{"key":{"type":"string"},"values":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["value","api_count"],"properties":{"value":{"type":"string"},"api_count":{"type":"number"},"selected_api_count":{"description":"The number of APIs that match this attribute value when considering the selected filters.\nOnly present when the 'selected' query parameter is provided.\n","type":"number"}}}}},"additionalProperties":false,"required":["key","values"],"title":"ApiAttributeItem"},"ApiFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"version":{"$ref":"#/components/schemas/StringFieldFilter"},"description":{"$ref":"#/components/schemas/StringFieldFilter"},"attributes":{"$ref":"#/components/schemas/AttributesFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"title":"ApiFilterParameters"},"ApiAttributeFilterParameters":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/StringFieldFilter"}},"title":"API Attribute Filter Parameters"},"DocumentId":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"DocumentSlug":{"description":"Slug of the document. This is used in the URL to identify the document.","type":"string","example":"getting-started","pattern":"^[\\w-]+$"},"ApplicationFilterParameter":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldFilter"}},"title":"ApplicationFilterParameter"},"UUID":{"description":"Contains a unique identifier used for this resource.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"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},"AuthStrategyKeyAuth":{"description":"KeyAuth Auth strategy that the application uses.","type":"object","properties":{"id":{"description":"The Application Auth Strategy ID.","type":"string","format":"uuid","example":"b9e81174-b5bb-4638-a3c3-8afe61a0abf8","readOnly":true},"name":{"type":"string","example":"name","default":"name"},"credential_type":{"type":"string","enum":["key_auth"]},"key_names":{"type":"array","items":{"type":"string"}},"ttl":{"description":"Default maximum Time-To-Live for keys created under this strategy.","type":"object","properties":{"value":{"type":"integer","minimum":1},"unit":{"type":"string","enum":["days","weeks","years"]}},"required":["value","unit"]}},"additionalProperties":false,"required":["id","name","credential_type","key_names"]},"AuthMethods":{"type":"array","items":{"description":"Auth Methods enabled for this strategy","type":"string"},"example":["bearer"]},"AvailableScopes":{"description":"Possible developer selectable scopes for an application. Only present when using DCR Provider that supports it.","type":"array","items":{"type":"string"},"example":["scope1","scope2"]},"AuthStrategyClientCredentials":{"description":"Client Credential Auth strategy that the application uses.","type":"object","properties":{"id":{"description":"The Application Auth Strategy ID.","type":"string","format":"uuid","example":"b9e81174-b5bb-4638-a3c3-8afe61a0abf8","readOnly":true},"name":{"type":"string","example":"name","default":"name"},"credential_type":{"type":"string","enum":["client_credentials","self_managed_client_credentials"]},"auth_methods":{"$ref":"#/components/schemas/AuthMethods"},"available_scopes":{"$ref":"#/components/schemas/AvailableScopes"}},"additionalProperties":false,"required":["id","name","credential_type","auth_methods"]},"AuthStrategy":{"type":"object","discriminator":{"propertyName":"credential_type"},"oneOf":[{"$ref":"#/components/schemas/AuthStrategyKeyAuth"},{"$ref":"#/components/schemas/AuthStrategyClientCredentials"}]},"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"},"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"}}}]},"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"}}}]},"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"}]},"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"},"DocumentFormatContentTypeEnum":{"type":"string","default":"application/json","enum":["text/markdown","application/json","application/vnd.konnect.document-nodes+json"]},"NullableUUID":{"description":"Contains a unique identifier for a resource.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","nullable":true}},"examples":{"ApiActionsExample":{"value":{"actions":{"register":false,"view":true,"view_documentation":true}}},"ListApiAttributesPageExample":{"value":{"data":[{"key":"env","values":[{"value":"production","api_count":5},{"value":"staging","api_count":5}]},{"key":"domain","values":[{"value":"identity","api_count":2},{"value":"booking","api_count":2},{"value":"planning","api_count":4},{"value":"add-ons","api_count":2}]}],"meta":{"page":{"number":1,"size":2,"total":2}}}},"ListApiAttributesWithSelectedExample":{"summary":"Example with selected filters applied","description":"Example response when selected[domain]=identity,booking is provided as a query parameter.\nThe selected_api_count shows the count when only APIs with domain 'identity' or 'booking' are considered.\n","value":{"data":[{"key":"env","values":[{"value":"production","api_count":5,"selected_api_count":2},{"value":"staging","api_count":5,"selected_api_count":2}]},{"key":"domain","values":[{"value":"identity","api_count":2,"selected_api_count":2},{"value":"booking","api_count":2,"selected_api_count":2},{"value":"planning","api_count":4,"selected_api_count":0},{"value":"add-ons","api_count":2,"selected_api_count":0}]}],"meta":{"page":{"number":1,"size":2,"total":2}}}},"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"responses":{"ApiActions":{"description":"API actions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiActionsResponse"},"examples":{"Retrieve API Actions Response":{"$ref":"#/components/examples/ApiActionsExample"}}}}},"ApiGet":{"description":"Response for a single api's details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api"}}}},"ApiList":{"description":"Response for a list of apis.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiListPage"}}}},"ApiListApplications":{"description":"Paginated list of applications either registered or not registered for an API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiListApplicationsPage"}}}},"ApiSpecList":{"description":"List of API specification documents.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiSpecDocumentSummary"}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"additionalProperties":false,"required":["data","meta"]}}}},"ApiVersionList":{"description":"List of API version specification documents.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiVersionSummary"}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"additionalProperties":false,"required":["data","meta"]}}}},"ApiSpecGet":{"description":"API specification document.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiSpecDocument"}}}},"ApiSpecGetRaw":{"description":"API specification content.","content":{"application/json":{"schema":{"type":"string"}}}},"ApiVersionGet":{"description":"API version specification document.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiVersion"}}}},"ApiVersionGetRaw":{"description":"API version specification content.","content":{"application/json":{"schema":{"description":"JSON content of the API specification.","type":"object"}}}},"ApiDocumentList":{"description":"Lists documents for an API.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiDocumentTree"}}},"required":["data"]}}}},"ApiDocumentGet":{"description":"Details for a single document for an API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDocument"}}}},"ListApiAttributes":{"description":"Paginated list of attributes across all APIs published in this portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApiAttributesPage"},"examples":{"ListApiAttributesPageExample":{"$ref":"#/components/examples/ListApiAttributesPageExample"},"ListApiAttributesWithSelectedExample":{"$ref":"#/components/examples/ListApiAttributesWithSelectedExample"}}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"NotAvailable":{"description":"Service not available","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}},"securitySchemes":{"portalAccessToken":{"type":"apiKey","in":"cookie","name":"portalaccesstoken","description":"The Developer portal cookie is meant to be used by the Developer API to authenticate with.\n"}}},"tags":[{"name":"APIs","description":"Endpoints for viewing APIs published to the portal."},{"name":"API Docs","description":"Endpoints for viewing API documentation published to the portal."},{"name":"API Attributes","description":"Endpoints for viewing attributes across APIs published to the portal."}]}
```
