Cloudflare Docs
API Shield
Visit API Shield on GitHub
Set theme to dark (⇧+D)

Endpoint Management

Monitor the health of your API endpoints by saving, updating, and monitoring performance metrics using API Shield’s Endpoint Management.

Add endpoints allows customers to save endpoints directly from API Discovery or manually by method, path, and host.

This will add the specified endpoints to your list of managed endpoints. You can view your list of saved endpoints in the Endpoint Management page.

Cloudflare will start collecting performance data on your endpoint when you save an endpoint.

​​ Access

  1. Log in to the Cloudflare dashboard and select your account and domain.
  2. Select Security > API Shield.
  3. Add your endpoints manually or from API Discovery.

​​ Add endpoints from API Discovery

There are two ways to add API endpoints from Discovery.

​​ Add from the Endpoint Management Tab

  1. From Endpoint Management, select Add endpoints > Select from Discovery tab.
  2. Select the discovered endpoints you would like to add.
  3. Select Add endpoints.

​​ Add from the Discovery Tab

  1. From Endpoint Management, select the Discovery tab.
  2. Select the discovered endpoints you would like to add.
  3. Select Save selected endpoints.

​​ Add endpoints manually

  1. From Endpoint Management, select Add endpoints > Manually add.
  2. Choose the method from the dropdown menu and add the path and hostname for the endpoint.
  3. Select Add endpoints.

​​ Endpoint Performance Analysis

For each saved endpoint, customers can view:

  • Request count: The total number of requests to the endpoint over time.
  • Rate limiting recommendation: per 10 minutes. This is guided by the request count.
  • Latency: The average origin response time in milliseconds (ms). This metric shows how long it takes from the moment a visitor makes a request to the moment the visitor gets a response back from the origin.
  • Error rate vs. overall traffic: grouped by 4xx, 5xx, and their sum.
  • Response size: The average size of the response (in bytes) returned to the request.

​​ Using the Cloudflare API

You can interact with Endpoint Management through the Cloudflare API. Refer to Endpoint Management’s API documentation for more information.