API Gateway Administration

webMethods API Gateway provides the following REST API and the resources to manage webMethods API Gateway configuration:

• GET/rest/apigateway/is/truststore/{truststoreName}

  Retrieves an existing truststore by matching the given name from webMethods API Gateway.

• POST/rest/apigateway/is/truststore/{truststoreName}

  Updates an existing truststore in webMethods API Gateway.

• DELETE/rest/apigateway/is/truststore/{truststoreName}

  Deletes an existing truststore in webMethods API Gateway.

• GET/rest/apigateway/is/truststore

  Retrieves all available truststores from webMethods API Gateway.

• POST/rest/apigateway/is/truststore

  Creates a truststore in webMethods API Gateway.

• GET/rest/apigateway/is/kerberos

  Retrieves the configured Kerberos settings from webMethods API Gateway.

• PUT/rest/apigateway/is/kerberos

  Persists the configured Kerberos settings in webMethods API Gateway.

• GET/rest/apigateway/is/license

  Retrieves the license details from webMethods API Gateway.

• PUT/rest/apigateway/is/license

  Update the license details in webMethods API Gateway.

• DELETE/rest/apigateway/is/outboundproxy/{outboundproxyAlias}

  It deletes the specified outbound proxy server alias from webMethods API Gateway.

• GET/rest/apigateway/is/outboundproxy

  Retrieves the list of all available outbound proxy server aliases in webMethods API Gateway.

• POST/rest/apigateway/is/outboundproxy

  Creates the outbound proxy server alias in webMethods API Gateway.

• PUT/rest/apigateway/is/outboundproxy

  Updates the outbound proxy server alias in webMethods API Gateway.

• PUT/rest/apigateway/is/outboundproxy/{outboundproxyAlias}/enable

  Enables an existing outbound proxy server alias in webMethods API Gateway.

• PUT/rest/apigateway/is/outboundproxy/{outboundproxyAlias}/disable

  Disables an already existing outbound proxy server alias in webMethods API Gateway.

• GET/rest/apigateway/logAggregation/downloadLogs

  Downloads logs from different components used by webMethods API Gateway, server configurations, and thread dumps.

• GET/rest/apigateway/is/cluster

  Retrieves the configured cluster settings from webMethods API Gateway.

• PUT/rest/apigateway/is/cluster

  Updates the cluster settings in webMethods API Gateway.

• GET/rest/apigateway/is/keystore/{keyStoreName}

  Retrieves the keystore that matches the name, which is specified in webMethods API Gateway.

• POST/rest/apigateway/is/keystore/{keyStoreName}

  Updates an existing keystore in webMethods API Gateway.

• DELETE/rest/apigateway/is/keystore/{keyStoreName}

  Deletes the keystore that matches the name, which is specified in webMethods API Gateway.

• GET/rest/apigateway/is/keystore

  Retrieves all keystores available in webMethods API Gateway.

• POST/rest/apigateway/is/keystore

  Creates a keystore in webMethods API Gateway.

• DELETE/rest/apigateway/apitransactions/typedefinitions

  Retrieves the list of runtime event types. The available event types are transactionalEvents, monitorEvents, errorEvents, performanceMetrics, threatProtectionEvents, lifecycleEvents, and policyViolationEvents. You can use this eventType to scope the archive or purge operation.

• GET/rest/apigateway/apitransactions

  Retrieves the API transactions data. The data to be downloaded is filtered based on the input parameters. The user must be part of the API-Gateway-Administrators group or must have Manage purge and restore runtime events privilege to do this operation.

• DELETE/rest/apigateway/apitransactions

  Purges the API transactions data and the data to be purged is filtered based on the input parameters. This method returns the job ID as response and the job ID is used to track the job status.

• GET/rest/apigateway/is/webServiceEndpoints/{webServiceEndpointId}

  Retrieves the specified Webservice endpoint in webMethods API Gateway.

• DELETE/rest/apigateway/is/webServiceEndpoints/{webServiceEndpointId}

  Deletes the specified Webservice endpoint in webMethods API Gateway.

