Enforce Namespace Checks for APIs
Objective
F5 Distributed Cloud Services has planned an update to the URL slug format for a subset of our API endpoints. This change is designed to enhance the security, clarity, and consistency of the affected API paths. All clients consuming the affected APIs will need to confirm or update their requests to align with the updated slugs, to ensure continued functionality.
This migration reference guide outlines the necessary steps to transition to the updated slug format, including the new namespace and endpoint structure.
Enforcement Timeline
Enforcement date: October 1, 2025
By the enforcement date, all the unsupported API endpoints will error out.
What Has Changed?
F5 has updated the structure of the API endpoint slugs, to improve the clarity and consistency of the existing namespaces in the slugs. The endpoint format remains the same, but the namespace has been redefined to incorporate better understanding and organization.
Slug
Method: CustomList
URL: /api/web/custom/namespaces/{namespace}/roles
Supported Namespace: system/shared
Note: The endpoint structure remains the same. However, the namespaces were improved for clarity and consistency of how namespaces are represented within the API paths.
Example of Supported New Request Format
Method: CustomList
URL: /api/web/custom/namespaces/shared/roles
Or...
URL: /api/web/custom/namespaces/system/roles
Example of Unsupported API Call After Migration
Method: CustomList
URL: /api/web/custom/namespaces/all-ns/roles
This change applies to all API endpoints listed.
Important: This change will be enforced on all API endpoints with one exception. The API/service credentials are currently exempt from enforcement until future notice.
Why Are We Making This Change?
The appropriate use of namespaces helps categorize and clarify the resources within the APIs, ensuring that endpoints are easy to understand and navigate. By refining how namespaces are applied, F5 has enhanced consistency across our platform and improved the overall organization of APIs. This change is part of F5's ongoing efforts to provide a more intuitive, scalable, and maintainable API experience.
FAQ
Will the old endpoint be supported indefinitely?
No, the old endpoint will only support the previously supported namespaces after the release of this change. F5 recommends transitioning as soon as possible to avoid any disruptions.
Do I need to change anything other than the URL path?
No, the only change required is updating the URL path in your requests. The functionality of the API and the response structure will remain unchanged.
What happens if I do not migrate before the deadline?
If an API call is made with an unsupported namespace, an error will be returned from the backend.
Will there be an automatic redirect from the old URLs to the new ones?
No, there will not be an automatic redirect.