Revela-API/README.md
2024-03-14 16:26:02 -04:00

60 lines
No EOL
1.7 KiB
Markdown

# Revela-API
To generate an API key run: `npm run genkey`
to start the API run: `npm start`
## Curl commands for Windows:
```
curl -X GET "https://api.revela.network/urls" ^
-A "useragent" ^
-H "Content-Type: application/json" ^
-H "api-key: apikey"
curl -X POST "https://api.revela.network/urls" ^
-A "useragent" ^
-H "Content-Type: application/json" ^
-H "api-key: apikey" ^
-d "{\"domain\":\"domain.tld\", \"is_public\":<true or false>}"
curl -X DELETE "https://api.revela.network/urls" ^
-A "useragent" ^
-H "Content-Type: application/json" ^
-H "api-key: apikey" ^
-d "{\"domain\":\"domain.tld\", \"is_public\":<true or false>}"
curl -X PATCH "https://api.revela.network/urls" ^
-A "useragent" ^
-H "Content-Type: application/json" ^
-H "api-key: apikey" ^
-d "{\"domain\":\"domain2.tld\", \"is_public\":<true or false>}"
```
## Curl commands for Unix:
```
curl -X GET "https://api.revela.network/urls" /
-A "useragent" /
-H "Content-Type: application/json" /
-H "api-key: apikey"
curl -X POST "https://api.revela.network/urls" /
-A "useragent" /
-H "Content-Type: application/json" /
-H "api-key: apikey" /
-d "{\"domain\":\"domain.tld\", \"is_public\":<true or false>}"
curl -X DELETE "https://api.revela.network/urls" /
-A "useragent" /
-H "Content-Type: application/json" /
-H "api-key: apikey" /
-d "{\"domain\":\"domain.tld\", \"is_public\":<true or false>}"
curl -X PATCH "https://api.revela.network/urls" /
-A "useragent" /
-H "Content-Type: application/json" /
-H "api-key: apikey" /
-d "{\"domain\":\"domain2.tld\", \"is_public\":<true or false>}"
```