Admin Maintenance

Generated admin maintenance operations.

POST/v1/admin/maintenance/background-pausePause background work for an hour or resume itadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: post_admin_background_pause
Max body: 4 KiB

Request body application/json · required

Example

{
  "operationId": "id_8h2k4q",
  "paused": true
}

Schema

operationIdstringrequired
pausedbooleanrequired

Responses

200Successapplication/json

Example

{
  "cadences": [
    {
      "days": [
        "string"
      ],
      "description": "string",
      "id": "id_8h2k4q",
      "name": "Fargo"
    }
  ],
  "days": [
    "string"
  ],
  "digest": "string",
  "pausedUntilUnixMillis": 0,
  "retentionMaxima": {
    "key": 0
  },
  "revision": 0,
  "settings": {
    "backgroundSpeed": "string",
    "backupKeepCount": 0,
    "retention": {
      "key": 0
    },
    "windows": [
      {
        "cadence": "string",
        "days": [
          "string"
        ],
        "durationMinutes": 0,
        "enabled": true,
        "id": "id_8h2k4q",
        "name": "Fargo",
        "startMinute": 0,
        "tasks": [
          "string"
        ],
        "timezone": "2026-10-18T19:30:00Z"
      }
    ]
  },
  "storageCategories": [
    {
      "cleanable": true,
      "description": "string",
      "directories": [
        "string"
      ],
      "id": "id_8h2k4q",
      "name": "Fargo",
      "regenerable": true,
      "retentionKey": "string"
    }
  ],
  "tasks": [
    "string"
  ]
}

Schema

cadencesarray of objectrequired
- daysarray of stringrequired
- descriptionstringrequired
- idstringrequired
- namestringrequired
daysarray of stringrequired
digeststringrequired
pausedUntilUnixMillisintegerrequired
retentionMaximaobjectrequired
revisionintegerrequired
settingsobjectrequired
- backgroundSpeedstringrequired
- backupKeepCountintegerrequired
- retentionobjectrequired
- windowsarray of objectrequired
  - cadencestringrequired
  - daysarray of stringrequired
  - durationMinutesintegerrequired
  - enabledbooleanrequired
  - idstringrequired
  - namestringrequired
  - startMinuteintegerrequired
  - tasksarray of stringrequired
  - timezonestringrequired
storageCategoriesarray of objectrequired
- cleanablebooleanrequired
- descriptionstringrequired
- directoriesarray of stringrequired
- idstringrequired
- namestringrequired
- regenerablebooleanrequired
- retentionKeystringrequired
tasksarray of stringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedinvalid_requestrevision_mismatchadministration_unavailableinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/maintenance/background-pause" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"operationId":"id_8h2k4q","paused":true}'

GET/v1/admin/maintenance/settingsRead owner maintenance settings and choicesadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: get_admin_maintenance_settings

Responses

200Successapplication/json

Example

{
  "cadences": [
    {
      "days": [
        "string"
      ],
      "description": "string",
      "id": "id_8h2k4q",
      "name": "Fargo"
    }
  ],
  "days": [
    "string"
  ],
  "digest": "string",
  "pausedUntilUnixMillis": 0,
  "retentionMaxima": {
    "key": 0
  },
  "revision": 0,
  "settings": {
    "backgroundSpeed": "string",
    "backupKeepCount": 0,
    "retention": {
      "key": 0
    },
    "windows": [
      {
        "cadence": "string",
        "days": [
          "string"
        ],
        "durationMinutes": 0,
        "enabled": true,
        "id": "id_8h2k4q",
        "name": "Fargo",
        "startMinute": 0,
        "tasks": [
          "string"
        ],
        "timezone": "2026-10-18T19:30:00Z"
      }
    ]
  },
  "storageCategories": [
    {
      "cleanable": true,
      "description": "string",
      "directories": [
        "string"
      ],
      "id": "id_8h2k4q",
      "name": "Fargo",
      "regenerable": true,
      "retentionKey": "string"
    }
  ],
  "tasks": [
    "string"
  ]
}

Schema

cadencesarray of objectrequired
- daysarray of stringrequired
- descriptionstringrequired
- idstringrequired
- namestringrequired
daysarray of stringrequired
digeststringrequired
pausedUntilUnixMillisintegerrequired
retentionMaximaobjectrequired
revisionintegerrequired
settingsobjectrequired
- backgroundSpeedstringrequired
- backupKeepCountintegerrequired
- retentionobjectrequired
- windowsarray of objectrequired
  - cadencestringrequired
  - daysarray of stringrequired
  - durationMinutesintegerrequired
  - enabledbooleanrequired
  - idstringrequired
  - namestringrequired
  - startMinuteintegerrequired
  - tasksarray of stringrequired
  - timezonestringrequired
