62 lines
2.2 KiB
YAML
62 lines
2.2 KiB
YAML
/auth/api-keys:
|
|
post:
|
|
operationId: createApiKey
|
|
summary: Create a new API key
|
|
description: |
|
|
Creates a new API key, returning it in the response.
|
|
|
|
> **Note:** Only one API key can be created in the system.
|
|
> If an API key already exists, it will be replaced with the new one.
|
|
tags:
|
|
- Internal API - API Keys
|
|
security:
|
|
- accessTokenHeader: []
|
|
responses:
|
|
'201':
|
|
$ref: '../../components/responses/internal/success-create-api-key.yaml'
|
|
'401':
|
|
$ref: '../../components/responses/unauthorized-error.yaml'
|
|
'403':
|
|
$ref: '../../components/responses/forbidden-error.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/internal-server-error.yaml'
|
|
get:
|
|
operationId: getApiKeys
|
|
summary: Get API keys
|
|
description: |
|
|
Retrieves the existing API keys.
|
|
|
|
> **Note:** Only one API key can exist in the system.
|
|
> If no API key exists, an empty array will be returned.
|
|
tags:
|
|
- Internal API - API Keys
|
|
security:
|
|
- accessTokenHeader: []
|
|
responses:
|
|
'200':
|
|
$ref: '../../components/responses/internal/success-get-api-keys.yaml'
|
|
'401':
|
|
$ref: '../../components/responses/unauthorized-error.yaml'
|
|
'403':
|
|
$ref: '../../components/responses/forbidden-error.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/internal-server-error.yaml'
|
|
delete:
|
|
operationId: deleteApiKeys
|
|
summary: Delete API keys
|
|
description: >
|
|
Deletes the existing API keys.
|
|
tags:
|
|
- Internal API - API Keys
|
|
security:
|
|
- accessTokenHeader: []
|
|
responses:
|
|
'200':
|
|
$ref: '../../components/responses/internal/success-delete-api-key.yaml'
|
|
'401':
|
|
$ref: '../../components/responses/unauthorized-error.yaml'
|
|
'403':
|
|
$ref: '../../components/responses/forbidden-error.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/internal-server-error.yaml'
|