Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
contact: {}
description: 'API request bodies and responses are usually JSON-encoded, except for binary data and some of the OAuth2 endpoints. Note that the `Content-Type` header must be set to `application/json` for this, as the request may otherwise fail with error 400.
When clients have a valid access token, e.g. obtained through the `POST /api/v1/session` or `POST /api/v1/oauth/token` endpoint, they can use a standard Bearer Authorization header to authenticate their requests. Submitting the access token with a custom `X-Auth-Token` header is supported as well.'
title: PhotoPrism Logs API
version: v1
servers:
- url: https://demo.photoprism.app
security:
- BearerAuth: []
tags:
- name: Logs
paths:
/api/v1/errors:
delete:
operationId: DeleteErrors
responses:
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
summary: removes all entries from the error logs
tags:
- Logs
get:
operationId: GetErrors
parameters:
- description: maximum number of results
in: query
name: count
required: true
schema:
type: integer
maximum: 100000
minimum: 1
- description: search result offset
in: query
name: offset
schema:
type: integer
maximum: 100000
minimum: 0
- description: search query
in: query
name: q
schema:
type: string
responses:
'200':
description: OK
headers:
X-Count:
description: The actual number of errors returned
schema:
type: number
X-Limit:
description: The limit of the number of errors to be returned
schema:
type: number
X-Offset:
description: The offset that was used
schema:
type: number
content:
application/json:
schema:
$ref: '#/components/schemas/entity.Error'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/i18n.Response'
summary: searches the error logs and returns the results as JSON
tags:
- Logs
components:
schemas:
entity.Error:
properties:
ID:
type: integer
Level:
type: string
Message:
type: string
Time:
type: string
type: object
i18n.Response:
properties:
code:
type: integer
details:
type: string
error:
type: string
message:
type: string
messageId:
type: string
messageParams:
items: {}
type: array
type: object
securitySchemes:
BearerAuth:
in: header
name: Authorization
type: apiKey
externalDocs:
description: Learn more ›
url: https://docs.photoprism.app/developer-guide/api/