Integration Server 10.15 | Added, Removed, Deprecated, or Changed Administrator APIs | Release 10.7
 
Release 10.7
Added APIs
*GET /admin/account/locking Retrieves account locking settings.
*PATCH /admin/account/locking Updates account locking settings.
*GET /admin/account/password/expiration Retrieves password expiration settings.
*PATCH /admin/account/password/expiration Updates password expiration settings.
*GET /admin/account/password/restriction Retrieves password restriction settings.
*PATCH /admin/account/password/restriction Updates password restriction settings.
*GET /admin/cachemanager/ Retrieves all cache managers.
*GET /admin/cachemanager/{cacheManagerName} Retrieves a cache manager.
*POST /admin/cachemanager/ Creates a cache manager.
*POST /admin/cachemanager/{cacheManagerName} Stops, starts, or restarts a cache manager.
*PATCH /admin/cachemanager/{cacheManagerName} Updates a cache manager.
*PUT /admin/cachemanager/{cacheManagerName} Replaces a cache manager.
*DELETE /admin/cachemanager/{cacheManagerName} Deletes a cache manager and all caches contained in the cache manager.
*GET /admin/cachemanager/{cacheManagerName}/cache Retrieves all caches for the requested cache manager.
*GET /admin/cachemanager/{cacheManagerName}/cache/{cacheName} Retrieves the requested cache.
*POST /admin/cachemanager/{cacheManagerName}/cache Creates a cache.
*PATCH /admin/cachemanager/{cacheManagerName}/cache/{cacheName} Updates a cache.
*PUT /admin/cachemanager/{cacheManagerName}/cache/{cacheName} Replaces a cache.
*DELETE /admin/cachemanager/{cacheManagerName}/cache/{cacheName} Deletes a cache and discards all data in the cache.
*GET /admin/certificate/client Retrieves all client certificate details.
*GET /admin/certificate/client/issuer/{issuer}/usage/{usage}/serialNum/{serialNum} Retrieves details for the requested client certificate.
*POST /admin/certificate/client Imports a client certificate.
*PATCH /admin/certificate/client/issuer/{issuer}/oldUsage/{oldUsage}/serialNum/{serialNum} Updates a client certificate.
*PUT /admin/certificate/client/issuer/{issuer}/oldUsage/{oldUsage}/serialNum/{serialNum} Replaces a client certificate.
*DELETE /admin/certificate/client/issuer/{issuer}/oldUsage/{oldUsage}/serialNum/{serialNum} Deletes a client certificate.
*GET /admin/certificate/server Retrieves server certificate settings.
*POST /admin/certificate/server/cache Clears the cache of current SSL session information.
*PATCH /admin/certificate/server Updates a server certificate.
*PUT /admin/certificate/server Replaces a server certificate.
*GET /admin/csrfguard Retrieves CSRF guard settings
*GET /admin/csrfguard/token Retrieves CSRF secure token.
*PATCH /admin/csrfguard Updates CSRF guard settings
*PUT /admin/csrfguard Replaces CSRF guard settings.
*GET /admin/fileaccesscontrol/ Retrieves file access control configuration from fileAccessControl.cnf.
*PATCH /admin/fileaccesscontrol/ Updates the file access control configuration in fileAccessControl.cnf.
*GET /admin/globalvariable Retrieves all global variables.
*GET /admin/globalvariable/{key} Retrieves a specific global variable.
*POST /admin/globalvariable Creates a global variable.
*PATCH /admin/globalvariable/{key} Updates a global variable.
*PUT /admin/globalvariable/{key} Updates a global variable.
*DELETE /admin/globalvariable/{key} Deletes a global variable.
*GET /admin/healthgauge/ Retrieves all health indicators.
*GET /admin/healthgauge/{indicatorName} Retrieves information about a particular health indicator.
*PATCH /admin/healthgauge/{indicatorName} Updates a health indicator.
*POST /admin/healthgauge/{indicatorName} Performs an administrative action on a health indicator.
*GET /admin/hotdeployment/ Retrieves the hot deployment configuration
*PATCH /admin/hotdeployment/ Updates the hot deployment configuration
*GET /admin/jdbc/driver/ Retrieves all JDBC driver aliases.
*POST /admin/jdbc/driver/ Creates a JDBC driver alias.
*GET /admin/jdbc/driver/{driverAliasName} Retrieves a JDBC driver alias.
*PATCH /admin/jdbc/driver/{driverAliasName} Updates a JDBC driver alias.
*PUT /admin/jdbc/driver/{driverAliasName} Replaces a JDBC driver alias.
*DELETE /admin/jdbc/driver/{driverAliasName} Deletes a JDBC driver alias.
*GET /admin/jdbc/function/ Retrieves all JDBC functions.
*GET /admin/jdbc/function/{functionAliasName} Retrieves a JDBC function.
*PATCH /admin/jdbc/function/{functionAliasName} Updates a JDBC function.
*POST /admin/jdbc/function/{functionAliasName} Performs administrative actions on a JDBC function.
*GET /admin/jdbc/pool/ Retrieves all JDBC pool aliases.
*GET /admin/jdbc/pool/{poolAliasName} Retrieves a JDBC pool alias.
*POST /admin/jdbc/pool/ Creates a JDBC pool alias.
*PUT /admin/jdbc/pool/{poolAliasName} Replaces a JDBC pool alias.
*POST /admin/jdbc/pool/{poolAliasName} Performs an administrative action on a JDBC pool alias
*PATCH /admin/jdbc/pool/{poolAliasName} Updates a JDBC pool alias.
*DELETE /admin/jdbc/pool/{poolAliasName} Deletes a JDBC pool alias.
*GET /admin/jms Retrieves all JMS connection aliases.
*GET /admin/jms/{jmsAliasName} Retrieves a specific JMS connection alias.
*POST /admin/jms Creates a JMS connection alias.
*POST /admin/jms/{jmsAliasName} Enables or disables a JMS connection alias.
*PATCH /admin/jms/{jmsAliasName} Updates a JMS connection alias.
*PUT /admin/jms/{jmsAliasName} Replaces a JMS connection alias.
*DELETE /admin/jms/{jmsAliasName} Deletes a JMS connection alias.
*GET /admin/jmstrigger Retrieves all JMS triggers.
*GET /admin/jmstrigger/{triggerName} Retrieves a specific JMS trigger.
*POST /admin/jmstrigger/{triggerName} Enables, disables, or suspends all JMS triggers, all JMS triggers of a particular type (standard or SOAP-JMS), or an individual JMS trigger.
*GET /admin/jndi Retrieves all JNDI connection aliases.
*GET /admin/jndi/{jndiAliasName} Retrieves information for a specific JNDI connection alias.
*POST /admin/jndi Creates a JNDI connection alias.
*POST /admin/jndi/{jndiAliasName} Performs an administrative action on a JNDI connection alias.
*PATCH /admin/jndi/{jndiAliasName} Updates a JNDI connection alias.
*PUT /admin/jndi/{jndiAliasName} Replaces a JNDI connection alias.
*DELETE /admin/jndi/{jndiAliasName} Deletes a JNDI connection alias.
*GET /admin/jwt/globalsettings Retrieves the JWT global settings.
*PATCH /admin/jwt/globalsettings Updates the JWT global settings.
*GET /admin/jwt/issuer/ Retrieves a list of all trusted issuers for JWT authentication
*GET /admin/jwt/issuer/{issuer} Retrieves a specific trusted issuer for JWT authentication.
*POST /admin/jwt/issuer/ Creates a trusted issuer.
*PATCH /admin/jwt/issuer/{issuer} Updates a trusted issuer.
*PUT /admin/jwt/issuer/{issuer} Replaces a trusted issuer.
*DELETE /admin/jwt/issuer/{issuer} Deletes a trusted issuer.
*DELETE /admin/jwt/issuer/{issuer}/issuerSkew Deletes an issuer-skew mapping.
*DELETE admin/jwt/issuer/{issuer}/truststoreAlias/{truststoreAlias}/certificateAlias/{certificateAlias} Deletes an issuer-certificate mapping.
*GET /admin/kerberos/ Retrieves the Kerberos configuration.
*PATCH /admin/kerberos/ Updates the Kerberos configuration.
*GET /admin/ldap/ Retrieves LDAP settings.
*PATCH /admin/ldap Updates LDAP settings.
*GET /admin/ldap/dir/ Retrieves all LDAP directory configurations.
*GET /admin/ldap/dir/{index} Retrieves an LDAP directory configuration.
*POST /admin/ldap/dir/ Creates an LDAP directory configuration.
*PATCH /admin/ldap/dir/{index} Updates an LDAP directory configuration.
*PUT /admin/ldap/dir/{index} Replaces an LDAP directory configuration.
*DELETE /admin/ldap/dir/{index} Deletes an LDAP directory configuration.
*GET /admin/log/{logName} Retrieves audit logger data.
*GET /admin/logger/ Returns a list of all audit loggers.
*GET /admin/logger/{loggerName} Retrieves an audit logger.
*POST /admin/logger/{loggerName} Performs an enable or disable action on an audit logger.
*PATCH /admin/logger/{loggerName} Updates an audit logger configuration.
*PUT /admin/logger/{loggerName} Replaces an audit logger configuration.
*GET /admin/logger/server Retrieves all the top-level components for which the server logger can be configured.
*GET /admin/logger/server/{component} Retrieves the server logger facility codes and logging levels for a particular component.
*GET /admin/logger/server/{component}/{facilityCode} Retrieves the logging level for a top-level component and the logging levels for all the facilities in the component.
*PATCH /admin/logger/server Updates Default logging level for Integration Server.
*PATCH /admin/logger/server/{component} Updates the default logging level for a top-level component.
*PATCH /admin/logger/server/{component}/{facilityCode} Updates the logging level for a facility code in a component.
*GET /admin/messaging Retrieves all webMethods messaging connection aliases.
*GET /admin/messaging/{aliasName} Retrieves a specific webMethods messaging connection alias.
*POST /admin/messaging/ Creates a webMethods messaging connection alias.
*POST /admin/messaging/{aliasName} Enables or disables a webMethods messaging connection alias or sets an alias as the default webMethods messaging connection alias.
*PATCH /admin/messaging/{aliasName} Updates a webMethods messaging connection alias.
*PUT /admin/messaging/{aliasName} Replaces a webMethods messaging connection alias.
*DELETE /admin/messaging/{aliasName} Deletes a webMethods messaging connection alias.
*GET /admin/messagingtrigger Retrieves all webMethods messaging triggers.
*GET /admin/messagingtrigger/{triggerName} Retrieves a particular webMethods messaging trigger.
*POST /admin/messagingtrigger/{triggerName} Activates or suspends message retrieval and/or message processing for a webMethods messaging trigger. Set triggerName to "all" to affect all webMethods messaging triggers
*GET /admin/mqtt Retrieves all MQTT connection aliases.
*GET /admin/mqtt/{connectionAliasName} Retrieves an MQTT connection alias.
*POST /admin/mqtt/ Creates an MQTT connection alias.
*POST /admin/mqtt/{connectionAliasName} Performs administrative actions (enable or disable) on an MQTT connection alias.
*PATCH /admin/mqtt/{connectionAliasName} Updates an MQTT connection alias.
*PUT /admin/mqtt/{connectionAliasName} Replaces an MQTT connection alias.
*DELETE /admin/mqtt/{connectionAliasName} Deletes an MQTT connection alias.
*GET /admin/mqtttrigger Retrieves all MQTT triggers.
*GET /admin/mqtttrigger/{triggerName} Retrieves a specific MQTT trigger.
*POST /admin/mqtttrigger/{triggerName} Enables, disables, or suspends all or a specific MQTT trigger.
*DELETE /admin/package/{packageName} Deletes a package.
*GET /admin/port Retrieves all ports for Integration Server or for a package. This operation does not support the expand parameter.
*GET /admin/port/diagnostic Retrieves a link to the diagnostic port for Integration Server.
*GET /admin/port/primary Retrieves a link to the primary port for Integration Server.
*POST /admin/port Sets the primary port for Integration Server.
*GET /admin/port/ipaccess Retrieves the global IP access settings.
*PUT /admin/port/ipaccess Replaces the global IP access settings.
*GET /admin/port/email Retrieves all email ports.
*GET /admin/port/email/{alias} Retrieves an email port.
*POST /admin/port/email Creates an email port.
*POST /admin/port/email/{alias} Enables or disables an email port.
*PATCH /admin/port/email/{alias} Updates an email port.
*PUT /admin/port/email/{alias} Replaces an email port.
*DELETE /admin/port/email/{alias} Deletes an email port.
*GET /admin/port/email/{alias}/ipaccess Retrieves the IP access settings for an email port.
*PUT /admin/port/email/{alias}/ipaccess Replaces the IP access settings for an email port.
*DELETE /admin/port/email/{alias}/ipaccess Deletes the IP access settings for an email port. Once deleted, the port will use the global IP access settings.
*GET /admin/port/email/{alias}/resourceaccess Retrieves the resource access settings for an email port.
*PUT /admin/port/email/{alias}/resourceaccess Replaces the resource access settings for an email port.
*GET /admin/port/enterprisegateway/ Retrieves all Enterprise Gateway ports.
*GET /admin/port/enterprisegateway/{alias} Retrieves an Enterprise Gateway port.
*POST /admin/port/enterprisegateway/ Creates an Enterprise Gateway port.
*POST /admin/port/enterprisegateway/{alias} Enables or disables an Enterprise Gateway port.
*PATCH /admin/port/enterprisegateway/{alias} Updates an Enterprise Gateway port.
*PUT /admin/port/enterprisegateway/{alias} Replaces an Enterprise Gateway port.
*DELETE /admin/port/enterprisegateway/{alias} Deletes an Enterprise Gateway port.
*GET /admin/port/enterprisegateway/{alias}/ipaccess Retrieves the IP access settings for an Enterprise Gateway port.
*PUT /admin/port/enterprisegateway/{alias}/ipaccess Replaces the IP access settings for an Enterprise Gateway port.
*GET /admin/port/internalserver/ Retrieves all Internal Server ports.
*GET /admin/port/internalserver/{alias} Retrieves an Internal Server port.
*POST /admin/port/internalserver Creates an Internal Server port.
*POST /admin/port/internalserver/{alias} Enables or disables an Internal Server port.
*PATCH /admin/port/internalserver/{alias} Updates an Internal Server port.
*PUT /admin/port/internalserver/{alias} Replaces an Internal Server port.
*DELETE /admin/port/internalserver/{alias} Deletes an Internal Server port.
*GET /admin/port/internalserver/{alias}/resourceaccess Retrieves the resource access settings for an Internal Server port.
*PUT /admin/port/internalserver/{alias}/resourceaccess Replaces the resource access settings for an Internal Server port.
*GET /admin/port/http/ Retrieves all HTTP ports.
*GET /admin/port/http/{alias} Retrieves an HTTP port.
*POST /admin/port/http/ Creates an HTTP port.
*PATCH /admin/port/http/{alias} Updates an HTTP port.
*PUT /admin/port/http/{alias} Replaces an HTTP port.
*DELETE /admin/port/http/{alias} Deletes an HTTP port.
*POST /admin/port/http/{alias} Enables, disables, suspends, or resumes an HTTP port.
*GET /admin/port/http/{alias}/ipaccess Retrieves the IP access settings for an HTTP port.
*PUT /admin/port/http/{alias}/ipaccess Replaces the IP access settings for an HTTP port.
*DELETE /admin/port/http/{alias}/ipaccess Deletes the IP access settings for an HTTP port. Once deleted, the port will use the global IP access settings.
*GET /admin/port/http/{alias}/resourceaccess Retrieves the resource access settings for an HTTP port.
*PUT /admin/port/http/{alias}/resourceaccess Replaces the resource access settings for an HTTP port.
*GET /admin/port/https/ Retrieves all HTTPS ports.
*GET /admin/port/https/{alias} Retrieves an HTTPS port.
*POST /admin/port/https/ Creates an HTTPS port.
*PATCH /admin/port/https/{alias} Updates an HTTPS port.
*PUT /admin/port/https/{alias} Replaces an HTTPS port.
*DELETE /admin/port/https/{alias} Deletes an HTTPS port.
*POST /admin/port/https/{alias} Enables, disables, suspends, or resumes an HTTPS port.
*GET /admin/port/https/{alias}/ipaccess Retrieves the IP access settings for an HTTPS port.
*PUT /admin/port/https/{alias}/ipaccess Replaces the IP access settings for an HTTPS port.
*DELETE /admin/port/https/{alias}/ipaccess Deletes the IP access settings for an HTTPS port. Once deleted, the port will use the global IP access settings.
*GET /admin/port/https/{alias}/resourceaccess Retrieves the resource access settings for an HTTPS port.
*PUT admin/port/https/{alias}/resourceaccess Replaces the resource access settings for an HTTPS port.
*GET /admin/port/websocket Retrieves all WebSocket and WebSocketSecure ports.
*GET /admin/port/websocket/{alias} Retrieves a WebSocket or WebSocketSecure port.
*POST /admin/port/websocket Creates a WebSocket or WebSocketSecure port.
*POST /admin/port/websocket/{alias} Enables or disables a WebSocket or WebSocketSecure port.
*PATCH /admin/port/websocket/{alias} Updates a WebSocket or WebSocketSecure port.
*PUT /admin/port/websocket/{alias} Replaces a WebSocket or WebSocketSecure port.
*DELETE /admin/port/websocket/{alias} Deletes a WebSocket or WebSocketSecure port.
*GET /admin/port/websocket/{alias}/ipaccess Retrieves the IP access settings for a WebSocket or WebSocketSecure port.
*PUT /admin/port/websocket/{alias}/ipaccess Replaces the IP access settings for a WebSocket or WebSocketSecure port.
*DELETE /admin/port/websocket/{alias}/ipaccess Deletes the IP access settings for a WebSocket or WebSocketSecure port. Once deleted, the port will use the global IP access settings.
*GET /admin/port/websocket/{alias}/resourceaccess Retrieves the resource access settings for a WebSocket or WebSocketSecure port
*PUT /admin/port/websocket/{alias}/resourceaccess Replaces the resource access settings for a WebSocket or WebSocketSecure port.
*GET /admin/proxy/ Retrieves all proxy server aliases.
*GET /admin/proxy/{proxyAlias} Retrieves a proxy server alias.
*POST /admin/proxy/ Creates a proxy server alias.
*POST /admin/proxy/{proxyAlias} Performs administrative actions on a proxy server alias.
*PATCH /admin/proxy/{proxyAlias} Updates a proxy server alias.
*PUT /admin/proxy/{proxyAlias} Replaces a proxy server alias.
*DELETE /admin/proxy/{proxyAlias} Deletes a proxy server alias
*GET /admin/quiesce/ Retrieves the current server mode (active or quiesce) and the quiesce port.
*POST /admin/quiesce/ Enters the Integration Server into quiesce mode from active mode or exits it from quiesce mode to active mode.
*POST /admin/quiesce/port Sets the specified port as the quiesce port.
*GET /admin/scheduledtask/ Retrieves all scheduled user tasks.
*GET /admin/scheduledtask/{taskId} Retrieves a scheduled user task.
*POST /admin/scheduledtask/ Creates a scheduled task.
*POST /admin/scheduledtask/{taskId} Suspends, wakes up, or cancels a scheduled task.
*PATCH /admin/scheduledtask/{taskId} Updates a scheduled task
*PUT /admin/scheduledtask/{taskId} Replaces a scheduled task.
*DELETE admin/scheduledtask/{taskId} Deletes a scheduled task.
*GET /admin/scheduler Retrieves the current scheduler state (running or paused) and a list of scheduled tasks.
*POST /admin/scheduler Resumes or pauses scheduler.
*GET /admin/server/httpout Retrieves outbound HTTP settings.
*PATCH /admin/server/httpout Updates outbound HTTP settings.
*GET /admin/server/memory Retrieves available memory information for Integration Server
*GET /admin/server/notification Retrieves email notification settings.
*PATCH /admin/server/notification Updates email notification settings.
*GET /admin/server/session Retrieves the session settings.
*PATCH /admin/server/session Updates the session settings.
*GET /admin/server/setting Retrieves values for all extended settings in Integration Server.
*GET /admin/server/setting/{settingName} Retrieves the value of a specific extended setting.
*POST /admin/server/setting Resets specified extended settings to their default values.
*PATCH /admin/server/setting/{settingName} Updates an extended setting.
*PATCH /admin/server/setting/ Updates multiple extended settings
*PUT /admin/server/setting/ Updates multiple extended settings.
*GET /admin/server/sso Retrieves the MWS single sign-on setting
*PATCH /admin/server/sso Updates the MWS single sign-on setting
*GET /admin/server/threadpool Retrieves server threadpool settings.
*PATCH /admin/server/threadpool Updates server threadpool settings.
*GET /admin/sftpserver Retrieves all SFTP server aliases.
*GET /admin/sftpserver/{alias} Retrieves a specific SFTP server alias.
*POST /admin/sftpserver Creates an SFTP server alias.
*PATCH /admin/sftpserver/{alias} Updates an SFTP server alias.
*PUT /admin/sftpserver/{alias} Replaces an SFTP server alias.
*DELETE /admin/sftpserver/{alias} Deletes an SFTP server alias.
*GET /admin/sftpuser Retrieves all SFTP user aliases.
*GET /admin/sftpuser/{alias} Retrieves a specific SFTP user alias.
*POST /admin/sftpuser Creates an SFTP user alias.
*PATCH /admin/sftpuser/{alias} Updates an SFTP user alias.
*PUT /admin/sftpuser/{alias} Replaces an SFTP user alias.
*DELETE /admin/sftpuser/{alias} Deletes an SFTP user alias.
*GET /admin/user/ Retrieves all user accounts.
*GET /admin/user/{username} Retrieves a user account.
*POST /admin/user/ Creates a user account.
*POST /admin/user/{username} Enables or disables a user account.
*PATCH /admin/user/{username} Updates a user account.
*PUT /admin/user/{username} Replaces a user account.
*DELETE /admin/user/{username} Deletes a user account.
Changed APIs
*GET /admin/server Now returns information indicating if and why a server restart is needed for configuration changes to take effect.
*POST /admin/package/{packageName} Now supports the administrative actions archive and recover.