aboutsummaryrefslogtreecommitdiff
path: root/docs/RESTAPI.md
blob: d3ec04d07846586a2249e9fe17d89f356a909097 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# REST API

The REST interface exposed is considered a private implementation detail and
is going to evolve. We do not recommend that you interface with it other than 
for testing purposes.

## Test Service

Intended to be used for basic connectivity testing. Allows the client to fetch 
various kinds of payloads via well-known URIs

HTTP endpoint: `/test`

`/test/{size}` - verbs: (`GET`/`HEAD`)

Examples: `/test/1K` `/test/1M` `/test/1G`, `/test/1M_1k`, `/test/1G_1k`

## Cache Service

HTTP endpoint: `/cache`

`/cache/`

## Status Service