diff --git a/docs/API.md b/docs/API.md index 27c4d24f7..61828f110 100644 --- a/docs/API.md +++ b/docs/API.md @@ -58,6 +58,7 @@ curl -i -H "Accept:application/json" "https://echoctf.red/api/headshots?filter[p ## Bearer Operations For the following endpoints you will need to have a bearer token to be able to access them +* `api/profile/me`: Get your profile details * `api/target/claim`: Submit a flag for validation * `api/target/instances`: List of instances (if any) * `api/target/`: Get details for a given target @@ -65,6 +66,15 @@ For the following endpoints you will need to have a bearer token to be able to a * `api/target//spawn`: Spawn a private instance (if allowed) * `api/target//shut`: Shutdown a private instance +### Get profile details +URL: `GET /api/profile/me` + +```sh +curl "https://echoctf.red/api/target/me" \ + -H "Authorization: Bearer YOURTOKEN" \ + -H "Accept:application/json" +``` + ### Claim Flag URL: `POST /api/target/claim` \ POST: `{ "hash":"flag" }`