Skip to content

Commit

Permalink
Update restful_api.md
Browse files Browse the repository at this point in the history
Synchronization interface documentation
  • Loading branch information
alexliyu7352 authored Mar 7, 2024
1 parent dede769 commit 7822247
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions src/guide/media_server/restful_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ MediaServer is the main process of ZLMediaKit and currently supports the followi
"/index/api/getMediaPlayerList"
```

For the POST method, parameters can be sent in either urlencoded or JSON format. To authenticate these API operations, the `secret` parameter needs to be provided. However, if the operation is performed from the IP address 127.0.0.1, authentication is not required.
For the POST method, parameters can be sent in either urlencoded or JSON format.
To authenticate these API operations, the `secret` parameter needs to be provided.

## API Response Conventions

Expand Down Expand Up @@ -100,7 +101,12 @@ typedef enum {

- Example:[http://127.0.0.1/index/api/getApiList](http://127.0.0.1/index/api/getApiList)

- Parameters:None
- Parameters:

| Parameter | Required | Description |
| :-------: | :------: | :----------------------------------------: |
| secret | Y | API operation key (configured in the file) |


- Response:

Expand Down Expand Up @@ -169,7 +175,11 @@ typedef enum {

- Example:[http://127.0.0.1/index/api/getThreadsLoad](http://127.0.0.1/index/api/getThreadsLoad)

- Parameters: None
- Parameters:

| Parameter | Required | Description |
| :-------: | :------: | :----------------------------------------: |
| secret | Y | API operation key (configured in the file) |

- Response:

Expand All @@ -195,8 +205,12 @@ typedef enum {

- Example:[http://127.0.0.1/index/api/getWorkThreadsLoad](http://127.0.0.1/index/api/getWorkThreadsLoad)

- Parameters: None
- Parameters:

| Parameter | Required | Description |
| :-------: | :------: | :----------------------------------------: |
| secret | Y | API operation key (configured in the file) |

- Response:

```json
Expand Down

0 comments on commit 7822247

Please sign in to comment.