---
title: "Portal Management"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-dev-2/versions/5b7234ac-c33a-42a8-a490-492f3f315ce9"
---

# Portal Management

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Portal Management","version":"2.2.2","description":"The management API for Portals","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"https://us.api.konghq.com/v2","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v2","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v2","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v2","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v2","description":"India Production region"},{"url":"https://sg.api.konghq.com/v2","description":"Singapore Production region"}],"paths":{"/portals/{portalId}/config":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"get-portal-config","summary":"Get a portal configuration","description":"Get the configuration of the portal","responses":{"200":{"$ref":"#/components/responses/GetPortalConfig"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}}},"tags":["Portals"]},"put":{"operationId":"replace-portal-config","summary":"Replace a portal configuration","description":"Update the configuration of the portal","requestBody":{"$ref":"#/components/requestBodies/ReplacePortalConfig"},"responses":{"200":{"$ref":"#/components/responses/GetPortalConfig"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}}},"tags":["Portals"]},"patch":{"operationId":"update-portal-config","summary":"Update a portal configuration","description":"Update the configuration of the portal","requestBody":{"$ref":"#/components/requestBodies/UpdatePortalConfig"},"responses":{"200":{"$ref":"#/components/responses/GetPortalConfig"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}}},"tags":["Portals"]}},"/portals/{portalId}/customization":{"get":{"operationId":"get-portal-customization","summary":"Get Customization","description":"Returns the portal customization options.","parameters":[{"$ref":"#/components/parameters/PortalId"}],"responses":{"200":{"$ref":"#/components/responses/GetPortalCustomization"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Customization"]},"put":{"operationId":"replace-portal-customization","summary":"Replace Customization","description":"Replace the portal customization options.","parameters":[{"$ref":"#/components/parameters/PortalId"}],"requestBody":{"$ref":"#/components/requestBodies/ReplacePortalCustomization"},"responses":{"200":{"$ref":"#/components/responses/GetPortalCustomization"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Customization"]},"patch":{"operationId":"update-portal-customization","summary":"Update Portal Customization","description":"Update the portal customization options, merging properties.","parameters":[{"$ref":"#/components/parameters/PortalId"}],"requestBody":{"$ref":"#/components/requestBodies/ReplacePortalCustomization"},"responses":{"200":{"$ref":"#/components/responses/GetPortalCustomization"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Customization"]}},"/portals/{portalId}/developer-copy":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"post":{"operationId":"copy-portal-developers","summary":"Copy Developers","description":"Copies developers from the source portal (specified in the path) to the target portal (specified in the request body). The source portal must be a v2 portal, and the target portal must be a v3 portal. This operation copies developer accounts. Both portals must be accessible to the authenticated user.","requestBody":{"$ref":"#/components/requestBodies/PortalCopyDevelopers"},"responses":{"201":{"description":"Developers successfully copied to target portal","content":{"application/json":{"schema":{"type":"object","properties":{"developer_count":{"description":"Number of developers copied to target portal","type":"integer"}}},"examples":{"PortalCopyDevelopersSuccessExample1":{"$ref":"#/components/examples/PortalCopyDevelopersSuccessExample1"}}}}},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"CopyDevelopersBadRequestExample1":{"$ref":"#/components/examples/PortalCopyDevelopersBadRequestExample1"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal Developers"]}}},"components":{"parameters":{"PortalId":{"schema":{"type":"string","format":"uuid"},"name":"portalId","in":"path","required":true,"description":"ID of the portal."}},"schemas":{"PortalCopyDevelopersRequest":{"description":"Request body for copying developers from one portal to another.","type":"object","properties":{"target_portal_id":{"description":"The ID of the destination portal to copy developers to.","type":"string","format":"uuid"},"overwrite_developers":{"description":"If true, existing developers in the destination portal with the same email will be updated to match the source portal developer data. If false, existing developers with the same email will not be modified.","type":"boolean"}},"example":{"target_portal_id":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","overwrite_developers":true},"additionalProperties":false,"required":["target_portal_id","overwrite_developers"],"title":"PortalCopyDevelopersRequest"},"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"}}}]},"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"]},"PortalConfig":{"type":"object","properties":{"data":{"type":"object","additionalProperties":true,"properties":{"header":{"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"}}}}},"additionalProperties":false,"required":["data"],"title":"PortalConfig"},"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},"js":{"type":"object","additionalProperties":false,"properties":{"custom":{"type":"string","nullable":true},"scripts":{"type":"array","items":{"type":"string","pattern":"^https://[^:.]+\\..+$"},"maxItems":20}}},"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"}},"examples":{"PortalCopyDevelopersRequestExample1":{"value":{"target_portal_id":"987e6543-e21b-12d3-a456-426614174999","overwrite_developers":true}},"PortalCopyDevelopersSuccessExample1":{"value":{"developer_count":42}},"PortalCopyDevelopersBadRequestExample1":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:1433447772874964729","detail":"Invalid Parameters","invalid_parameters":[{"field":"target_portal_id","rule":"required","reason":"\"target_portal_id\" is required","source":"body"}]}},"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"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"requestBodies":{"UpdatePortalConfig":{"description":"Request schema to replace the portal configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalConfig"}}}},"ReplacePortalCustomization":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalCustomization"}}}},"ReplacePortalConfig":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalConfig"}}}},"PortalCopyDevelopers":{"description":"Copy developers in a portal. The portalId in parameters is the source portal.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalCopyDevelopersRequest"},"examples":{"Example 1":{"$ref":"#/components/examples/PortalCopyDevelopersRequestExample1"}}}}}},"responses":{"GetPortalConfig":{"description":"Response for a portal configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalConfig"}}}},"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"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"GetPortalCustomization":{"description":"Response for a portal customization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalCustomization"}}}}},"securitySchemes":{"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":"Portals","description":"APIs related to Configuration of Konnect Developer Portals."},{"name":"Portal Developers","description":"APIs related to Konnect Developer Portal Developers."},{"name":"Portal Customization","description":"APIs related to Konnect Developer Portal Customization."}],"security":[{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
