You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
-88Lines changed: 0 additions & 88 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,94 +31,6 @@ Once running, the proxy operates as a local `SOCKS5` server and can be configure
31
31
32
32
See [OpenAPI specification](https://github.com/censortracker/proxy/blob/main/proxyserver/openapi_en.yaml) for more details.
33
33
34
-
#### Retrieve Configs
35
-
36
-
**`GET /api/v1/configs`**
37
-
38
-
This endpoint retrieves a list of configs. You can request either all configs or specific ones by UUID.
39
-
40
-
##### Query Parameters
41
-
42
-
-`uuid` (optional): A comma-separated list of UUIDs.
43
-
44
-
##### Response
45
-
46
-
- If no `uuid` is provided – returns all configs.
47
-
- If `uuid`s are provided – returns only the specified configs.
48
-
- If no matching configs are found – returns an empty list.
49
-
50
-
#### Add Configs
51
-
52
-
**`POST /api/v1/configs`**
53
-
54
-
This endpoint adds one or more new configs. Each config is assigned a unique UUID.
55
-
56
-
##### Request Body
57
-
58
-
An array of serialized config strings, for example: `["vless://…", "vmess://…", "trojan://…"]`
59
-
60
-
##### Response
61
-
62
-
- 200 OK if the configs are added successfully.
63
-
- 400 Bad Request if the data format is invalid.
64
-
65
-
66
-
#### Replace Entire Config List
67
-
68
-
**`PUT /api/v1/configs`**
69
-
70
-
This endpoint completely replaces the current list of configs with a new list. If the currently active config is missing from the new list, the first config in the list becomes active.
71
-
72
-
##### Request Body
73
-
74
-
A JSON array containing the full list of configs.
75
-
76
-
##### Response
77
-
78
-
- 200 OK if the list is updated successfully.
79
-
- 400 Bad Request if the data format is invalid.
80
-
81
-
#### Delete a Config
82
-
83
-
**`DELETE /api/v1/configs`**
84
-
85
-
This endpoint deletes a config by its UUID. If the active config is deleted, the first remaining config becomes active.
86
-
87
-
##### Query Parameters
88
-
89
-
-`uuid` (required): The UUID of the config to delete.
90
-
91
-
##### Response
92
-
93
-
- 204 No Content if the config is deleted successfully.
94
-
- 404 Not Found if the config is not found.
95
-
96
-
#### Activate a Config
97
-
98
-
**`PUT /api/v1/configs/activate`**
99
-
100
-
This endpoint sets the specified config as active by deserializing and preparing it for use.
101
-
102
-
##### Query Parameters
103
-
104
-
-`uuid` (required): The UUID of the config to activate.
105
-
106
-
##### Response
107
-
108
-
- 200 OK if the config is activated successfully.
109
-
- 404 Not Found if the config is not found.
110
-
111
-
#### Retrieve Active Config
112
-
113
-
**`GET /api/v1/configs/active`**
114
-
115
-
This endpoint returns the currently active config.
116
-
117
-
##### Response
118
-
- Returns the active config.
119
-
- 404 Not Found if there is no active config.
120
-
121
-
122
34
## Contributions
123
35
124
36
Contributions are welcome! Feel free to fork this repository, submit issues, and open pull requests.
0 commit comments