# Deprecations

# Planned Deprecations

# [103035] - Introduction of modularized API v2 definition `CLOUD`

In 1 year you will need to transfer from API v1 to new API v2 definitions as v1 will be deleted in the future. We will be informing you about this action and in which, particular release it will take place but be prepared. If you want to use new features, we encourage you to migrate to new API v2.

We introduced new APIs in new paths, which allows us to version and deploy each of the services separately.

We have changed the construct of our API. First, you will see the service, which receives your API call, then its version, and then the rest of the URL you normally use.

Old API v1 URL:

https://api-{salt}.platform-dev.ability.abb/v1/objects/{objectId}/models/{modelId}/methods/{name}

New API v2 URL:

https://api-{salt}.platform-dev.ability.abb/commanding-api/v2/objects/{objectId}/models/{modelId}/methods/{name}

The deprecation is planned for the 2023 Q2 time frame.

# [102598] - Users will no longer be able to use parameters in Global Storage endpoint `CLOUD`

In order to align the code with the Ability Development Portal, it will no longer be possible to use parameters in the storage/global/files/upload endpoint. Instead, use the body in the endpoint to provide the path and file.

The deprecation is planned for the 2023 Q4 time frame.

# Edge Proxy will be replaced by Edge Agent `EDGE`

The Edge Proxy will be deprecated and will be replaced by the Edge proxy. The update will occur as follows:

Phase 1: Upgrade Edge Proxy to Edge Agent
Phase 2: Update Device API V1 to V2 in custom modules. Upgrading your Edge will be a prerequisite to be able to use Device API V2.

[56544] - Device API V1 - End of Support will require all Edge nodes to complete Phase 2.

The deprecation is planned for the 2022 Q4 time frame.

# [92908] - Changed file upload publisher trigger to IoT Hub notification `CLOUD`

Due to security reasons, it is no longer possible to upload files to global storage using the POST /api/v1/objects/{objectId}/models/{modelId}/files/{path} endpoint.

However, the global /api/v1/storage/global/files/upload endpoint remains unchanged.

The deprecation is planned for the 2023 Q4 time frame.

# [89968] - Azure WAF service `CLOUD` `EDGE`

The Web Application Firewall ( WAF ) for the Ability Platform is changing. The Akamai WAF is replacing the Microsoft WAF. Akamai provides the same functionality with notable cost savings. The configuration will be migrated in phases and the Microsoft WAF will be retired when all environments connected to a particular global are upgraded to 21.2.1 or newer.

# Phase 1: The Global endpoints will be moved to Akamai

Akamai is supported with the Global 20.10 and newer. Once the global endpoints are moved, the global will not require the Microsoft WAF.

