forked from github-starred/komodo
42 lines
850 B
Plaintext
42 lines
850 B
Plaintext
import Divider from '@site/src/components/Divider';
|
|
|
|
# api secrets
|
|
|
|
these routes are used to manage api secrets.
|
|
|
|
| name | route |
|
|
| ---- | ------ |
|
|
| [create api secret](/api/api-secrets#create-api-secret) | `POST /api/secret/create` |
|
|
| [delete api secret](/api/api-secrets#delete-api-secret) | `DELETE /api/secret/delete/<secret-name>` |
|
|
|
|
```mdx-code-block
|
|
<Divider />
|
|
```
|
|
|
|
## create api secret
|
|
`POST /api/secret/create`
|
|
|
|
### request body
|
|
```json
|
|
{
|
|
name: string, // name the secret. must be unique among the users secrets
|
|
expires?: rfc3339_timestamp, // optional expiry time. if none, the secret will not expire.
|
|
}
|
|
```
|
|
|
|
### response body
|
|
```json
|
|
string // the body will be the secret hash used to log in.
|
|
```
|
|
|
|
```mdx-code-block
|
|
<Divider />
|
|
```
|
|
|
|
## delete api secret
|
|
`DELETE /api/secret/delete/<secret-name>`
|
|
|
|
### response
|
|
```json
|
|
HTTP 200 OK
|
|
``` |