Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 1.25 KB

rest-methods.md

File metadata and controls

45 lines (34 loc) · 1.25 KB
sidebar_position title description
6
Documentation of Foo's API REST methods for its page experience testing services
Documentation of Foo's API REST methods for its page experience testing services. Foo provides testing and monitoring services using Lighthouse and Web Vitals.

REST Methods

Important

Foo API is now deprecated and will sunset on 01/01/2026. It will be permanently offline soon after that date.

Foo's REST API expects standard requests and payloads. Below are examples of different REST methods via cURL.

GET

curl -X GET "https://www.foo.software/api/v2/pages?limit=5" \
  -H "authorization: abc123"

POST

curl -X POST "https://www.foo.software/api/v2/pages" \
  -H "authorization: abc123" \
  -H "content-type: application/json" \
  -d "{ \"url\": \"https://www.foo.software\", \"name\": \"Foo home page\" }"

PUT

curl -X PUT "https://www.foo.software/api/v2/pages/123" \
  -H "authorization: abc123" \
  -H "content-type: application/json" \
  -d "{ \"name\": \"Foo home page (updated name)\" }"

DELETE

curl -X DELETE "https://www.foo.software/api/v2/pages/123" \
  -H "authorization: abc123" \
  -H "content-type: application/json"