Enable versioning for a scripted REST API

Enable versioning for a scripted REST API to provide multiple versions of the API while maintaining compatibility with existing integrations.

Before you begin

There must be a Scripted REST API defined before you can enable versioning.

Role required: web_service_admin

Procedure

  1. Navigate to System Web Services > Scripted REST APIs.
  2. Select a scripted REST API record.
  3. Click Enable versioning.
    The Enable versioning pop up appears. The Make version v1 default check box is selected by default.
  4. (Optional) Clear the Make version v1 default check box to enable versioning without a default version.
    Versioned APIs without a default version are accessible only by using the version-specific URI. Make version v1 default, or select a different version as default after you enable versioning.
  5. Click OK.
    The Versioning embedded list is added to the Scripted REST API form. You can add new versions or control which version is default from this list.