• GET/rest/apigateway/is/webServiceEndpoints

  Retrieves list of all Webservice endpoints in webMethods API Gateway.

• POST/rest/apigateway/is/webServiceEndpoints

  Creates a Webservice endpoint in webMethods API Gateway. The API request body must contain the payload for the Webservice endpoint.

• PUT/rest/apigateway/is/webServiceEndpoints

  Updates the Webservice endpoint in webMethods API Gateway.

• GET/rest/apigateway/apitransactions/archives

  Retrieves the details of existing archive files and the response is the list of archive file names. You can select one of the archive file names that are returned in this method and use the POST /apitransactions/archives/{fileName} method to restore.

• POST/rest/apigateway/apitransactions/archives

  Archives the runtime events and metrics. You can also scope the archive data by using input parameter filters. This method returns the job ID as the response that is used to know the status of the job.

• POST/rest/apigateway/apitransactions/archives/{fileName}

  Restores the runtime data of the archive file that is specified. This method returns the job ID as a response to track the status further.

• GET/rest/apigateway/apitransactions/jobs/{jobId}

  Retrieves the status of a specific job. This method returns the status and file name \(in archive process\) as a response.

• GET/rest/apigateway/apitransactions/jobs

  Retrieves a list of pending jobs. Every time that you initiate the archive, restore or purge process that you get the job ID as a response. You can use the specific job ID to query the status of the initiated operation.

• GET/rest/apigateway/portalGateways/{portalGatewayId}

  Retrieves a Developer Portal configuration in webMethods API Gateway.

• PUT/rest/apigateway/portalGateways/{portalGatewayId}

  Updates the Developer Portal configuration in webMethods API Gateway.

• DELETE/rest/apigateway/portalGateways/{portalGatewayId}

  Deletes the Developer Portal configuration in webMethods API Gateway.

• GET/rest/apigateway/portalGateways

  Retrieves Developer Portal configurations that are available in webMethods API Gateway.

• POST/rest/apigateway/portalGateways

  Creates Developer Portal configuration in API Gateway.

• GET/rest/apigateway/portalGateways/communities

  Retrieves the details about communities in Developer Portal. An API can be published from webMethods API Gateway to any of the communities available in Developer Portal.

• GET/rest/apigateway/portalGateways/packages

  Retrieves the details of the published packages that the API is part of.

• POST/rest/apigateway/assets

  Changes ownership of application or APIs.

• GET/rest/apigateway/configurations/loadBalancer

  Retrieves information about the load balancer configured.

• PUT/rest/apigateway/configurations/loadBalancer

  Updates the load balancer configuration information.

• GET/rest/apigateway/configurations/whiteListingIPs

  Retrieves the details of the allowlisting configuration for IPs in webMethods API Gateway.

• PUT/rest/apigateway/configurations/whiteListingIPs

  Updates the details of the allowlisting configuration for IPs in webMethods API Gateway.

• GET/rest/apigateway/configurations/apiCallBackSettings

  Retrieves the API callback processor settings from webMethods API Gateway.

• PUT/rest/apigateway/configurations/apiCallBackSettings

  Updates or creates API callback processor settings in webMethods API Gateway. The user must have Manage general administration configurations privilege to update the API callback processor settings.

• GET/rest/apigateway/configurations/settings

  Retrieves the list of the extended settings watt properties from webMethods API Gateway.

• PUT/rest/apigateway/configurations/settings

  Updates or creates a list of the extended settings and watt properties in webMethods API Gateway.

• GET/rest/apigateway/configurations/errorProcessing

  Retrieves the configured error template and the value of the property sendNativeProviderFault, which enables the server to forward the native error as it is.

• PUT/rest/apigateway/configurations/errorProcessing

  Updates the default error template with any custom templates and the value of the property sendNativeProviderFault.

• GET/rest/apigateway/configurations/keystore

  Retrieves the details of the default keystore, truststore, and alias settings in webMethods API Gateway.

