REST API Reference

Back Next

Updating the supplementary file specification

Update the supplementary files that are available to an elastic runtime environment by updating the specification.

After you update the supplementary file specification, all affected Secure Agent services automatically restart and use the updated specification.

POST request

Use the following URI:

/api/v3/RuntimeEnvironment/<runtime environment ID>/ElasticConfig

When you specify the source path for a file, use the subdirectory under the file system mount point. For example, if you create a

/mnt/efs

directory to use as the file system mount point and you create a

/mnt/efs/jdbc

directory to store JDBC drivers, use

/jdbc/<file name>

as the source path.

For more information about creating an EFS file system for data storage and mounting it, see

Runtime Environments

in the Administrator help.

Include the following fields in the request:

Field	Type	Description
rteId	String	Runtime environment ID.
specification	Object	Supplementary file specification.
agent	Object	Secure Agent configuration.
specification.agent.databaseIngestion	Object	Data Ingestion and Replication files. List each JAR file individually. Includes the following details: jdbcDrivers oracle
specification.agent.databaseIngestion.jdbcDrivers	Array of objects	JDBC drivers for Data Ingestion and Replication .
specification.agent.databaseIngestion.jdbcDrivers[].sourcePath	String	Path to a JDBC driver JAR file.
specification.agent.databaseIngestion.oracle	Object	Oracle drivers and version information for Data Ingestion and Replication . Includes the following details: jdbcDrivers ociDrivers version
specification.agent.databaseIngestion.oracle.jdbcDrivers	Array of objects	Oracle JDBC drivers.
specification.agent.databaseIngestion.oracle.jdbcDrivers[].sourcePath	String	Path to an Oracle JDBC driver JAR file.
specification.agent.databaseIngestion.oracle.ociDrivers	Array of objects	Oracle OCI drivers.
specification.agent.databaseIngestion.oracle.ociDrivers[].sourcePath	String	Path to an Oracle OCI driver file.
specification.agent.databaseIngestion.oracle.version	String	Oracle version.
specification.agent.dataIntegrationServer	Object	Data Integration Server files. Includes the following details: jdbcv2 jdbcDrivers odbc odbcInst mysql sap ssls
specification.agent.dataIntegrationServer.jdbcv2	Object	JDBC V2 drivers for the Data Integration Server. List each JAR file individually. Includes the following driver types: common spark
specification.agent.dataIntegrationServer.jdbcv2.common	Array of objects	Common JDBC drivers.
specification.agent.dataIntegrationServer.jdbcv2.common[].sourcePath	String	Path to a common JDBC driver JAR file.
specification.agent.dataIntegrationServer.jdbcv2.spark	Array of objects	Spark-specific JDBC drivers.
specification.agent.dataIntegrationServer.jdbcv2.spark[].sourcePath	String	Path to a Spark-specific JDBC driver JAR file.
specification.agent.dataIntegrationServer.jdbcDrivers	Array of objects	Additional JDBC drivers for the Data Integration Server. List each JAR file individually.
specification.agent.dataIntegrationServer.jdbcDrivers.sourcePath	String	Path to an additional JDBC driver JAR file.
specification.agent.dataIntegrationServer.mysql	Object	MySQL drivers and version information for the Data Integration Server. List each JAR file individually. Includes the following details: jdbcDrivers odbcDrivers version
specification.agent.dataIntegrationServer.mysql.jdbcDrivers	Array of objects	MySQL JDBC drivers.
specification.agent.dataIntegrationServer.mysql.jdbcDrivers[].sourcePath	String	Path to a MySQL JDBC driver JAR file.
specification.agent.dataIntegrationServer.mysql.odbcDrivers	Array of objects	MySQL ODBC drivers.
specification.agent.dataIntegrationServer.mysql.odbcDrivers[].sourcePath	String	Path to a MySQL ODBC driver file.
specification.agent.dataIntegrationServer.mysql.version	String	MySQL version.
specification.agent.dataIntegrationServer.odbc	Object	ODBC drivers and DSNs for the Data Integration Server. Includes the following details: drivers dsns
specification.agent.dataIntegrationServer.odbc.drivers	Array of objects	ODBC drivers.
specification.agent.dataIntegrationServer.odbc.drivers[].sourcePath	String	Path to an ODBC driver file.
specification.agent.dataIntegrationServer.odbc.dsns	Array of objects	ODBC DSN entries. Each entry is written to the odbc.ini file and must include all required components. Includes the following details: name entries as key-value pairs
specification.agent.dataIntegrationServer.odbc.dsns[].name	String	Name of the ODBC DSN in the odbc.ini file.
specification.agent.dataIntegrationServer.odbc.dsns[].entries	Array of objects	Entries as key-value pairs in the odbc.ini file.
specification.agent.dataIntegrationServer.odbc.dsns[].entries[].key	String	Key of the DSN entry.
specification.agent.dataIntegrationServer.odbc.dsns[].entries[].value	String	Value of the DSN entry.
specification.agent.dataIntegrationServer.odbcInst	Object	ODBCINST drivers and DSNs for the Data Integration Server. Includes the following details: drivers dsns
specification.agent.dataIntegrationServer.odbcInst.drivers	Array of objects	ODBCINST drivers.
specification.agent.dataIntegrationServer.odbcInst.drivers[].sourcePath	String	Path to an ODBCINST driver file.
specification.agent.dataIntegrationServer.odbcInst.dsns	Array of objects	ODBCINST DSN entries. Each entry is written to the odbcinst.ini file and must include all required components. Includes the following details: name entries as key-value pairs
specification.agent.dataIntegrationServer.odbcInst.dsns[].name	String	Name of the ODBCINST DSN in the odbcinst.ini file.
specification.agent.dataIntegrationServer.odbcInst.dsns[].entries	Array of objects	Entries as key-value pairs in the odbcinst.ini file.
specification.agent.dataIntegrationServer.odbcInst.dsns[].entries[].key	String	Key of the DSN entry.
specification.agent.dataIntegrationServer.odbcInst.dsns[].entries[].value	String	Value of the DSN entry.
specification.agent.dataIntegrationServer.sap	Object	SAP details for the Data Integration Server. Includes the following details: jcos nwrfcs hanas
specification.agent.dataIntegrationServer.sap.jcos	Array of objects	SAP JCo library files.
specification.agent.dataIntegrationServer.sap.jcos[].sourcePath	String	Path to an SAP JCo library file.
specification.agent.dataIntegrationServer.sap.nwrfcs	Array of objects	SAP NetWeaver RFC library files.
specification.agent.dataIntegrationServer.sap.nwrfcs[].sourcePath	String	Path to an SAP NetWeaver RFC library file.
specification.agent.dataIntegrationServer.sap.hanas	Array of objects	SAP HANA library files.
specification.agent.dataIntegrationServer.sap.hanas[].sourcePath	String	Path to an SAP HANA library file.
specification.agent.dataIntegrationServer.ssls	Array of objects	SSL details for the Data Integration Server. Includes the following details: fileCopy importCerts
specification.agent.dataIntegrationServer.ssls[].fileCopy	Object	SSL keystore/truststore file.
specification.agent.dataIntegrationServer.ssls[].fileCopy.sourcePath	String	Path to an SSL keystore/truststore file.
specification.agent.dataIntegrationServer.ssls[].importCerts	Object	Certificate import details. Includes the following details: certName alias
specification.agent.dataIntegrationServer.ssls[].importCerts.certName	String	Certificate name to import.
specification.agent.dataIntegrationServer.ssls[].importCerts.alias	String	Alias for the imported certificate in the keystore.
specification.agent.elasticServer	Object	Elastic Server files. Includes the following details: javaTxResources jdbcv2 nativeBinResources nativeLibResources
specification.agent.elasticServer.javaTxResources	Array of objects	Java transformation resource files for the Elastic Server .
specification.agent.elasticServer.javaTxResources[].sourcePath	String	Path to a Java transformation resource file.
specification.agent.elasticServer.jdbcv2	Object	JDBC V2 drivers for the Elastic Server . List each JAR file individually. Includes the following driver types: common spark
specification.agent.elasticServer.jdbcv2.common	Array of objects	Common JDBC drivers.
specification.agent.elasticServer.jdbcv2.common[].sourcePath	String	Path to a common JDBC driver JAR file for the Elastic Server .
specification.agent.elasticServer.jdbcv2.spark	Array of objects	Spark-specific JDBC drivers.
specification.agent.elasticServer.jdbcv2.spark[].sourcePath	String	Path to a Spark-specific JDBC driver JAR file for the Elastic Server .
specification.agent.elasticServer.nativeBinResources	Array of objects	Native binary resource files for the Elastic Server .
specification.agent.elasticServer.nativeBinResources[].sourcePath	String	Path to a native binary resource file.
specification.agent.elasticServer.nativeLibResources	Array of objects	Native library resource files for the Elastic Server .
specification.agent.elasticServer.nativeLibResources[].sourcePath	String	Path to a native library resource file.
specification.agent.executableScript	Object	Executable scripts. Includes the following details: scriptPath scriptArgs currentDirectory
specification.agent.executableScript.scriptPath	String	Path to the script. The script runs on the master node.
specification.agent.executableScript.scriptArgs	Array of strings	Arguments to pass to the script when it runs.
specification.agent.executableScript.currentDirectory	String	Working directory that the script runs in.
specification.agent.jdk	Object	JDK policy.
specification.agent.jdk.policyJars	Array of strings	JDK policy JAR files. List each JAR file individually.
specification.agent.sslStore	Array of objects	SSL store files.
specification.agent.sslStore[].sourcePath	String	Path to an SSL store file.

