API change log

Find a summary of the latest changes, improvements, and updates for the IBM Cloud® Code Engine API plug-in. Changes to existing API versions are designed to be compatible with existing client applications.

API versioning

API requests require a version parameter that takes the date in the format version=YYYY-MM-DD. Send the version parameter with every API request.

When the API is changed in a way that is not compatible with previous versions, a new minor version is released. To take advantage of the changes in a new version, change the value of the version parameter to the new date. If you're not ready to update to that version, don't change your version date.

Active version dates

The following table shows the service behavior changes for each version date. Switching to a later version date activates all changes that are introduced in earlier versions.

Changes in the IBM Cloud Code Engine API
Version date	Version number	Summary of changes
`2025-07-10`	Version 2.2.0	As part of the introduction of `persistent_data_stores` as a Volume Mount type for apps and jobs, the `name` property of entries in `run_volume_mounts` is no longer supported.
`2024-05-13`	Version 2.1.0	Environment variables defined and set by Code Engine are now split out from user-defined environment variables and are exposed as part of the `computed_env_variables` field in the API.
`2022-12-09`	Version 2.0.0
`2021-03-31`	Version 1.0.0

17 September 2025

Added a new run_volume_mounts type of persistent_data_stores for apps, jobs, and jobruns.

See Create an app API.

See Update an app API.

See Create a job API.

See Update a job API.

See Create a job run API.

03 April 2025

Added support for HMAC auth secrets. Specify to create HMAC auth secrets with the format field and specify the details of HMAC auth secrets with the hmac_auth field.

See Create a secret API.

Added the run_compute_resource_token_enabled property for app create, app update, job create, job update, function create, and function update. Use this property to enable or disable Trusted Profiles support for the selected resource.

See Create an app API.

See Update an app API.

See Create a job API.

See Update a job API.

See Create a function API.

See Update a function API.

Replaced nodejs-18 support with nodejs-20

See List the function runtimes API.

See Create a function API.

See Update a function API.

21 February 2025

Added support for run_build_params property for build and buildrun.

See Create a build API.

See Get a build API.

See Update a build API.

See Create a build run API.

See Get a build run API.

16 January 2025

Added jobrun indices_details property to the existing jobrun status_details property.

See Get a job run API.

21 November 2024

Added support for allowed outbound destinations in the API.

See List allowed outbound destinations API.

See Create an allowed outbound destination API.

See Get an allowed outbound destination API.

See Delete an allowed outbound destination API.

See Update an allowed outbound destination API.

17 May 2024

Added support for functions in the API.

See List function runtimes API.

See List functions API.

See Create a function API.

See Get a function API.

See Delete a function API.

See Update a function API.

30 January 2024

Added support for the build and buildrun properties for jobs.

See Create a job API.

See Get a job API.

See Update a job API.

04 January 2024

Added support for the scale_array_size_variable_override property for job runs.

See Create a job run API.

03 November 2023

Added support for domain mappings in the API.

See List domain mappings API.

See Create a domain mapping API.

See Get a domain mapping API.

See Delete a domain mapping API.

See Update a domain mapping API.

27 September 2023

Added support for liveness and readiness probes for applications in the API. Set the probes and their properties when you create or update an application with the API.

See Create an application API.

See Update an application API.

22 June 2023

Added support for service binding operations in the API.

See List bindings API.

See Create a binding API.

See Get a binding API.

See Delete a binding API.

Added support for service access secrets, which are required for service binding operations. Specify to create service access secrets with the format field and specify the details of service access secrets with the service_access field.

See Create a secret API.

30 May 2023

Added support to get status details for a project.

See Get the status details for a project API.

27 March 2023

Added support to provide private and public egress IP addresses for a project.

See List egress IP addresses for projects API.

See Code Engine public and private IP addresses.

Improved documentation for create and update of secrets to include the One of fields for specific secret formats as part of the data field.

See Create a secret API.

See Update secret API.

9 December 2022

IBM Cloud® Code Engine API Version 2.0.0

API Version 2.0.0 released

This version of the API is enhanced to support more Code Engine resources, and more regions.

The API supports the following Code Engine resources: projects, reclamations, apps, revisions, job, job runs, builds, build runs, config maps, and secrets. See Code Engine API.
The API supports more regional endpoints. See Regions for Code Engine.