• PUT/rest/apigateway/configurations/keystore

  Updates the details of the default keystore, truststore, and alias configurations in webMethods API Gateway.

• GET/rest/apigateway/configurations/gatewayDestinationConfig

  Retrieves the details of the API Gateway destination. webMethods API Gateway can publish events and performance metrics data. By default, error events, lifecycle events, policy violation event, and performance data are published to webMethods API Gateway.

• PUT/rest/apigateway/configurations/gatewayDestinationConfig

  Updates the details of the API Gateway destination in webMethods API Gateway.

• GET/rest/apigateway/controlplane/config

  Retrieves API Control Plane agent configuration in webMethods API Gateway.

• PUT/rest/apigateway/controlplane/config

  Updates API Control Plane agent configuration in webMethods API Gateway.

• POST/rest/apigateway/controlplane/config

  Configures API Control Plane agent.

• DELETE/rest/apigateway/controlplane/config

  Deletes API Control Plane agent configuration in webMethods API Gateway.

• GET/rest/apigateway/configurations/auditlogDestinationConfig

  Retrieves the details of the Audit Log destination in webMethods API Gateway. Audit log captures the API runtime invocations that are performed in webMethods API Gateway. The audit log data is written to a file or a database based on the configurations. Transactions events are written to the audit log only when the Audit Log is selected as a destination in the Log Invocation policy.

• PUT/rest/apigateway/configurations/auditlogDestinationConfig

  Updates the details of the Audit Log destination in webMethods API Gateway.

• GET/rest/apigateway/configurations/centraSiteDestinationCommunicationConfig

  Retrieves the communication details of the CentraSite destination in webMethods API Gateway. webMethods API Gateway can publish events and metrics to the configured CentraSite destination.

• PUT/rest/apigateway/configurations/centraSiteDestinationCommunicationConfig

  Updates the communication details of the CentraSite destination in webMethods API Gateway.

• GET/rest/apigateway/configurations/centraSiteDestinationSNMPConfig

  Retrieves the SNMP details of the CentraSite destination in webMethods API Gateway. webMethods API Gateway can publish events and metrics to the configured CentraSite destination.

• PUT/rest/apigateway/configurations/centraSiteDestinationSNMPConfig

  Updates the SNMP details of the CentraSite destination in webMethods API Gateway.

• GET/rest/apigateway/configurations/jdbcDestinationConfig

  Retrieves details of the Database destination in webMethods API Gateway. webMethods API Gateway can publish events and metrics to the configured database.

• PUT/rest/apigateway/configurations/jdbcDestinationConfig

  Updates the details of the database destination in webMethods API Gateway.

• GET/rest/apigateway/configurations/elasticsearchDestinationConfig

  Retrieves details of the Elasticsearch destination in webMethods API Gateway. webMethods API Gateway can publish events and metrics to the configured Elasticsearch destination.

• PUT/rest/apigateway/configurations/elasticsearchDestinationConfig

  Updates the details of the Elasticsearch destination in webMethods API Gateway.

• GET/rest/apigateway/configurations/snmpDestinationConfig

  Retrieves details of the SNMP destination in webMethods API Gateway. webMethods API Gateway can publish events and metrics to the configured third party SNMP destination.

• PUT/rest/apigateway/configurations/snmpDestinationConfig

  Updates the details of the SNMP destination in webMethods API Gateway.

• GET/rest/apigateway/configurations/emailDestinationConfig

  Retrieves details of the email destination in webMethods API Gateway. webMethods API Gateway can send alerts to the email ID specified either in the Log Invocation, Monitor Performance, Monitor SLA, or Traffic Optimization policies through the configured email destination.

• PUT/rest/apigateway/configurations/emailDestinationConfig

  Updates the details of the email destination in webMethods API Gateway.

• GET/rest/apigateway/configurations/apiPortalDestinationConfig

  Retrieves details of the Developer Portal destination configuration. webMethods API Gateway can publish events and performance metrics data. By default, error events, lifecycle events, policy violation event, and performance data are published to Developer Portal.