POST response

If successful, returns the updated supplementary file specification.

POST request example

The following sample POST request updates a supplementary file specification:

POST <base URL>/api/v3/RuntimeEnvironment/<runtime environment ID>/ElasticConfig
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>

{
  "rteId": "rte-12345",
  "specification": {
    "agent": {
      "databaseIngestion": {
        "jdbcDrivers": [{"sourcePath": "/dbingest/jdbc1.jar"}],
        "oracle": {
          "jdbcDrivers": [{"sourcePath": "/oracle/jdbc1.jar"}],
          "ociDrivers": [{"sourcePath": "/oracle/oci1.so"}],
          "version": "19c"
        }
      },
      "dataIntegrationServer": {
        "jdbcv2": {
          "common": [{"sourcePath": "/jdbc/common1.jar"}],
          "spark": [{"sourcePath": "/jdbc/spark1.jar"}]
        },
        "jdbcDrivers": [{"sourcePath": "/jdbc/driver1.jar"}],
        "mysql": {
          "jdbcDrivers": [{"sourcePath": "/mysql/jdbc1.jar"}],
          "odbcDrivers": [{"sourcePath": "/mysql/odbc1.so"}],
          "version": "8.0"
        },
        "odbc": {
          "drivers": [{"sourcePath": "/odbc/driver1.so"}],
          "dsns": [{"name": "dsn1", "entries": [{"key": "Server", "value": "localhost"}]}]
        },
        "odbcInst": {
          "drivers": [{"sourcePath": "/odbcinst/driver2.so"}],
          "dsns": [{"name": "dsn2", "entries": [{"key": "Port", "value": "1234"}]}]
        },
        "sap": {
          "jcos": [{"sourcePath": "/sap/jco1"}],
          "nwrfcs": [{"sourcePath": "/sap/nwrfc1"}],
          "hanas": [{"sourcePath": "/sap/hana1"}]
        },
        "ssls": [
          {
            "fileCopy": {"sourcePath": "/ssl/keystore.jks"},
            "importCerts": {"certName": "mycert", "alias": "myalias"}
          }
        ]
      },
      "elasticServer": {
        "javaTxResources": [{"sourcePath": "/elastic/javaTxRes.jar"}],
        "jdbcv2": {
          "common": [{"sourcePath": "/elastic/jdbc/common2.jar"}],
          "spark": [{"sourcePath": "/elastic/jdbc/spark2.jar"}]
        },
        "nativeLibResources": [{"sourcePath": "/elastic/nativeLib.so"}],
        "nativeBinResources": [{"sourcePath": "/elastic/nativeBin"}]
      },
      "executableScript": {
        "scriptPath": "/scripts/start.sh",
        "scriptArgs": ["--env", "prod"],
        "currentDirectory": "/scripts"
      },
      "jdk": {
        "policyJars": [
          "/datadisk/jdk/policy/unlimited/US_export_policy.jar",
          "/datadisk/jdk/policy/unlimited/local_policy.jar"
        ]
      },
      "sslStore": [{"sourcePath": "/ssl/store.jks"}]
    }
  }
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Updating the supplementary file specification

Updating the supplementary file specification

POST request

POST response

POST request example