REST via API Gateway

Introduction

The MC2 ReST APIs can be accessed via API Gateway instead of via IIS (web server). API Gateway is the standard access method in Eagle Access.

Read Timeout for API Gateway

The read timeout is the time-out applied from the moment you have established a connection (So handshaking is done, and the connection can be used). If no data comes from the server in this time-out time, the connection is terminated.

The API gateway uses a default read timeout value of 120000 in milliseconds. This is equal to two minutes.
This should be reasonable amount of time for most REST APIs, but if you have an API that is longer running, the timeout value can be increased by a header passed into the API. The header key is ioreadtimeout and the value should be in milliseconds, e.g. a value of 300000 would be 5 minutes.

On this page

1 Introduction
2 Read Timeout for API Gateway
3 Max Reply Message Size
4 API Gateway – MC2 Entitlements

Example:

^{curl --location --request GET 'https://clicktime.symantec.com/3NUzcQdPYLtkF2wuYyG4Jtd7Vc?u=https%3A%2F%2Fyour.api' --header 'ioreadtimeout: 300000'}

Please use reasonable timeout values when using this override as it does impact performance on the gateway. The API Gateway can handle up to 36000000 (1 hour) as maximum override.

Max Reply Message Size

The API Gateway has a maximum reply message size of 300mb. If the size is exceeded the following error is returned:

^{ERROR security.service.eagle_api 500 Internal Server Error: 500routing routing to backend failed.}

API Gateway – MC2 Entitlements

The effective front end user name should be passed to MC2 with the http header x-eagle-user-id
MC2 ReST processing will include the user's Business Group in the request passed along to the extract, unless the user is a super user. The Business Group will function as an entity filter during the execution of the extract. The one exception is the paceolap feedtype via the eql endpoint, which uses the front end user configured in the EDS UI Vendor Configuration under the pace vendor ID.

A user's BusinessGroup is cached within MC2.
The cache has a time to live of 3 hours (pre February 2021 release) or 1 hour (February 2021 release). If needed, the cache may be refreshed immediately by reinitializing the MC2 rule cache.