Skip to content

Commit

Permalink
Fix error in API docs for /url write method
Browse files Browse the repository at this point in the history
Change-type: minor

After having issues with this API, I checked the source code and realised the /url path accepts POST, not PUT, in order to change url.
  • Loading branch information
lorenzowritescode committed Nov 4, 2024
1 parent f9902c5 commit ac0a36e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,11 +166,11 @@ Re-scans the device to find local HTTP or HTTPS services to display. This can be
#### **GET** /url
Returns the URL currently being displayed

#### **PUT** /url
#### **POST** /url
Sets the URL to be displayed. The URL is set in the request body. Example:

```bash
curl --data "url=www.balena.io" http://localhost:5011/url
curl -X POST --data "url=www.balena.io" http://localhost:5011/url
```

You can also pre-set the kiosk and GPU settings as part of a URL put request. Example:
Expand Down

0 comments on commit ac0a36e

Please sign in to comment.