Dev Portal breaking changes

Uses: Dev Portal
Related Documentation
Incompatible with
on-prem
Related Resources

With the GA release of the new Dev Portal (v3) in June 2025, some features and APIs have been updated or deprecated. See the following sections for a list of the changed features and how you can update your automation and workflows accordingly.

Dev Portal default domain names

During Tech Preview and Beta, new Dev Portals were served on https://{portalId}.edge.{geo}.portal.konghq.tech. The https://{portalId}.edge.{geo}.portal.konghq.tech domain name will be discontinued on October 1, 2025 in favor of the https://{portalId}.{geo}.kongportals.com domain. During the transition period from Dev Portal v3 release to October 2025, both domain names will be served, but Kong recommends updating your domain names to the new naming convention during the transition period.

You must update Dev Portal domain names everywhere they are referenced, including the following:

  • OIDC or SAML callback URLs .
  • CORS plugin origin configuration.
  • All links and bookmarks to your Dev Portal.
  • Custom domain migration.
    All beta customers will receive emails with guidance on migrating custom domains.

API specifications deprecated in favor of API versions

The API specification endpoint is being deprecated on October 1, 2025 in favor of the API versions endpoint. Moving to the /apis/{id}/versions endpoints allows you to support additional versions of a spec. Existing automation with specifications operations should work in parallel during this transition. Each existing specification will be mapped one-to-one with a wrapping version entity.

The following /apis/{id}/specifications endpoints will be deprecated on October 1, 2025 and replaced with /apis/{id}/versions endpoints:

Old endpoint

New endpoint

GET /v3/apis/{id}/specifications GET /v3/apis/{id}/versions
GET /v3/apis/{id}/specifications/{specId} GET /v3/apis/{id}/versions/{versionId}
PATCH /v3/apis/{id}/specifications/{specId} PATCH /v3/apis/{id}/versions/{versionId}
DELETE /v3/apis/{id}/specifications/{specId} DELETE /v3/apis/{id}/versions/{versionId}
POST /v3/apis/{id}/specifications POST /v3/apis/{id}/versions

Auth strategy sync errors moving

Auth strategy sync errors will be moving from the API entity to the implementation entity.

The following endpoints are impacted:

  • GET /v3/apis
  • GET /v3/apis/{id}

The auth_strategy_sync_error property will no longer be included on the API entity response. It will now be optionally included on the API implementation service property object. For example, if there’s an error syncing the auth strategy configuration to the given implementation service when sending a GET request to the /v3/apis/{id}/implementations endpoint or a GET request to the /v3/api-implementations endpoint, the response.body.service.auth_strategy_sync_error will be present.

Nested developers property removed from application responses

response.body.developers will no longer be included in the following endpoints:

  • GET /v3/portals/{portalId}/applications
  • GET /v3/portals/{portalId}/applications/{applicationId}

Use the GET /v3/portals/{portalId}/applications/{applicationId}/developers endpoint instead.

Implementations service property is now optional

You no longer need to specify the Gateway Service to associate with an implementation for the /v3/apis/{id}/implementations endpoints.

Developer entity responses no longer include application_count

The following endpoints no longer include application_count in the response body:

  • GET /v3/portals/{portalId}/developers
  • GET /v3/portals/{portalId}/developers/{developerId}

API documentation labels property removed

API documentation entities will no longer support labels:

  • GET /v3/apis/{apiId}/documents
  • GET /v3/apis/{apiId}/documents/{documentId}
  • PATCH /v3/apis/{apiId}/documents/{documentId}

Use the API entity instead.

Portal logo and favicon no longer use filename

Portal logo and favicon asset endpoints won’t accept filename in the request bodies:

  • PUT /v3/portals/{portalId}/assets/logo
  • PUT /v3/portals/{portalId}/assets/favicon

Move page and API documentation endpoints are now POST, not PUT

The following endpoint HTTP methods have been updated:

  • PUT /v3/portals/{portalId}/pages/{pageId}/move has changed to POST
  • PUT /v3/apis/{apiId}/documents/{documentId}/move has changed to POST
Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!