Get Task Settings
Get task settings
Get the current task retention settings
Request
URI
GET
https://{api_host}/v1/tasks/config/settings
COPY
Responses
200
Current task settings
Returns
TaskSettings
of type(s)
application/json
{
"retentionDays": 365
}
integer As int32
As int32
retentionDays
Required
Constraints:
minimum: 1
maximum: 730
Number of days to retain task metadata before cleanup. Tasks older than this will be automatically cleaned up.
500
Unexpected error
Returns
Error
of type(s)
application/json
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
],
"referenceToken": "string"
}
string
errorCode
Read-Only
The minor error code
string
errorType
Read-Only
The error type
array of
string
arguments
Read-Only
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Read-Only
The error context (e.g. the component where it occurred).
string
message
Read-Only
The localized error message
string
remediationMessage
Optional
The localized remediation error message
array of
object
causes
Optional
The underlying cause exceptions.
array of
object
nestedErrors
Optional
The nested errors when the error is a composite one
string
referenceToken
Read-Only
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/v1/tasks/config/settings