API Gateway Administration
API Gateway provides the capability to API definitions to administer various functions of the API Gateway.
API Gateway provides the following REST API and the resources to manage API Gateway configuration:
GET/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 these eventType to scope the archive or purge 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/apitransactions/archives : Retrieves the details of existing archive files and response of this method would be the list of archive file names. You can select one of the archive file names returned by 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 additionally scope the archive data using input parameter filters. This method returns the job id as the response which 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 case of archive process) as a response.
GET/rest/apigateway/apitransactions/jobs : Retrieves a list of pending jobs. Every time you initiate archive, restore or purge process 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/licenseNotifications : Retrieves the latest notification issued for a transaction based license.
GET/rest/apigateway/licenseNotificationCriteria : Retrieves the existing transaction based license notification criteria as a response. Transaction based license notification criteria are like a usage checkpoint and whenever usage reaches that checkpoint, a notification is generated.
POST/rest/apigateway/licenseNotificationCriteria : Creates the transaction based license notification criteria to monitor the
API Gateway usage. This notification criteria has the permitted invocations per month defined in the license file. If you want to get notified when usage reaches a limit before it breaches the license limit, then you have to add a notification criteria by mentioning the usage point so that a notification is generated when usage reaches the specified limit.
PUT/rest/apigateway/licenseNotificationCriteria : Updates the existing transaction based license notification criteria in
API Gateway.
GET/rest/apigateway/licenseNotificationCriteria/{notificationCriteriaId} : Retrieves the transaction based license notification criteria based on the specified ID.
DELETE/rest/apigateway/licenseNotificationCriteria/{notificationCriteriaId} : Deletes the transaction based license notification criteria based on the specified ID.
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/extended: Retrieves the list of the extended settings configured.
PUT/rest/apigateway/configurations/extended: Updates or creates a list of the extended settings configured.
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/gatewayDestinationConfig: Retrieves the details of the
API Gateway destination.
API Gateway can publish events and performance metrics data. By default, error events, lifecycle events, policy violation event, and performance data are published to
API Gateway.
PUT/rest/apigateway/configurations/gatewayDestinationConfig: Updates the details of the
API Gateway destination in
API Gateway.
GET/rest/apigateway/configurations/auditlogDestinationConfig: Retrieves the details of the Audit Log destination in
API Gateway. Audit log captures the API runtime invocations performed in
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 Log Invocation policy.
PUT/rest/apigateway/configurations/auditlogDestinationConfig: Updates the details of the Audit Log destination in
API Gateway.
GET/rest/apigateway/configurations/centraSiteDestinationCommunicationConfig : Retrieves the communication details of the
CentraSite destination in
API Gateway.
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
API Gateway.
GET/rest/apigateway/configurations/centraSiteDestinationSNMPConfig : Retrieves the SNMP details of the
CentraSite destination in
API Gateway.
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
API Gateway.
GET/rest/apigateway/configurations/jdbcDestinationConfig: Retrieves details of the Database destination in
API Gateway.
API Gateway can publish events and metrics to the configured database.
PUT/rest/apigateway/configurations/jdbcDestinationConfig: Updates the details of the database destination in
API Gateway.
GET/rest/apigateway/configurations/desDestinationConfig: Retrieves details of the Digital Events destination in
API Gateway. Digital Event Services (DES) enables
API Gateway to communicate by exchanging digital events. Digital events are typed and serialized data structures that are used to convey or record information about the execution of a runtime.
PUT/rest/apigateway/configurations/desDestinationConfig: Updates the details of the Digital Events destination in
API Gateway.
GET/rest/apigateway/configurations/elasticsearchDestinationConfig: Retrieves details of the Elasticsearch destination in
API Gateway.
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
API Gateway.
GET/rest/apigateway/configurations/snmpDestinationConfig: Retrieves details of the SNMP destination in
API Gateway.
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
API Gateway.
GET/rest/apigateway/configurations/emailDestinationConfig: Retrieves details of the Email destination in
API Gateway.
API Gateway can send alerts to the email ID specified either in the Log Invocation, Monitor Service Performance, Monitor Service Level Agreement or Throttling Traffic Optimization policies through the configured Email destination.
PUT/rest/apigateway/configurations/emailDestinationConfig: Updates the details of the Email destination in
API Gateway.
GET/rest/apigateway/configurations/jsonWebToken: Retrieves the details of the
API Gateway JSON Web Token (JWT) configuration.
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 represented by the name-value pairs, where the names are strings and the values are arbitrary JSON values.
PUT/rest/apigateway/configurations/jsonWebToken: Updates the details of the JWT configuration in
API Gateway.
GET/rest/apigateway/approvalConfigurations: Retrieves a list of available approval configurations in
API Gateway.
POST/rest/apigateway/approvalConfigurations: Creates an approval configuration in
API Gateway.
GET/rest/apigateway/approvalConfigurations/{id}: Retrieves the details of a specified approval configuration in
API Gateway.
PUT/rest/apigateway/approvalConfigurations/{id}: Updates the details of a specified approval configuration in
API Gateway.
DELETE/rest/apigateway/approvalConfigurations/{id}: Deletes the specified approval configuration in
API Gateway.
For details on the REST API see the swagger file APIGatewayAdministration.json, located at Install directory/IntegrationServer/instances/default/packages/WmAPIGateway/resources/apigatewayservices.