• PUT/rest/apigateway/configurations/apiPortalDestinationConfig

  Updates the details of the Developer Portal destination in webMethods API Gateway.

• GET/rest/apigateway/configurations/cache

  Retrieves the cache configuration in webMethods API Gateway.

• PUT/rest/apigateway/configurations/cache

  Updates the cache configuration in webMethods API Gateway.

• GET/rest/apigateway/configurations/customContentTypes

  Retrieves the configured custom content types in webMethods API Gateway. Custom content types can be defined for base types XML, JSON, and Text. These Custom types can be then used for payload processing in policies like Content based routing, Identify, and access and Conditional error processing.

• PUT/rest/apigateway/configurations/customContentTypes

  Updates the configured custom content types in webMethods API Gateway. The response is a set of key or value pair where key indicates the custom content type and value indicates the base type. The value can be application or XML, or application or JSON, or text orXML.

• GET/rest/apigateway/configurations/logConfig

  Retrieves the log settings of various components that are used by webMethods API Gateway.

• PUT/rest/apigateway/configurations/logConfig

  Updates the details of the log configuration in webMethods API Gateway.

• GET/rest/apigateway/configurations/ldapConfig

  Retrieves the LDAP configuration settings that are configured in webMethods API Gateway.

• PUT/rest/apigateway/configurations/ldapConfig

  Updates the LDAP configuration settings that are configured in webMethods API Gateway.

• GET/rest/apigateway/configurations/passwordRestrictions

  Retrieves the password restrictions settings that are configured in webMethods API Gateway.

• PUT/rest/apigateway/configurations/passwordRestrictions

  Saves the password restrictions settings that are configured in webMethods API Gateway.

• GET/rest/apigateway/configurations/passwordExpiry

  Retrieves the password expiry settings that are configured in webMethods API Gateway.

• PUT/rest/apigateway/configurations/passwordExpiry

  Saves the password expiry settings that are configured in webMethods API Gateway.

• GET/rest/apigateway/configurations/accountLockSettings

  Retrieves the account lock settings that are configured in webMethods API Gateway.

• PUT/rest/apigateway/configurations/accountLockSettings

  Saves the account lock expiry settings that are configured in webMethods API Gateway.

• GET/rest/apigateway/configurations/jsonWebToken

  Retrieves the details of the webMethods API Gateway JSON Web Token (JWT) configuration. webMethods API Gateway can generate a JWT itself or validate the JWT generated by a trusted third-party server. JWT is a JSON-based open standard \(RFC 7519\) means of representing a set of information to be securely transmitted between two parties. A set of information is the set of claims (claim set) represented by the JWT. A claim set consists of zero or more claims that represented by the name-value pairs. The names are strings and the values are arbitrary JSON values.

• PUT/rest/apigateway/configurations/jsonWebToken

  Updates the details of the JWT configuration in webMethods API Gateway.

• GET/rest/apigateway/approvalConfigurations

  Retrieves a list of available approval configurations in webMethods API Gateway.

• POST/rest/apigateway/approvalConfigurations

  Creates an approval configuration in webMethods API Gateway.

• GET/rest/apigateway/approvalConfigurations/{id}

  Retrieves the details of a specified approval configuration in webMethods API Gateway.

• PUT/rest/apigateway/approvalConfigurations/{id}

  Updates the details of a specified approval configuration in webMethods API Gateway.

• DELETE/rest/apigateway/approvalConfigurations/{id}

  Deletes the specified approval configuration in webMethods API Gateway.

• GET/rest/apigateway/urlaliases

  Retrieves all URL Aliases or a URL Alias with a particular ID in webMethods API Gateway \(if the query parameter alias is provided\).

• POST/rest/apigateway/urlaliases

  Creates new URL alias in webMethods API Gateway.

• PUT/rest/apigateway/urlaliases

  Updates an existing URL alias in webMethods API Gateway.

• DELETE/rest/apigateway/urlaliases

  Deletes a URL alias in webMethods API Gateway.