Creating Platform Data Backup using API

About this task

You can back up your platform configuration in webMethods API Gateway using a REST API.

Pre-requisites:

Ensure that you have the repository where you want to save the platform data backup.

To take backup of the platform data

Procedure

Ensure that webMethods API Gateway is up and running.

Run the following command to create a backup and save the output to a file. For example, name the output file platformConfiguration.yaml

curl --location "http://host:port/rest/apigateway/administration/platformConfiguration" \
     --header "Accept: application/yaml" \
     --header "Authorization: Basic XXX=" \
     -o platformConfiguration.yaml

In this command, replace host and port with the hostname and port of your webMethods API Gateway instance. Replace XXX= with your authentication credentials.

Note: This request works only for local installations of webMethods API Gateway.

A sample response with a YAML output that you can save as a file is as follows:

apigw:
  cluster:
    aware: "false"
    pendingRestart: "false"
    tsaUrls: ""
    actionOnStartupError: "standalone"
    sessTimeout: "60"
  elasticsearch:
    tenantId: "default"
    hosts: "localhost:9240"
    autostart: "true"
    http:
      keepAlive: "true"
      keepAliveMaxConnections: 50
      keepAliveMaxConnectionsPerRoute: 15
      connectionTimeout: 10000
      socketTimeout: 30000
      maxRetryTimeout: 100000
      maxRequestRetry: 1
    sniff:
      enable: "true"
      timeInterval: 60000
    clientHttpResponseSize: 100
  analyticsDataStore:
    tenantId: "default"
    hosts: "localhost:9240"
    http:
      keepAlive: "true"
      keepAliveMaxConnections: 50
      keepAliveMaxConnectionsPerRoute: 15
      connectionTimeout: 10000
      socketTimeout: 30000
      maxRetryTimeout: 100000
      maxRequestRetry: 1
    sniff:
      enable: "true"
      timeInterval: 60000
    clientHttpResponseSize: 100
  kibana:
    dashboardInstance: "http://localhost:9405"

Open the platformConfiguration.yaml file to verify that the content is saved correctly.