Skip to content

Migrate APIRule from Version v1beta1 to Version v2 ​

APIRule custom resource (CR) v1beta1 is deleted. You must migrate all your APIRule CRs to version v2. Learn how to perform the migration.

WARNING

APIRule CRD v2 is the latest stable version.

  • You can no longer create, edit, or delete APIRules v1beta1. Existing configurations continue to function as expected, but to make any changes, migrate to version v2.
  • APIRules v1beta1 are no longer visible in the Kyma dashboard. You can still view them with kubectl, but they display in the converted v2 format.
  • With release 3.10, reconciliation of APIRules v1beta1 is disabled and the API Gateway module no longer manages them. Migrate before 19 August 2026 (fast channel) or 2 September 2026 (regular channel) to avoid downtime. Migrating after these dates may temporarily disrupt workload availability and access.

For the APIRule deletion timeline for SAP BTP, Kyma runtime, see API Gateway What's New notes.

To migrate to version v2, follow the steps:

  1. To identify which APIRules must be migrated, run the following command:

    bash
    kubectl get apirules.gateway.kyma-project.io -A -o json | jq '.items[] | select(.metadata.annotations["gateway.kyma-project.io/original-version"] == "v1beta1") | {namespace: .metadata.namespace, name: .metadata.name}'
  2. If two or more of your APIRules target the same workload, apply an additional AuthorizationPolicy to avoid traffic disruption during migration. See Migrate Multiple APIRules Targeting the Same Workload from v1beta1 to v2.

  3. To retrieve the complete spec with the rules field of an APIRule in version v1beta1, see Retrieving the Complete spec of an APIRule in Version v1beta1.

  4. To migrate an APIRule from version v1beta1 to version v2, follow the relevant guide:

To delete APIRules v1beta1, use v2 API:

bash
kubectl delete apirules.v2.gateway.kyma-project.io -n $NAMESPACE $APIRULE_NAME -oyaml

For more information about APIRule v2, see also APIRule v2 Custom Resource and Changes Introduced in APIRule v2.