---
title: "Internal Portal"
url: "https://nov18-dev.movespot.fyi/apis/internal-portal-1/versions/6cf3dd19-2471-4683-ab50-f062b4345eaa"
---

# Internal Portal

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Internal Portal","description":"Internal api for konnect to allow retrieving of entities in konnect db.","version":"1.0.2","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"http://konnect-api.konnect.svc.cluster.local:300/v0","description":"Konnect cluster"}],"paths":{"/internal/application-auth-strategies/{authStrategyId}":{"parameters":[{"$ref":"#/components/parameters/AuthStrategyId"}],"get":{"operationId":"get-authstrat","summary":"Get an Auth Strategy","description":"Returns a raw database representation of the auth strategy.","responses":{"200":{"$ref":"#/components/responses/GetAuthStrat"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["App Auth Strategies"]}},"/internal/portals/{portalId}":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"get-portal","summary":"Get a Portal","description":"Returns a raw database representation of the portal.","responses":{"200":{"$ref":"#/components/responses/GetPortal"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["portal"]}},"/internal/control-planes/{controlPlaneId}/gateway-services/{gatewayServiceId}/product-version":{"parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/GatewayServiceId"}],"get":{"operationId":"get-cp-gw-product-version","summary":"Get Product Version by CP/Service ID","description":"retrieves a product version id by control plane and gateway service","responses":{"200":{"$ref":"#/components/responses/GetProductVersion"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["api-products"]}},"/internal/portals/{portalId}/developers/{developerId}":{"parameters":[{"$ref":"#/components/parameters/PortalId"},{"$ref":"#/components/parameters/DeveloperId"}],"patch":{"operationId":"update-developer","summary":"Update Developer","description":"**Pre-release Endpoint**\nThis endpoint is currently in beta and is subject to change.\n\nInternal endpoint to update the status of a developer.","requestBody":{"$ref":"#/components/requestBodies/UpdateDeveloper"},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"UpdateDeveloperBadRequestExample1":{"$ref":"#/components/examples/UpdateDeveloperBadRequestExample1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Developers"]},"delete":{"operationId":"delete-developer","summary":"Delete Developer","description":"**Pre-release Endpoint**\nThis endpoint is currently in beta and is subject to change.\n\nInternal endpoint to delete a developer on a portal.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Developers"]}}},"components":{"parameters":{"AuthStrategyId":{"name":"authStrategyId","description":"ID of the auth strategy to use for the application","in":"path","required":true,"schema":{"type":"string","format":"uuid","example":"ebbac5b0-ac89-45c3-9d2e-c4542c657e79"}},"controlPlaneId":{"name":"controlPlaneId","in":"path","required":true,"schema":{"type":"string","format":"uuid","example":"9524ec7d-36d9-465d-a8c5-83a3c9390458"},"description":"The UUID of your control plane. This variable is available in the Konnect manager."},"DeveloperId":{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"developerId","in":"path","required":true,"description":"ID of the developer."},"GatewayServiceId":{"schema":{"type":"string","format":"uuid"},"name":"gatewayServiceId","in":"path","required":true,"description":"ID of the gateway service."},"PortalId":{"schema":{"type":"string","format":"uuid"},"name":"portalId","in":"path","required":true,"description":"ID of the portal."}},"schemas":{"Portal":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"display_name":{"type":"string"},"uri":{"type":"string"},"custom_domain":{"type":"string"},"is_domain_verified":{"type":"boolean"},"logo":{"type":"string"},"logo_filename":{"type":"string"},"favicon":{"type":"string"},"favicon_filename":{"type":"string"},"is_public":{"type":"boolean"},"authentication_enabled":{"type":"boolean"},"default_api_visibility":{"$ref":"#/components/schemas/Visibility"},"default_page_visibility":{"$ref":"#/components/schemas/Visibility"},"auto_approve_developers":{"type":"boolean"},"auto_approve_applications":{"type":"boolean"},"rbac_enabled":{"type":"boolean"},"config":{"type":"object","additionalProperties":true},"version":{"type":"string"},"customization":{"$ref":"#/components/schemas/PortalCustomization"},"labels":{"$ref":"#/components/schemas/Labels"},"description":{"type":"string"},"default_application_auth_strategy":{"$ref":"#/components/schemas/NullableAuthStrategy"},"sipr_enabled":{"$ref":"#/components/schemas/SourceIPEnabled"}},"additionalProperties":true,"required":["id","default_application_auth_strategy","name","uri","labels","version"]},"ProductVersion":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"additionalProperties":false,"required":["id"]},"AuthStrategy":{"allOf":[{"$ref":"#/components/schemas/BaseAuthStrategy"}]},"NullableAuthStrategy":{"allOf":[{"$ref":"#/components/schemas/BaseAuthStrategy"}],"nullable":true},"BaseAuthStrategy":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"display_name":{"type":"string"},"strategy_type":{"type":"string"},"configs":{"type":"object"},"labels":{"$ref":"#/components/schemas/Labels"},"dcr_provider":{"$ref":"#/components/schemas/NullableDcrProvider"}},"required":["id","name","display_name","strategy_type","dcr_provider","configs","labels"]},"NullableDcrProvider":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"provider_type":{"type":"string"},"issuer":{"type":"string"},"dcr_config":{"type":"object"},"labels":{"$ref":"#/components/schemas/Labels"}},"nullable":true,"required":["id","name","provider_type","issuer","dcr_config","labels"]},"UpdateDeveloperRequest":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/DeveloperStatus"}},"example":{"status":"approved"},"additionalProperties":false,"title":"UpdateDeveloperRequest"},"DeveloperStatus":{"description":"The status of a developer in a portal. Approved developers can log in, create applications, and view and register for products they have access to. Pending, revoked, and rejected developers cannot login or view any non-public portal information, or create or modify applications or registrations.","type":"string","example":"approved","enum":["approved","pending","revoked","rejected"],"title":"DeveloperStatus"},"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"},"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"}}}]},"Visibility":{"type":"string","enum":["public","private"]},"PortalMenuItem":{"type":"object","properties":{"path":{"description":"The absolute path of a page in a portal with a leading slash.","type":"string","example":"/about/company","maxLength":512},"title":{"description":"The link display text","type":"string","example":"My Page"},"visibility":{"description":"Whether a menu item is public or private. Private menu items are only accessible to authenticated users.","type":"string","example":"public","enum":["public","private"]},"external":{"description":"When clicked, open the link in a new window","type":"boolean"}},"additionalProperties":false,"required":["path","title","visibility","external"]},"PortalFooterMenuSection":{"type":"object","properties":{"title":{"description":"The footer menu section title","type":"string","maxLength":512},"items":{"type":"array","items":{"$ref":"#/components/schemas/PortalMenuItem"}}},"additionalProperties":false,"required":["title","items"]},"PortalCustomization":{"description":"The custom settings of this portal","type":"object","properties":{"theme":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","nullable":false},"mode":{"type":"string","enum":["light","dark","system"]},"colors":{"type":"object","additionalProperties":false,"properties":{"primary":{"type":"string","example":"#000000","nullable":false,"pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$","x-validation-message":"must be a valid hex color value"}}}}},"layout":{"type":"string","nullable":false},"css":{"type":"string","nullable":true},"menu":{"type":"object","additionalProperties":false,"properties":{"main":{"type":"array","items":{"$ref":"#/components/schemas/PortalMenuItem"}},"footer_sections":{"type":"array","items":{"$ref":"#/components/schemas/PortalFooterMenuSection"}},"footer_bottom":{"type":"array","items":{"$ref":"#/components/schemas/PortalMenuItem"}}}},"spec_renderer":{"type":"object","additionalProperties":false,"properties":{"try_it_ui":{"description":"Enable in-browser testing for your APIs. All linked gateways must have the CORS plugin configured.","type":"boolean","default":true},"try_it_insomnia":{"description":"Enables users to open API specifications in Insomnia to explore and send requests with the native client. Only public API specifications are supported.","type":"boolean","default":true},"infinite_scroll":{"description":"Display the full spec on a single, scrollable page. If disabled, documentation, endpoints, and schemas appear on separate pages.","type":"boolean","default":true},"show_schemas":{"description":"Control whether schemas are visible in your API specs. When enabled, schemas appear in the side navigation below the endpoints.","type":"boolean","default":true},"hide_internal":{"description":"Manage visibility of internal endpoints and models.","type":"boolean","default":false},"hide_deprecated":{"description":"Manage visibility of deprecated endpoints and models.","type":"boolean","default":false},"allow_custom_server_urls":{"description":"Let users define a custom server URL for endpoints. This will be used to generate code snippets and to test the API. The URL is client-side only and is not saved.","type":"boolean","default":true}}},"robots":{"type":"string","nullable":true}},"additionalProperties":false,"title":"PortalCustomization"},"SourceIPEnabled":{"description":"Whether ip allow list is enabled for the organization.","type":"boolean","example":true,"default":false},"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"}}}]},"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"}}}]}},"examples":{"UpdateDeveloperExampleApproved":{"value":{"status":"approved"}},"UpdateDeveloperExamplePending":{"value":{"status":"pending"}},"UpdateDeveloperExampleRejected":{"value":{"status":"rejected"}},"UpdateDeveloperExampleRevoked":{"value":{"status":"revoked"}},"UpdateDeveloperBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"status","rule":"enum","choices":["approved","pending","rejected","revoked"],"reason":"status must be one of the following values: approved, pending, rejected, revoked"}]}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}},"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"ForbiddenExample":{"value":{"status":403,"title":"Forbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}}},"requestBodies":{"UpdateDeveloper":{"description":"Update a developer.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDeveloperRequest"},"examples":{"Approved":{"$ref":"#/components/examples/UpdateDeveloperExampleApproved"},"Pending":{"$ref":"#/components/examples/UpdateDeveloperExamplePending"},"Rejected":{"$ref":"#/components/examples/UpdateDeveloperExampleRejected"},"Revoked":{"$ref":"#/components/examples/UpdateDeveloperExampleRevoked"}}}}}},"responses":{"GetPortal":{"description":"A raw database portal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Portal"}}}},"GetAuthStrat":{"description":"A raw database auth strategy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthStrategy"}}}},"GetProductVersion":{"description":"A product version","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVersion"}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"Forbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/ForbiddenExample"}}}}}}},"tags":[{"name":"portal"},{"name":"App Auth Strategies"},{"name":"api-products"}]}
```
