EvoTrail API › Settings
Get the retention periods
GET/api/v1/evotrail/settings
EvoTrail's retention, the same for every organization.
Permission (API-key scope): evotrail:metrics:read.
Authorization
bearerAuth(evotrail:metrics:read)apiKeyHeader(evotrail:metrics:read)
Responses
200
The retention periods.
dataobject requiredretentionobjectaudit_retention_daysintegeractivity_retention_daysintegerip_retention_daysinteger
successboolean required
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
successboolean
403
The key lacks the EvoTrail scope, or may read none of the products asked for (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
successboolean
429
Too many requests (RATE_LIMITED). Wait Retry-After seconds.
Retry-AfterintegerSeconds to wait.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
successboolean
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
successboolean
Example request
curl -X GET 'https://evohub.io/api/v1/evotrail/settings' \
-H 'Authorization: Bearer <TOKEN>'