]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - support/doc/api/quickstart.md
Bumped to version v1.4.1
[github/Chocobozzz/PeerTube.git] / support / doc / api / quickstart.md
index 844248a7f0dac427f9573280688833dcbc52941a..2222be741af6088dd0c9a79f5b05a77977603bfd 100644 (file)
@@ -6,13 +6,13 @@
 
 Some endpoints need authentication. We use OAuth 2.0 so first fetch the client tokens:
 
-```
+```bash
 $ curl https://peertube.example.com/api/v1/oauth-clients/local
 ```
 
 Response example:
 
-```
+```json
 {
   "client_id": "v1ikx5hnfop4mdpnci8nsqh93c45rldf",
   "client_secret": "AjWiOapPltI6EnsWQwlFarRtLh4u8tDt"
@@ -23,7 +23,7 @@ Response example:
 
 Now you can fetch the user token:
 
-```
+```bash
 $ curl -X POST \
  -d "client_id=v1ikx5hnfop4mdpnci8nsqh93c45rldf&client_secret=AjWiOapPltI6EnsWQwlFarRtLh4u8tDt&grant_type=password&response_type=code&username=your_user&password=your_password" \
   https://peertube.example.com/api/v1/users/token
@@ -31,7 +31,7 @@ $ curl -X POST \
 
 Response example:
 
-```
+```json
 {
   "access_token": "90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0",
   "token_type": "Bearer",
@@ -42,13 +42,13 @@ Response example:
 
 Just use the `access_token` in the `Authorization` header:
 
-```
-$ curl -H 'Authorization: Bearer 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0' https://peertube.example.com/api/v1/jobs/complete
+```bash
+$ curl -H 'Authorization: Bearer 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0' https://peertube.example.com/api/v1/jobs/completed
 ```
 
 
-### List videos
+## List videos
 
-```
+```bash
 $ curl https://peertube.example.com/api/v1/videos
-```
\ No newline at end of file
+```