{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/cpm/developer/rest-api/reference/maintain/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Maintain

\n

api-version: 4.0

\n

Retrieves the list of pools.

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET  /_sysadmin/_admin/_api/rest/maintain/{pool}
\n
\n

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameInRequiredTypeDescription
poolpathfalsestringThe ID of the pool.
\n

Responses

\n

Success 200

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
countintegerThe number of returned values.
valuesPoolsThe list of pools.
\n

Error 4xx

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
messagestringThe error message.
outputOperationResultOutputThe result output.
typeOperationResultTypeThe result type.
dataOperationErrorThe list of errors.
\n

Examples

\n

Maintain all available pools

\n

Request

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET https://demo.symbioworld.com/_sysadmin/_admin/_api/rest/maintain/
\n
\n

Response (200 OK)

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 1,\n    \"values\": [\n        {\n            \"item1\": \"E5E85FED-BD69-49DF-ADC0-3CA4DAED5305\",\n            \"item2\": true\n        }\n    ]    \n}
\n
\n

Example Powershell

\n
\n
\n
Copy
\n
Copied
\n
\n 
$headers = @{}\n$headers.Add(\"accept\",\"application/json\")\n$headers.Add(\"symbio-auth-token\",\"mytoken\")\n$result = Invoke-RestMethod -Uri https://sampleinstance.symbioweb.com/_sysadmin/_admin/_api/rest/maintain/ -Headers $headers -UseBasicParsing\n$succeded = $result.values | Where-Object item2 -eq $true\n$failed = $result.values | Where-Object item2 -eq $false\nif (($failed | measure).Count -gt 0) {\n    $failedIds = [string]::Join(', ', ($failed | select -ExpandProperty item1))\n    $message = 'The following pools could not successful maintained: ' + $failedIds\n    Write-Error $message\n}\nif (($succeded | measure).Count -gt 0) {\n    $succededIds = [string]::Join(', ', ($succeded | select -ExpandProperty item1))\n    $message = 'The following pool was successful maintained: ' + $succededIds\n    Write-Verbose $message\n}
\n
\n

Definitions

\n

Pool

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
poolIdstringThe ID of the pool.
successboolTrue if it is succeded, otherwise it is false.
\n

OperationResultOutput

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameType
volatilestring
permanentstring
dialogstring
inlinestring
\n

OperationResultType

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameType
criticalstring
errorstring
warningstring
successstring
unauthorizedstring
\n

OperationError

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
errorstringThe error message.
","headings":[{"value":"Maintain","depth":1},{"value":"Parameters","depth":2},{"value":"Responses","depth":2},{"value":"Success 200","depth":3},{"value":"Error 4xx","depth":3},{"value":"Examples","depth":2},{"value":"Maintain all available pools","depth":3},{"value":"Request","depth":4},{"value":"Response (200 OK)","depth":4},{"value":"Example Powershell","depth":3},{"value":"Definitions","depth":2},{"value":"Pool","depth":3},{"value":"OperationResultOutput","depth":3},{"value":"OperationResultType","depth":3},{"value":"OperationError","depth":3}]},"contentItem":{"data":{"lastModified":"2025-09-10T14:16:09.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"093b2ff9-af58-5003-9193-e6be7ee9d75c__redocly content/cpm/developer/rest-api/reference/maintain/","seo":{"title":"Maintain","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"cpm/developer/rest-api/reference/maintain.md","pageBaseUrl":"/cpm/developer/rest-api/reference/maintain","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Maintain","id":"maintain"},{"depth":2,"value":"Parameters","id":"parameters"},{"depth":2,"value":"Responses","id":"responses"},{"depth":3,"value":"Success 200","id":"success-200"},{"depth":3,"value":"Error 4xx","id":"error-4xx"},{"depth":2,"value":"Examples","id":"examples"},{"depth":3,"value":"Maintain all available pools","id":"maintain-all-available-pools"},{"depth":4,"value":"Request","id":"request"},{"depth":4,"value":"Response (200 OK)","id":"response-200-ok"},{"depth":3,"value":"Example Powershell","id":"example-powershell"},{"depth":2,"value":"Definitions","id":"definitions"},{"depth":3,"value":"Pool","id":"pool"},{"depth":3,"value":"OperationResultOutput","id":"operationresultoutput"},{"depth":3,"value":"OperationResultType","id":"operationresulttype"},{"depth":3,"value":"OperationError","id":"operationerror"}]},"data":{"title":""},"catalogInfo":null,"link":"/cpm/developer/rest-api/reference/maintain/","sidebarName":"celonis","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}