storageCategoriesarray of objectrequired
- cleanablebooleanrequired
- descriptionstringrequired
- directoriesarray of stringrequired
- idstringrequired
- namestringrequired
- regenerablebooleanrequired
- retentionKeystringrequired
tasksarray of stringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizedadministration_unavailableinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/maintenance/settings" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

PUT/v1/admin/maintenance/settingsSave owner maintenance settingsadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: put_admin_maintenance_settings
Max body: 64 KiB

Parameters

Name	In	Type	Description
`Idempotency-Key`	header	`string`
`Portico-Mutation-Root`	header	`string`

Request body application/json · required

Example

{
  "expectedRevision": 0,
  "operationId": "id_8h2k4q",
  "settings": {
    "backgroundSpeed": "string",
    "backupKeepCount": 0,
    "retention": {
      "key": 0
    },
    "windows": [
      {
        "cadence": "string",
        "days": [
          "string"
        ],
        "durationMinutes": 0,
        "enabled": true,
        "id": "id_8h2k4q",
        "name": "Fargo",
        "startMinute": 0,
        "tasks": [
          "string"
        ],
        "timezone": "2026-10-18T19:30:00Z"
      }
    ]
  }
}

Schema

expectedRevisionintegerrequired
operationIdstringrequired
settingsobjectrequired
- backgroundSpeedstringrequired
- backupKeepCountintegerrequired
- retentionobjectrequired
- windowsarray of objectrequired
  - cadencestringrequired
  - daysarray of stringrequired
  - durationMinutesintegerrequired
  - enabledbooleanrequired
  - idstringrequired
  - namestringrequired
  - startMinuteintegerrequired
  - tasksarray of stringrequired
  - timezonestringrequired

Responses

200Successapplication/json

Example

{
  "cadences": [
    {
      "days": [
        "string"
      ],
      "description": "string",
      "id": "id_8h2k4q",
      "name": "Fargo"
    }
  ],
  "days": [
    "string"
  ],
  "digest": "string",
  "pausedUntilUnixMillis": 0,
  "retentionMaxima": {
    "key": 0
  },
  "revision": 0,
  "settings": {
    "backgroundSpeed": "string",
    "backupKeepCount": 0,
    "retention": {
      "key": 0
    },
    "windows": [
      {
        "cadence": "string",
        "days": [
          "string"
        ],
        "durationMinutes": 0,
        "enabled": true,
        "id": "id_8h2k4q",
        "name": "Fargo",
        "startMinute": 0,
        "tasks": [
          "string"
        ],
        "timezone": "2026-10-18T19:30:00Z"
      }
    ]
  },
  "storageCategories": [
    {
      "cleanable": true,
      "description": "string",
      "directories": [
        "string"
      ],
      "id": "id_8h2k4q",
      "name": "Fargo",
      "regenerable": true,
      "retentionKey": "string"
    }
  ],
  "tasks": [
    "string"
  ]
}

Schema

cadencesarray of objectrequired
- daysarray of stringrequired
- descriptionstringrequired
- idstringrequired
- namestringrequired
daysarray of stringrequired
digeststringrequired
pausedUntilUnixMillisintegerrequired
retentionMaximaobjectrequired
revisionintegerrequired
settingsobjectrequired
- backgroundSpeedstringrequired
- backupKeepCountintegerrequired
- retentionobjectrequired
- windowsarray of objectrequired
  - cadencestringrequired
  - daysarray of stringrequired
  - durationMinutesintegerrequired
  - enabledbooleanrequired
  - idstringrequired
  - namestringrequired
  - startMinuteintegerrequired
  - tasksarray of stringrequired
  - timezonestringrequired
storageCategoriesarray of objectrequired
- cleanablebooleanrequired
- descriptionstringrequired
- directoriesarray of stringrequired
- idstringrequired
- namestringrequired
- regenerablebooleanrequired
- retentionKeystringrequired
tasksarray of stringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizedinvalid_requestrevision_mismatchnot_permittednot_foundrequest_in_progressadministration_unavailableinternalrevision_requiredidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity

Example request

curl -X PUT "http://127.0.0.1:32500/v1/admin/maintenance/settings" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "expectedRevision": 0,
  "operationId": "id_8h2k4q",
  "settings": {
    "backgroundSpeed": "string",
    "backupKeepCount": 0,
    "retention": {
      "key": 0
    },
    "windows": [
      {
        "cadence": "string",
        "days": [
          "string"
        ],
        "durationMinutes": 0,
        "enabled": true,
        "id": "id_8h2k4q",
        "name": "Fargo",
        "startMinute": 0,
        "tasks": [
          "string"
        ],
        "timezone": "2026-10-18T19:30:00Z"
      }
    ]
  }
}'