> For the complete documentation index, see [llms.txt](https://academy.cegedim.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://academy.cegedim.cloud/itcare-api/breaking-change.md).

# Breaking change

## Description

* The `cloudName` fields (and its alias `cloud`) are **deprecated** across ITCare APIs.
* **Definitive removal: end of November 2026.**
* Only `cloudId` remains guaranteed over time. To get a cloud's name: `GET /clouds/{cloudId}` → `name` field.

## Why this change ?

* A cloud's name is duplicated across many responses, even though it can be renamed.
* Some endpoints already return a cloud name that is out of sync with the reference value.
* Centralizing the name on a single endpoint removes these discrepancies.

## How to migrate ?

```
BEFORE  →  item.cloudName   (or item.cloud)
AFTER   →  item.cloudId     then   GET /clouds/{cloudId}.name
```

* Identify every place in your code that reads `cloudName` / `cloud`
* Keep `cloudId` as the reference
* Resolve the name via `GET /clouds/{cloudId}`
* **Recommendation**: cache the `cloudId → name` mapping client-side (the name rarely changes), rather than calling once per item
* Deploy before end of November 2026

## Replacement endpoint

**`GET /clouds/{cloudId}`**

```jsonc
{
  "cloudId": 12345,
  "name": "MY-CLOUD"
}
```

* `cloudId`: stable identifier, present in all the responses listed below.
* `name`: reference name, unique and always up to date.

## Impacted endpoints — by domain

> Only endpoints exposing the cloud's **name** are listed. `cloudId` remains available and unchanged everywhere.

### Compute

| Method | Endpoint                                   | Exposed name field |
| ------ | ------------------------------------------ | ------------------ |
| GET    | `/compute/resources`                       | `cloudName`        |
| GET    | `/compute/resources/{id}`                  | `cloudName`        |
| GET    | `/compute/platform/resources-obsolescence` | `cloudName`        |
| GET    | `/compute/backup-policies`                 | `cloudName`        |
| GET    | `/compute/backup-policies/{id}`            | `cloudName`        |
| GET    | `/compute/services`                        | `cloud`            |
| GET    | `/compute/services/{id}`                   | `cloud`            |
| GET    | `/compute/services/{id}/resources`         | `cloudName`        |
| GET    | `/ai/departments`                          | `cloudName`        |
| GET    | `/networking/networks`                     | `cloud`            |
| GET    | `/analytics/matomo`                        | `cloudName`        |
| GET    | `/analytics/matomo/{id}`                   | `cloudName`        |

### Monitoring

| Method | Endpoint                      | Exposed name field |
| ------ | ----------------------------- | ------------------ |
| GET    | `/monitoring/indicators`      | `cloudName`        |
| POST   | `/monitoring/indicators`      | `cloudName`        |
| GET    | `/monitoring/indicators/{id}` | `cloudName`        |

### Search

| Method | Endpoint     | Exposed name field |
| ------ | ------------ | ------------------ |
| GET    | `/search`    | `cloudName`        |
| GET    | `/resources` | `cloudName`        |

### Changes

| Method | Endpoint                               | Exposed name field |
| ------ | -------------------------------------- | ------------------ |
| GET    | `/changes`                             | `cloudName`        |
| GET    | `/patch-parties/{id}/resources/clouds` | `cloudName`        |
| GET    | `/patch-parties/{id}/clouds`           | `cloudName`        |

## Points of attention

* Two field names to handle: `cloudName` on most endpoints, alias **`cloud`** on `/compute/services`, `/compute/services/{id}` and `/networking/networks`.
* **POST** endpoints (`/monitoring/indicators`, `/api/rfcs/{id}/cis`) also return the name in their response — not just GETs.
* Filtering remains based on `cloudId` (no filter by cloud name is available).

## Timeline

| Step                             | Deadline                   |
| -------------------------------- | -------------------------- |
| Publication of this page         | Immediate                  |
| Migration period                 | Until end of November 2026 |
| Removal of `cloudName` / `cloud` | End of November 2026       |

## FAQ / Contact

For any question or migration support, contact your cegedim.cloud **Service Delivery Manager (SDM)**.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://academy.cegedim.cloud/itcare-api/breaking-change.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.