More Info:

Ensure XRAY is enabled for API Gateway

Risk Level

Low

Address

Reliability, Operational Maturity, Security

Compliance Standards

CBP

Triage and Remediation

Remediation

To remediate the misconfiguration of API Gateway X-Ray not being enabled in AWS, follow these steps using the AWS Management Console:

  1. Sign in to the AWS Management Console: Go to https://aws.amazon.com/ and sign in to your AWS account.

  2. Navigate to API Gateway: Click on the “Services” dropdown at the top of the page, search for “API Gateway” in the search bar, and click on it to open the API Gateway console.

  3. Select Your API: In the API Gateway console, select the API for which you want to enable X-Ray tracing.

  4. Enable X-Ray Tracing:

    • In the API Gateway console, click on the “Stages” option in the left-hand navigation pane.
    • Select the desired stage (e.g., “Prod”) for which you want to enable X-Ray tracing.
    • Under the selected stage, click on the “Logs/Tracing” tab.
    • Toggle the “Enable X-Ray Tracing” option to enable X-Ray tracing for the selected stage.
  5. Save Changes: Click on the “Save Changes” button to apply the configuration changes.

  6. Verify X-Ray Tracing: To verify that X-Ray tracing is enabled for your API Gateway, you can make a test request to your API and check the X-Ray console to see if traces are being recorded.

By following these steps, you will successfully remediate the misconfiguration of API Gateway X-Ray not being enabled in AWS.