|
6 | 6 |
|
7 | 7 | Port API's `pages` endpoints will undergo a structural change in the near future. The new structure will be more intuitive and easier to use.
|
8 | 8 |
|
9 |
| -| Change | Example Implication | ETA | |
10 |
| -|---------|----------------------|---------| |
11 |
| -| Add validations, restrictions, and clearer error messages for the widgets schema. | If extra or invalid properties are sent, you will receive a descriptive error showing which one. You should delete the properties and match the current schema. | | |
12 |
| -| Add validations, restrictions, and clearer error messages for the pages schema. | For example, the API will block creating two home pages and require you to keep only one. | | |
13 |
| -| Enforce a dashboard widget wrapper when creating a new dashboard page. | If you try to create a dashboard page without wrapping the widget, the API (or Terraform) will return an error requiring you to add the wrapper in the JSON. | | |
| 9 | +:::danger pages api beta status |
| 10 | +The Pages API is currently in beta, in its current form it lacks certain validations and protections and it could render your portal unusable if used incorrectly. |
| 11 | + |
| 12 | +If you choose to use the Pages API please understand this risk. |
| 13 | + |
| 14 | +In case you use the Pages API and encounter issues, please reach out at [support.port.io](http://support.port.io/) for assistance. |
| 15 | +::: |
| 16 | + |
| 17 | +We’re rolling out improvements to make the Pages API more **reliable, secure, and intuitive**. |
| 18 | +From mid-September 2025 through mid-November 2025, several modifications will be introduced. These updates will impact both **direct use of the Pages API** and **usage through Terraform**, which until now lacked certain restrictions. |
| 19 | + |
| 20 | +The table below outlines the upcoming changes, example implications, and current progress status. |
| 21 | +The Status will be updated as work moves forward, from **Not Started** → **In dev** → **Released**. |
| 22 | + |
| 23 | +| Change | Example Implication | Status | |
| 24 | +|---------|----------------------|:---------:| |
| 25 | +| Add validations, restrictions, and clearer error messages for the widgets schema. | If extra or invalid properties are sent, you will receive a descriptive error showing which one. You should delete the properties and match the current schema. | `In dev` | |
| 26 | +| Add validations, restrictions, and clearer error messages for the pages schema. | For example, the API will block creating two home pages and require you to keep only one. | `Not started` | |
| 27 | +| Enforce a dashboard widget wrapper when creating a new dashboard page. | If you try to create a dashboard page without wrapping the widget, the API (or Terraform) will return an error requiring you to add the wrapper in the JSON. | `Not started` | |
14 | 28 |
|
15 | 29 | Until the new structure is released, you can refer to the [Swagger API documentation](https://api.port.io/swagger/#Pages) for the available endpoints and their usage.
|
16 | 30 |
|
17 | 31 | Currently, the `pages` endpoints allow you to:
|
18 | 32 |
|
19 | 33 | - **Create**, **update**, **delete**, and **get** pages.
|
20 | 34 | - **Create**, **update**, and **delete** widgets.
|
21 |
| -- **Update** and **get** page permissions. |
22 |
| - |
23 |
| -:::danger pages api beta status |
24 |
| -The Pages API is currently in beta, in its current form it lacks certain validations and protections and it could render your portal unusable if used incorrectly. |
25 |
| - |
26 |
| -If you choose to use the Pages API please understand this risk. |
27 |
| - |
28 |
| -In case you use the Pages API and encounter issues, please reach out at [support.port.io](http://support.port.io/) for assistance. |
29 |
| -::: |
| 35 | +- **Update** and **get** page permissions. |
0 commit comments