The version object and the allowed CRUD operations on the related resource endpoint

Versions are associated with some of the Provisioning API resources and are created upon every update or cancellation of the related resource to help you track the history of each resource's data changes.

Roles are tracked also across creation. This is the only exception. For all other versionable resources creation is not tracked by the versions API.

Each version object contains information about the event that generated it (one of update or destroy — for roles, also create), the type of resource that has been modified, the request involved, the application, worker, or user that triggered the change, and more. You can find the changes history inside the changes object which shows, for each modified attribute, the values before and after the change. Changes to non-fetchable attributes (i.e. that are not exposed to the user in the single resource object) are tracked anyway by the versions API but you won't be able to see the modified values.

For any resource, the related changes history is stored for 1 year.

Versionable resources

At the moment, these are the resources that support versioning:

This is an immutable API, meaning that create, update, and delete operations are not allowed on this endpoint. You can only fetch a list of versions or a specific single one.

Last updated