Skip to content
This repository was archived by the owner on Jun 2, 2021. It is now read-only.

Commit 8428a74

Browse files
belinda-liureidmit
andcommitted
v3: Add docs for clear_buildpack_cache endpoint
[Finishes #163341383] Co-authored-by: Belinda Liu <bliu@pivotal.io> Co-authored-by: Reid Mitchell <rmitchell@pivotal.io>
1 parent 1d4b218 commit 8428a74

3 files changed

Lines changed: 39 additions & 0 deletions

File tree

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
### Clear buildpack cache
2+
3+
```
4+
Example Request
5+
```
6+
7+
```shell
8+
curl "https://api.example.org/v3/admin/actions/clear_buildpack_cache" \
9+
-X POST \
10+
-H "Authorization: bearer [token]"
11+
```
12+
13+
```
14+
Example Response
15+
```
16+
17+
```http
18+
HTTP/1.1 202 Accepted
19+
Location: https://api.example.org/v3/jobs/[guid]
20+
```
21+
22+
This endpoint will delete all of the existing buildpack caches in the
23+
blobstore. The buildpack cache is used during staging by buildpacks as a way to
24+
cache certain resources, e.g. downloaded Ruby gems. An admin who wants to
25+
decrease the size of their blobstore could use this endpoint to delete
26+
unnecessary blobs.
27+
28+
#### Definition
29+
`POST /v3/admin/actions/clear_buildpack_cache`
30+
31+
#### Permitted Roles
32+
|
33+
--- | ---
34+
Admin |
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Admin
2+
3+
These endpoints are only for admin users.

docs/v3/source/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ includes:
5555
- concepts/status_codes
5656
- concepts/warnings
5757
- resources/header
58+
- resources/admin/header
59+
- resources/admin/clear_buildpack_cache
5860
- resources/apps/header
5961
- resources/apps/object
6062
- resources/apps/create

0 commit comments

Comments
 (0)