Edge Security Incompatibility with Akamai protected GIG endpoints: Edge Security 21.2.1 ( 3.2.4 ) contains a correction [#86073] that is required when connecting to the GIG server configured with the Akamai WAF. Edge Security 21.2.1 will be required to provision any new Edge nodes are provisioned when either of these configuration parameters are enabled:

REGISTER_DEV_ID=1

Verify Device ID duplication (1 : Enable , 0 : Disable)

DEVICEID_DUPLICATION_CHECK_REQUIRED=1

If Edge Security cannot be upgraded immediately, older software can be used if both of these are disabled. For existing Edge nodes that have successfully provisioned, the GIG is never accessed again.

# Phase 2: When all the connected environments are migrated to Cloud 21.2.1 or newer, the Microsoft WAF can be retired

Ability Operations will clearly communicate the migration process to the Akamai WAF and any customer actions required.

As of now, the deprecation is planned for Future undefined time frame.

# [56544] - Device API v1 - End Of Support `CLOUD`

The platform will no longer support Device API v1 messages in the future.

The following event D2C messages will be phased out:

Abb.Ability.Device.Created
Abb.Ability.Device.Updated
Abb.Ability.Device.Deleted
Abb.Ability.Device.SyncModel In addition, the publish-subscribe notification has changed to the v2 format.

The time table for this deprecation is not scheduled at this time. All Edge nodes will be required to upgrade to the Edge Agent before V1 is deprecated.

# [45918] - Subscription Manager `CLOUD` `EDGE`

Enable a device to subscribe to platform events

The functionality of creating a default subscription for configuration models during a model.create action has been deprecated. Instead, the subscription can be requested via a separate event, i.e. subscription.create.

The deprecation is planned for the 2023 Q2 time frame.

# Deprecated

# [82309] - Restricting definition member names `CLOUD`

Users can no longer create or update properties/variables/alarms/events, etc., using the names listed below:

"properties"
"variables"
"methods"
"attributes"
"references"
"events"
"alarms"
"functions"

These names are reserved for ABB Ability™ only.

Deprecated in: 22.1

# [96149] - Device API v2 - new action name for accepting batch requests `CLOUD` `EDGE`

The topic and action names for accepting batch requests has been updated, so that the specifications stay consistent with other V2 APIs.

From "action": "batch" to "action": "batch.execute"

Deprecated in 21.3.1

# [84515] - ASE Deprecation - Migration of environments `CLOUD`

This change aligns with the previously released changes to the region API and provides a cost-optimization-driven removal of App Service Environment (ASE) used internally for hosting services inside Ability Platform. It will disable VNet peering of client's applications and testing machines with Ability Platform instance virtual networks and API Management service. Compared to VNet peering, IP allowlisting will give secure access to APIs needed by client applications and testing machines. In order to configure allowlisting, Clients need to provide Operations with their application and test machine IP addresses. It is important that this is done before the update.

An alternative method to allow the continued use of VNet peering (at an incremental cost) is under evaluation. Please contact the operations team for additional details on the status of this option before upgrading if this method is required.

Deprecated in: 21.3.1

# [75019] - Support for Ubuntu 20.04 for Edge Security Components `EDGE`

TPM 1.2 packages are deprecated as of this release. All development should move to TPM 2.0 solutions.

Deprecated in: 3.2.3

# [74509] - Restricting access Region API endpoints after deprecation of PoC Principal Manager Portal. OAuth Proxy API migrated to new URL `CLOUD`

# Deprecation Announcement

Update June 28, 2021

Following the deprecation of the PoC Principal Manager Portal in 20.10, starting the following release, access to the Regional API endpoints will be limited to ~~peered Virtual Networks~~ allowlisted public IP addresses.

Also URL of the OAuth proxy (used to get tokens for applications) will be updated to follow the naming convention of the rest of the Region APIs.

# Deprecated Funtionality

Region APIs are no longer available over the public internet.

Several Region APIs (for example used by B2C in OAuth flow) are still published for public access. The rest of Region APIs (for example Principal Manager APIs, OAuth proxy) are available only for allowlisted caller IP addresses. Please contact Operations Team to have the public IP of your application or test machine allowlisted.

OAuth proxy URL is updated to following the naming convention of the other Region APIs.

Deprecated in: 21.2.1

# [71569] - Remove legacy file endpoints `CLOUD`

The following endpoints will be removed from Data Access. Their replacements are also listed.

File Upload

Legacy Operation

POST storage/object/files/upload

New Operation

POST objects/{objectId}/models/{modelId}/files/{path}

File Download

Legacy Operation

POST storage/object/files/download

New Operation

GET objects/{objectId}/models/{modelId}/files/{path}

File Delete

Legacy Operation

POST storage/object/files/delete

New Operation

DELETE objects/{objectId}/models/{modelId}/files/{path}

Deprecated in: 20.10

# [71878] - Deprecation of Proof of Concept Principle Manager Portal `CLOUD`

The PoC Principle Manager Portal was deprecated, and is replaced by the Ability Platform Admin Portal.

Deprecated in: 20.10

← Factory Automation Cloud Region and Instance Archive →

# Deprecations

# Planned Deprecations

# [103035] - Introduction of modularized API v2 definition CLOUD

# [102598] - Users will no longer be able to use parameters in Global Storage endpoint CLOUD

# Edge Proxy will be replaced by Edge Agent EDGE

# [92908] - Changed file upload publisher trigger to IoT Hub notification CLOUD

# [89968] - Azure WAF service CLOUD EDGE

# Phase 1: The Global endpoints will be moved to Akamai

# Phase 2: When all the connected environments are migrated to Cloud 21.2.1 or newer, the Microsoft WAF can be retired

# [56544] - Device API v1 - End Of Support CLOUD

# [45918] - Subscription Manager CLOUD EDGE

# Deprecated

# [82309] - Restricting definition member names CLOUD

# [96149] - Device API v2 - new action name for accepting batch requests CLOUD EDGE

# [84515] - ASE Deprecation - Migration of environments CLOUD

# [75019] - Support for Ubuntu 20.04 for Edge Security Components EDGE

# [74509] - Restricting access Region API endpoints after deprecation of PoC Principal Manager Portal. OAuth Proxy API migrated to new URL CLOUD

# Deprecation Announcement

# Deprecated Funtionality

# [71569] - Remove legacy file endpoints CLOUD

# [71878] - Deprecation of Proof of Concept Principle Manager Portal CLOUD

# [103035] - Introduction of modularized API v2 definition `CLOUD`

# [102598] - Users will no longer be able to use parameters in Global Storage endpoint `CLOUD`

# Edge Proxy will be replaced by Edge Agent `EDGE`

# [92908] - Changed file upload publisher trigger to IoT Hub notification `CLOUD`

# [89968] - Azure WAF service `CLOUD` `EDGE`

# [56544] - Device API v1 - End Of Support `CLOUD`

# [45918] - Subscription Manager `CLOUD` `EDGE`

# [82309] - Restricting definition member names `CLOUD`

# [96149] - Device API v2 - new action name for accepting batch requests `CLOUD` `EDGE`

# [84515] - ASE Deprecation - Migration of environments `CLOUD`

# [75019] - Support for Ubuntu 20.04 for Edge Security Components `EDGE`

# [74509] - Restricting access Region API endpoints after deprecation of PoC Principal Manager Portal. OAuth Proxy API migrated to new URL `CLOUD`

# [71569] - Remove legacy file endpoints `CLOUD`

# [71878] - Deprecation of Proof of Concept Principle Manager Portal `CLOUD`