Central Governance 1.1.3 Users Guide Save PDF Selected topic Selected topic and subtopics All content SecureTransport backups As described in Manage SecureTransport backups, you can use REST APIs to manage SecureTransports that act as backups to a master SecureTransport. Define a backup for an existing SecureTransport You can set a backup for an existing SecureTransport using a dedicated API. Use either the name or the business Id to identify the product. POST /api/v2/products/id/backupproducts [ { "name": "ST_backup_product_name3" } ] Or POST /api/v2/products/id/backupproducts [ { "businessId": "93c8ab21-d04e-4df6-a96c-11b4bbcc97f5" } ] Retrieve the list of backups You can use GET on the product resource to retrieve the list of backup SecureTransports, which are listed after the communication profiles. GET /api/v2/products?name=ST_product_name [ { "businessId": "b430b2e7-b707-4d73-8cc9-c2022a44929e", "name": "ST_product_name", "host": "CG_host", "os": "linux-x86-64", "version": "5.4", "status": "Started", "type": "SecureTransport", "contact": {}, "communicationProfiles": […], "backupProducts": [ { "businessId": "df624908-0de8-4c2c-be4b-61d4baec34eb", "meta": { "href": "https://CG_host:6900/Axway/CentralGovernance/default/CentralGovernance/api/v2/products/df624908-0de8-4c2c-be4b-61d4baec34eb" }, "name": "ST_backup_product_name", "synchronized": false }, ] } ] You can also retrieve the list of the SecureTransports that are acting as backups for a specific product using a dedicated sub-resource. GET /api/v2/products/id/backupproducts [ { "businessId": "df624908-0de8-4c2c-be4b-61d4baec34eb", "meta": { "href": "https://CG_host:6900/Axway/CentralGovernance/default/CentralGovernance/api/v2/products/df624908-0de8-4c2c-be4b-61d4baec34eb" }, "name": "ST_backup_product_name1", "synchronized": false }, { "businessId": "b1adf94a-01d6-4fe6-abf7-a89864f1bfec", "meta": { "href": "https://CG_host:6900/Axway/CentralGovernance/default/CentralGovernance/api/v2/products/b1adf94a-01d6-4fe6-abf7-a89864f1bfec " }, "name": "ST_backup_product_name2", "synchronized": false } ] The synchronized field tracks if the communication profiles on the backup SecureTransports are the same as those on the master production server. Note the following: The synchronized field is created automatically, with an initial value of false. You cannot set synchronized to true when adding a backup SecureTransport. Once the synchronization is successful, the status becomes synchronized: true. Synchronize communication profiles This API synchronizes the communication profiles on the master SecureTransport with all the backups. POST /api/v2/products/productid/synchronizebox Retrieve backups in flow resources The flow JSON provides information about the backups for an master SecureTransport used in a flow, as well as for flow sub-resources: /api/v2/flows /api/v2/flows/flowId/sources /api/v2/flows/flowId/targets /api/v2/flows/flowId/relays Delete a backup You can delete a backup SecureTransport using an API. Use either the name or the business id to identify the product to remove. DELETE /api/v2/products/id_product/backupproducts/id_backup_product Or DELETE /api/v2/products/id_product/backupproducts/ST_backup_product_name2 You can use DELETE /api/v2/products on products that are used as a backup. The product is removed from the backup products list associated with the master SecureTransport, and from its flows. Central Governance | Document Directory Related Links
SecureTransport backups As described in Manage SecureTransport backups, you can use REST APIs to manage SecureTransports that act as backups to a master SecureTransport. Define a backup for an existing SecureTransport You can set a backup for an existing SecureTransport using a dedicated API. Use either the name or the business Id to identify the product. POST /api/v2/products/id/backupproducts [ { "name": "ST_backup_product_name3" } ] Or POST /api/v2/products/id/backupproducts [ { "businessId": "93c8ab21-d04e-4df6-a96c-11b4bbcc97f5" } ] Retrieve the list of backups You can use GET on the product resource to retrieve the list of backup SecureTransports, which are listed after the communication profiles. GET /api/v2/products?name=ST_product_name [ { "businessId": "b430b2e7-b707-4d73-8cc9-c2022a44929e", "name": "ST_product_name", "host": "CG_host", "os": "linux-x86-64", "version": "5.4", "status": "Started", "type": "SecureTransport", "contact": {}, "communicationProfiles": […], "backupProducts": [ { "businessId": "df624908-0de8-4c2c-be4b-61d4baec34eb", "meta": { "href": "https://CG_host:6900/Axway/CentralGovernance/default/CentralGovernance/api/v2/products/df624908-0de8-4c2c-be4b-61d4baec34eb" }, "name": "ST_backup_product_name", "synchronized": false }, ] } ] You can also retrieve the list of the SecureTransports that are acting as backups for a specific product using a dedicated sub-resource. GET /api/v2/products/id/backupproducts [ { "businessId": "df624908-0de8-4c2c-be4b-61d4baec34eb", "meta": { "href": "https://CG_host:6900/Axway/CentralGovernance/default/CentralGovernance/api/v2/products/df624908-0de8-4c2c-be4b-61d4baec34eb" }, "name": "ST_backup_product_name1", "synchronized": false }, { "businessId": "b1adf94a-01d6-4fe6-abf7-a89864f1bfec", "meta": { "href": "https://CG_host:6900/Axway/CentralGovernance/default/CentralGovernance/api/v2/products/b1adf94a-01d6-4fe6-abf7-a89864f1bfec " }, "name": "ST_backup_product_name2", "synchronized": false } ] The synchronized field tracks if the communication profiles on the backup SecureTransports are the same as those on the master production server. Note the following: The synchronized field is created automatically, with an initial value of false. You cannot set synchronized to true when adding a backup SecureTransport. Once the synchronization is successful, the status becomes synchronized: true. Synchronize communication profiles This API synchronizes the communication profiles on the master SecureTransport with all the backups. POST /api/v2/products/productid/synchronizebox Retrieve backups in flow resources The flow JSON provides information about the backups for an master SecureTransport used in a flow, as well as for flow sub-resources: /api/v2/flows /api/v2/flows/flowId/sources /api/v2/flows/flowId/targets /api/v2/flows/flowId/relays Delete a backup You can delete a backup SecureTransport using an API. Use either the name or the business id to identify the product to remove. DELETE /api/v2/products/id_product/backupproducts/id_backup_product Or DELETE /api/v2/products/id_product/backupproducts/ST_backup_product_name2 You can use DELETE /api/v2/products on products that are used as a backup. The product is removed from the backup products list associated with the master SecureTransport, and from its flows. Central Governance | Document Directory