From c31682b0a369eff65d8d52c43476ce765cbe0ae9 Mon Sep 17 00:00:00 2001 From: emgcentreon Date: Tue, 17 Dec 2024 11:20:48 +0100 Subject: [PATCH] MAP API doesnt have the procedure for https (#3809) * MAP API doesnt have the procedure for https * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Test * Bugfix * Another attempt to fix the bug * Another one * Bugfix * Add import * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update versioned_docs/version-24.10/api/graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md * Update graph-views-map-api.md --------- Co-authored-by: cg-tw <83637804+cg-tw@users.noreply.github.com> --- .../version-23.04/api/graph-views-map-api.md | 71 +++++++++++++++++-- .../version-23.10/api/graph-views-map-api.md | 71 +++++++++++++++++-- .../version-24.04/api/graph-views-map-api.md | 71 +++++++++++++++++-- .../version-24.10/api/graph-views-map-api.md | 71 +++++++++++++++++-- .../version-25.10/api/graph-views-map-api.md | 71 +++++++++++++++++-- .../version-23.04/api/graph-views-map-api.md | 71 +++++++++++++++++-- .../version-23.10/api/graph-views-map-api.md | 71 +++++++++++++++++-- .../version-24.04/api/graph-views-map-api.md | 71 +++++++++++++++++-- .../version-24.10/api/graph-views-map-api.md | 71 +++++++++++++++++-- .../version-25.10/api/graph-views-map-api.md | 71 +++++++++++++++++-- 10 files changed, 650 insertions(+), 60 deletions(-) diff --git a/i18n/fr/docusaurus-plugin-content-docs/version-23.04/api/graph-views-map-api.md b/i18n/fr/docusaurus-plugin-content-docs/version-23.04/api/graph-views-map-api.md index df4586140f1c..1a9b18fb8fc3 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/version-23.04/api/graph-views-map-api.md +++ b/i18n/fr/docusaurus-plugin-content-docs/version-23.04/api/graph-views-map-api.md @@ -3,6 +3,9 @@ id: map-api title: MAP API --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + Si vous souhaitez automatiser la création ou la maintenance de cartes standard, vous pouvez utiliser l'API de Centreon MAP. ## Permissions @@ -18,10 +21,24 @@ Avec cette API, vous pouvez créer / mettre à jour / supprimer des cartes stand ### S'authentifier + + + +``` +POST : http://serverURL:8081/centreon-map/api/beta/auth/sign-in +``` + + + + + ``` -POST : http://{{serverURL}}:8081/centreon-map/api/beta/auth/sign-in +POST : https://serverURL:9443/centreon-map/api/beta/auth/sign-in ``` + + + ``` Headers { Content-Type = application/json @@ -34,7 +51,7 @@ Body { } ``` -- Dans le résultat, récupérez le \{jwtToken\}. Vous devrez l'utiliser pour tous vos appels à l'API. Les headers ressembleront à ceci : +- Dans le résultat, récupérez le **jwtToken**. Vous devrez l'utiliser pour tous vos appels à l'API. Les headers ressembleront à ceci : ``` Headers { @@ -46,10 +63,24 @@ Headers { ### Créer une carte + + + ``` -POST http://{{serverURL}}:8081/centreon-map/api/beta/maps +POST http://serverURL:8081/centreon-map/api/beta/maps ``` + + + + +``` +POST https://serverURL:9443/centreon-map/api/beta/maps +``` + + + + ``` Headers { Content-Type = application/json @@ -62,22 +93,50 @@ Body { } ``` -- Récupérez l'identifiant de la carte \{mapId\} et de la vue \{viewId\} renvoyés. +- Récupérez les identifiants de la carte (mapId) et de la vue (viewId) renvoyés. ### Ouvrir la carte + + + ``` -GET http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views/{viewId} +GET http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views/_viewId_ ``` + + + + +``` +GET https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views/_viewId_ +``` + + + + ### Créer et attacher un élément "shape" à la carte ouverte Dans ce scénario, l'élément "shape" est un rectangle. + + + ``` -PUT http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views +PUT http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views ``` + + + + +``` +PUT https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views +``` + + + + ``` Body: { "id": \{viewId\}, diff --git a/i18n/fr/docusaurus-plugin-content-docs/version-23.10/api/graph-views-map-api.md b/i18n/fr/docusaurus-plugin-content-docs/version-23.10/api/graph-views-map-api.md index 759ff565ad4a..d16f1b44fdac 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/version-23.10/api/graph-views-map-api.md +++ b/i18n/fr/docusaurus-plugin-content-docs/version-23.10/api/graph-views-map-api.md @@ -3,6 +3,9 @@ id: map-api title: MAP API --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + Si vous souhaitez automatiser la création ou la maintenance de cartes standard, vous pouvez utiliser l'API de Centreon MAP. ## Permissions @@ -18,10 +21,24 @@ Avec cette API, vous pouvez créer / mettre à jour / supprimer des cartes stand ### S'authentifier + + + +``` +POST : http://serverURL:8081/centreon-map/api/beta/auth/sign-in +``` + + + + + ``` -POST : http://{{serverURL}}:8081/centreon-map/api/beta/auth/sign-in +POST : https://serverURL:9443/centreon-map/api/beta/auth/sign-in ``` + + + ``` Headers { Content-Type = application/json @@ -34,7 +51,7 @@ Body { } ``` -- Dans le résultat, récupérez le \{jwtToken\}. Vous devrez l'utiliser pour tous vos appels à l'API. Les headers ressembleront à ceci : +- Dans le résultat, récupérez le **jwtToken**. Vous devrez l'utiliser pour tous vos appels à l'API. Les headers ressembleront à ceci : ``` Headers { @@ -46,10 +63,24 @@ Headers { ### Créer une carte + + + ``` -POST http://{{serverURL}}:8081/centreon-map/api/beta/maps +POST http://serverURL:8081/centreon-map/api/beta/maps ``` + + + + +``` +POST https://serverURL:9443/centreon-map/api/beta/maps +``` + + + + ``` Headers { Content-Type = application/json @@ -62,22 +93,50 @@ Body { } ``` -- Récupérez l'identifiant de la carte \{mapId\} et de la vue \{viewId\} renvoyés. +- Récupérez les identifiants de la carte (mapId) et de la vue (viewId) renvoyés. ### Ouvrir la carte + + + ``` -GET http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views/{viewId} +GET http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views/_viewId_ ``` + + + + +``` +GET https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views/_viewId_ +``` + + + + ### Créer et attacher un élément "shape" à la carte ouverte Dans ce scénario, l'élément "shape" est un rectangle. + + + ``` -PUT http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views +PUT http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views ``` + + + + +``` +PUT https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views +``` + + + + ``` Body: { "id": \{viewId\}, diff --git a/i18n/fr/docusaurus-plugin-content-docs/version-24.04/api/graph-views-map-api.md b/i18n/fr/docusaurus-plugin-content-docs/version-24.04/api/graph-views-map-api.md index 0b59b29e7553..b3fc63e34372 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/version-24.04/api/graph-views-map-api.md +++ b/i18n/fr/docusaurus-plugin-content-docs/version-24.04/api/graph-views-map-api.md @@ -3,6 +3,9 @@ id: map-api title: MAP API --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + Si vous souhaitez automatiser la création ou la maintenance de cartes standard, vous pouvez utiliser l'API de Centreon MAP. ## Permissions @@ -18,10 +21,24 @@ Avec cette API, vous pouvez créer / mettre à jour / supprimer des cartes stand ### S'authentifier + + + +``` +POST : http://serverURL:8081/centreon-map/api/beta/auth/sign-in +``` + + + + + ``` -POST : http://{{serverURL}}:8081/centreon-map/api/beta/auth/sign-in +POST : https://serverURL:9443/centreon-map/api/beta/auth/sign-in ``` + + + ``` Headers { Content-Type = application/json @@ -34,7 +51,7 @@ Body { } ``` -- Dans le résultat, récupérez le \{jwtToken\}. Vous devrez l'utiliser pour tous vos appels à l'API. Les headers ressembleront à ceci : +- Dans le résultat, récupérez le **jwtToken**. Vous devrez l'utiliser pour tous vos appels à l'API. Les headers ressembleront à ceci : ``` Headers { @@ -46,10 +63,24 @@ Headers { ### Créer une carte + + + ``` -POST http://{{serverURL}}:8081/centreon-map/api/beta/maps +POST http://serverURL:8081/centreon-map/api/beta/maps ``` + + + + +``` +POST https://serverURL:9443/centreon-map/api/beta/maps +``` + + + + ``` Headers { Content-Type = application/json @@ -62,22 +93,50 @@ Body { } ``` -- Récupérez l'identifiant de la carte \{mapId\} et de la vue \{viewId\} renvoyés. +- Récupérez les identifiants de la carte (mapId) et de la vue (viewId) renvoyés. ### Ouvrir la carte + + + ``` -GET http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views/{viewId} +GET http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views/_viewId_ ``` + + + + +``` +GET https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views/_viewId_ +``` + + + + ### Créer et attacher un élément "shape" à la carte ouverte Dans ce scénario, l'élément "shape" est un rectangle. + + + ``` -PUT http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views +PUT http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views ``` + + + + +``` +PUT https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views +``` + + + + ``` Body: { "id": \{viewId\}, diff --git a/i18n/fr/docusaurus-plugin-content-docs/version-24.10/api/graph-views-map-api.md b/i18n/fr/docusaurus-plugin-content-docs/version-24.10/api/graph-views-map-api.md index 1d591c0f568a..d581e1cb38d7 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/version-24.10/api/graph-views-map-api.md +++ b/i18n/fr/docusaurus-plugin-content-docs/version-24.10/api/graph-views-map-api.md @@ -3,6 +3,9 @@ id: map-api title: MAP API --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + Si vous souhaitez automatiser la création ou la maintenance de cartes standard, vous pouvez utiliser l'API de Centreon MAP. ## Permissions @@ -18,10 +21,24 @@ Avec cette API, vous pouvez créer / mettre à jour / supprimer des cartes stand ### S'authentifier + + + +``` +POST : http://serverURL:8081/centreon-map/api/beta/auth/sign-in +``` + + + + + ``` -POST : http://{{serverURL}}:8081/centreon-map/api/beta/auth/sign-in +POST : https://serverURL:9443/centreon-map/api/beta/auth/sign-in ``` + + + ``` Headers { Content-Type = application/json @@ -34,7 +51,7 @@ Body { } ``` -- Dans le résultat, récupérez le \{jwtToken\}. Vous devrez l'utiliser pour tous vos appels à l'API. Les headers ressembleront à ceci : +- Dans le résultat, récupérez le **jwtToken**. Vous devrez l'utiliser pour tous vos appels à l'API. Les headers ressembleront à ceci : ``` Headers { @@ -46,10 +63,24 @@ Headers { ### Créer une carte + + + ``` -POST http://{{serverURL}}:8081/centreon-map/api/beta/maps +POST http://serverURL:8081/centreon-map/api/beta/maps ``` + + + + +``` +POST https://serverURL:9443/centreon-map/api/beta/maps +``` + + + + ``` Headers { Content-Type = application/json @@ -62,22 +93,50 @@ Body { } ``` -- Récupérez l'identifiant de la carte \{mapId\} et de la vue \{viewId\} renvoyés. +- Récupérez les identifiants de la carte (mapId) et de la vue (viewId) renvoyés. ### Ouvrir la carte + + + ``` -GET http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views/{viewId} +GET http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views/_viewId_ ``` + + + + +``` +GET https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views/_viewId_ +``` + + + + ### Créer et attacher un élément "shape" à la carte ouverte Dans ce scénario, l'élément "shape" est un rectangle. + + + ``` -PUT http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views +PUT http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views ``` + + + + +``` +PUT https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views +``` + + + + ``` Body: { "id": \{viewId\}, diff --git a/i18n/fr/docusaurus-plugin-content-docs/version-25.10/api/graph-views-map-api.md b/i18n/fr/docusaurus-plugin-content-docs/version-25.10/api/graph-views-map-api.md index 1d591c0f568a..ed6618df6066 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/version-25.10/api/graph-views-map-api.md +++ b/i18n/fr/docusaurus-plugin-content-docs/version-25.10/api/graph-views-map-api.md @@ -3,6 +3,9 @@ id: map-api title: MAP API --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + Si vous souhaitez automatiser la création ou la maintenance de cartes standard, vous pouvez utiliser l'API de Centreon MAP. ## Permissions @@ -18,10 +21,24 @@ Avec cette API, vous pouvez créer / mettre à jour / supprimer des cartes stand ### S'authentifier + + + +``` +POST : http://serverURL:8081/centreon-map/api/beta/auth/sign-in +``` + + + + + ``` -POST : http://{{serverURL}}:8081/centreon-map/api/beta/auth/sign-in +POST : https://serverURL:9443/centreon-map/api/beta/auth/sign-in ``` + + + ``` Headers { Content-Type = application/json @@ -34,7 +51,7 @@ Body { } ``` -- Dans le résultat, récupérez le \{jwtToken\}. Vous devrez l'utiliser pour tous vos appels à l'API. Les headers ressembleront à ceci : +- Dans le résultat, récupérez le **jwtToken**. Vous devrez l'utiliser pour tous vos appels à l'API. Les headers ressembleront à ceci : ``` Headers { @@ -46,10 +63,24 @@ Headers { ### Créer une carte + + + ``` -POST http://{{serverURL}}:8081/centreon-map/api/beta/maps +POST http://serverURL:8081/centreon-map/api/beta/maps ``` + + + + +``` +POST https://serverURL:9443/centreon-map/api/beta/maps +``` + + + + ``` Headers { Content-Type = application/json @@ -62,22 +93,50 @@ Body { } ``` -- Récupérez l'identifiant de la carte \{mapId\} et de la vue \{viewId\} renvoyés. +- Récupérez les identifiants de la carte (mapId) et de la vue (viewId) renvoyés. ### Ouvrir la carte + + + ``` -GET http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views/{viewId} +GET http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views/_viewId_ ``` + + + + +``` +GET https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views/_viewId_ +``` + + + + ### Créer et attacher un élément "shape" à la carte ouverte Dans ce scénario, l'élément "shape" est un rectangle. + + + ``` -PUT http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views +PUT http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views ``` + + + + +``` +PUT https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views +``` + + + + ``` Body: { "id": \{viewId\}, diff --git a/versioned_docs/version-23.04/api/graph-views-map-api.md b/versioned_docs/version-23.04/api/graph-views-map-api.md index bd2a0fdcb217..8160140efe14 100644 --- a/versioned_docs/version-23.04/api/graph-views-map-api.md +++ b/versioned_docs/version-23.04/api/graph-views-map-api.md @@ -3,6 +3,9 @@ id: map-api title: MAP API --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + If you want to automate standard maps creation or maintenance, you may use the Centreon MAP extension API. ## Permissions @@ -19,10 +22,24 @@ of the following privileges: ### Authenticate + + + +``` +POST : http://serverURL:8081/centreon-map/api/beta/auth/sign-in +``` + + + + + ``` -POST : http://{{serverURL}}:8081/centreon-map/api/beta/auth/sign-in +POST : https://serverURL:9443/centreon-map/api/beta/auth/sign-in ``` + + + ``` Headers { Content-Type = application/json @@ -35,7 +52,7 @@ Body { } ``` -- In the result, retrieve the \{jwtToken\}. You will need to use it for all your API calls. The headers will look like this: +- In the result, retrieve the **jwtToken**. You will need to use it for all your API calls. The headers will look like this: ``` Headers { @@ -47,10 +64,24 @@ Headers { ### Create a map + + + ``` -POST http://{{serverURL}}:8081/centreon-map/api/beta/maps +POST http://serverURL:8081/centreon-map/api/beta/maps ``` + + + + +``` +POST https://serverURL:9443/centreon-map/api/beta/maps +``` + + + + ``` Headers { Content-Type = application/json @@ -63,22 +94,50 @@ Body { } ``` -- Retrieve the ID of the map \{mapId\} and the view \{viewId\} returned. +- Retrieve the ID of the map (mapId) and the view (viewId) returned. ### Open the map + + + ``` -GET http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views/{viewId} +GET http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views/_viewId_ ``` + + + + +``` +GET https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views/_viewId_ +``` + + + + ### Create and attach a "shape" element to the opened map In this scenario, the "shape" element is a rectangle. + + + ``` -PUT http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views +PUT http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views ``` + + + + +``` +PUT https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views +``` + + + + ``` Body: { "id": \{viewId\}, diff --git a/versioned_docs/version-23.10/api/graph-views-map-api.md b/versioned_docs/version-23.10/api/graph-views-map-api.md index 63ec13dff0e8..e3395bfca02f 100644 --- a/versioned_docs/version-23.10/api/graph-views-map-api.md +++ b/versioned_docs/version-23.10/api/graph-views-map-api.md @@ -3,6 +3,9 @@ id: map-api title: MAP API --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + If you want to automate standard maps creation or maintenance, you may use the Centreon MAP extension API. ## Permissions @@ -19,10 +22,24 @@ of the following privileges: ### Authenticate + + + +``` +POST : http://serverURL:8081/centreon-map/api/beta/auth/sign-in +``` + + + + + ``` -POST : http://{{serverURL}}:8081/centreon-map/api/beta/auth/sign-in +POST : https://serverURL:9443/centreon-map/api/beta/auth/sign-in ``` + + + ``` Headers { Content-Type = application/json @@ -35,7 +52,7 @@ Body { } ``` -- In the result, retrieve the \{jwtToken\}. You will need to use it for all your API calls. The headers will look like this: +- In the result, retrieve the **jwtToken**. You will need to use it for all your API calls. The headers will look like this: ``` Headers { @@ -47,10 +64,24 @@ Headers { ### Create a map + + + ``` -POST http://{{serverURL}}:8081/centreon-map/api/beta/maps +POST http://serverURL:8081/centreon-map/api/beta/maps ``` + + + + +``` +POST https://serverURL:9443/centreon-map/api/beta/maps +``` + + + + ``` Headers { Content-Type = application/json @@ -63,22 +94,50 @@ Body { } ``` -- Retrieve the ID of the map \{mapId\} and the view \{viewId\} returned. +- Retrieve the ID of the map (mapId) and the view (viewId) returned. ### Open the map + + + ``` -GET http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views/{viewId} +GET http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views/_viewId_ ``` + + + + +``` +GET https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views/_viewId_ +``` + + + + ### Create and attach a "shape" element to the opened map In this scenario, the "shape" element is a rectangle. + + + ``` -PUT http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views +PUT http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views ``` + + + + +``` +PUT https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views +``` + + + + ``` Body: { "id": \{viewId\}, diff --git a/versioned_docs/version-24.04/api/graph-views-map-api.md b/versioned_docs/version-24.04/api/graph-views-map-api.md index 4a5c020744cb..0d29dd47299c 100644 --- a/versioned_docs/version-24.04/api/graph-views-map-api.md +++ b/versioned_docs/version-24.04/api/graph-views-map-api.md @@ -3,6 +3,9 @@ id: map-api title: MAP API --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + If you want to automate standard maps creation or maintenance, you may use the Centreon MAP extension API. ## Permissions @@ -19,10 +22,24 @@ of the following privileges: ### Authenticate + + + +``` +POST : http://serverURL:8081/centreon-map/api/beta/auth/sign-in +``` + + + + + ``` -POST : http://{{serverURL}}:8081/centreon-map/api/beta/auth/sign-in +POST : https://serverURL:9443/centreon-map/api/beta/auth/sign-in ``` + + + ``` Headers { Content-Type = application/json @@ -35,7 +52,7 @@ Body { } ``` -- In the result, retrieve the \{jwtToken\}. You will need to use it for all your API calls. The headers will look like this: +- In the result, retrieve the **jwtToken**. You will need to use it for all your API calls. The headers will look like this: ``` Headers { @@ -47,10 +64,24 @@ Headers { ### Create a map + + + ``` -POST http://{{serverURL}}:8081/centreon-map/api/beta/maps +POST http://serverURL:8081/centreon-map/api/beta/maps ``` + + + + +``` +POST https://serverURL:9443/centreon-map/api/beta/maps +``` + + + + ``` Headers { Content-Type = application/json @@ -63,22 +94,50 @@ Body { } ``` -- Retrieve the ID of the map \{mapId\} and the view \{viewId\} returned. +- Retrieve the ID of the map (mapId) and the view (viewId) returned. ### Open the map + + + ``` -GET http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views/{viewId} +GET http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views/_viewId_ ``` + + + + +``` +GET https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views/_viewId_ +``` + + + + ### Create and attach a "shape" element to the opened map In this scenario, the "shape" element is a rectangle. + + + ``` -PUT http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views +PUT http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views ``` + + + + +``` +PUT https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views +``` + + + + ``` Body: { "id": \{viewId\}, diff --git a/versioned_docs/version-24.10/api/graph-views-map-api.md b/versioned_docs/version-24.10/api/graph-views-map-api.md index d4fe495bfc2e..3f943587fd62 100644 --- a/versioned_docs/version-24.10/api/graph-views-map-api.md +++ b/versioned_docs/version-24.10/api/graph-views-map-api.md @@ -3,6 +3,9 @@ id: map-api title: MAP API --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + If you want to automate standard maps creation or maintenance, you may use the Centreon MAP extension API. ## Permissions @@ -19,10 +22,24 @@ of the following privileges: ### Authenticate + + + +``` +POST : http://serverURL:8081/centreon-map/api/beta/auth/sign-in +``` + + + + + ``` -POST : http://{{serverURL}}:8081/centreon-map/api/beta/auth/sign-in +POST : https://serverURL:9443/centreon-map/api/beta/auth/sign-in ``` + + + ``` Headers { Content-Type = application/json @@ -35,7 +52,7 @@ Body { } ``` -- In the result, retrieve the \{jwtToken\}. You will need to use it for all your API calls. The headers will look like this: +- In the result, retrieve the **jwtToken**. You will need to use it for all your API calls. The headers will look like this: ``` Headers { @@ -47,10 +64,24 @@ Headers { ### Create a map + + + ``` -POST http://{{serverURL}}:8081/centreon-map/api/beta/maps +POST http://serverURL:8081/centreon-map/api/beta/maps ``` + + + + +``` +POST https://serverURL:9443/centreon-map/api/beta/maps +``` + + + + ``` Headers { Content-Type = application/json @@ -63,22 +94,50 @@ Body { } ``` -- Retrieve the ID of the map \{mapId\} and the view \{viewId\} returned. +- Retrieve the ID of the map (mapId) and the view (viewId) returned. ### Open the map + + + ``` -GET http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views/{viewId} +GET http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views/_viewId_ ``` + + + + +``` +GET https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views/_viewId_ +``` + + + + ### Create and attach a "shape" element to the opened map In this scenario, the "shape" element is a rectangle. + + + ``` -PUT http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views +PUT http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views ``` + + + + +``` +PUT https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views +``` + + + + ``` Body: { "id": \{viewId\}, diff --git a/versioned_docs/version-25.10/api/graph-views-map-api.md b/versioned_docs/version-25.10/api/graph-views-map-api.md index d4fe495bfc2e..3f943587fd62 100644 --- a/versioned_docs/version-25.10/api/graph-views-map-api.md +++ b/versioned_docs/version-25.10/api/graph-views-map-api.md @@ -3,6 +3,9 @@ id: map-api title: MAP API --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + If you want to automate standard maps creation or maintenance, you may use the Centreon MAP extension API. ## Permissions @@ -19,10 +22,24 @@ of the following privileges: ### Authenticate + + + +``` +POST : http://serverURL:8081/centreon-map/api/beta/auth/sign-in +``` + + + + + ``` -POST : http://{{serverURL}}:8081/centreon-map/api/beta/auth/sign-in +POST : https://serverURL:9443/centreon-map/api/beta/auth/sign-in ``` + + + ``` Headers { Content-Type = application/json @@ -35,7 +52,7 @@ Body { } ``` -- In the result, retrieve the \{jwtToken\}. You will need to use it for all your API calls. The headers will look like this: +- In the result, retrieve the **jwtToken**. You will need to use it for all your API calls. The headers will look like this: ``` Headers { @@ -47,10 +64,24 @@ Headers { ### Create a map + + + ``` -POST http://{{serverURL}}:8081/centreon-map/api/beta/maps +POST http://serverURL:8081/centreon-map/api/beta/maps ``` + + + + +``` +POST https://serverURL:9443/centreon-map/api/beta/maps +``` + + + + ``` Headers { Content-Type = application/json @@ -63,22 +94,50 @@ Body { } ``` -- Retrieve the ID of the map \{mapId\} and the view \{viewId\} returned. +- Retrieve the ID of the map (mapId) and the view (viewId) returned. ### Open the map + + + ``` -GET http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views/{viewId} +GET http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views/_viewId_ ``` + + + + +``` +GET https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views/_viewId_ +``` + + + + ### Create and attach a "shape" element to the opened map In this scenario, the "shape" element is a rectangle. + + + ``` -PUT http://{{serverURL}}:8081/centreon-map/api/beta/maps/{mapId}/views +PUT http://serverURL:8081/centreon-map/api/beta/maps/_mapId_/views ``` + + + + +``` +PUT https://serverURL:9443/centreon-map/api/beta/maps/_mapId_/views +``` + + + + ``` Body: { "id": \{viewId\},