Endpoint URL Changes in Deploy API v4
The endpoint URL structure in the next generation Heretto Deploy API (v4) has been improved. The changes affect both active sync and manual deployments. Customers delivering content to third-party endpoints must update their code.
Who is Affected
Customers who implemented custom scripts directly against Deploy API endpoints or deliver content to third-party endpoints, like devices or machines, must update their endpoint URLs before during the three-month backward compatibility period, after which backward compatibility will cease.
Heretto will maintain backward URL compatibility for three months starting once the rollout of manual deployments v4 is complete. The expected end date for Deploy API v3 support is August 31, 2025. Your Customer Success Manager (CSM) will notify you of the rollout completion date, which will also be provided here.
No action is required for customers publishing only to the Heretto Portal, as the portal automatically uses the improved URL structure.
Changes in the Endpoint URL Structure
Key changes include:
Endpoints now allow vanity URLs that indicate the organization
The
v3value changes tov4The
orgsegment has been removedThe
deploymentIdparameter has changed todeploymentIdentifier
The previous Deploy API version (v3) URL structure was:
https://deploy.heretto.com/v3/org/{organizationId}/deployments/{deploymentId}/searchThe new Deploy API version (v4) URL structure is:
https://{organizationId}.deploy.heretto.com/v4/deployments/{deploymentIdentifier}/searchFor example, the endpoint structure for the company Thunderbird with a deploymentIdentifier of 2x4B2ago1LP68DpJH5B changes as follows:
https://deploy.heretto.com/v3/org/thunderbird/deployments/2x4B2ago1LP68DpJH5B/search
https://thunderbird.deploy.heretto.com/v4/deployments/2x4B2ago1LP68DpJH5B/searchAll API methods remain unchanged; their syntax, parameters, and responses are the same
Once Deploy API v4 is enabled, during the transition period, customers will be able to use both Deploy API v3 and v4 syntax