Nextcloud Developer Documentation

https://docs.nextcloud.com/server/latest/developer_manual/
Admin
Nextcloud developer documentation provides comprehensive guides and references for developing...
Tokens:40,475
Snippets:257
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Example JSON for FilesSharingCapabilities

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesSharingCapabilities

Example JSON object showing the structure and values of the FilesSharingCapabilities capabilities response.

```json
{
  "files_sharing": {
    "api_enabled": true,
    "public": {
      "enabled": true,
      "password": {},
      "multiple_links": true,
      "expire_date": {},
      "expire_date_internal": {},
      "expire_date_remote": {},
      "send_mail": true,
      "upload": true,
      "upload_files_drop": true,
      "custom_tokens": true
    },
    "user": {
      "send_mail": true,
      "expire_date": {}
    },
    "resharing": true,
    "group_sharing": true,
    "group": {
      "enabled": true,
      "expire_date": {}
    },
    "default_permissions": 0,
    "exclude_reshare_from_edit": true,
    "federation": {
      "outgoing": true,
      "incoming": true,
      "expire_date": {},
      "expire_date_supported": {}
    },
    "sharee": {
      "minSearchStringLength": 0,
      "query_lookup_default": true,
      "always_show_unique": true
    }
  }
}
```

--------------------------------

### FilesCapabilities JSON Example

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesCapabilities

Example JSON structure for the FilesCapabilities object, showing all required properties with sample values.

```json
{
  "files": {
    "windows_compatible_filenames": true,
    "$comment": "string",
    "bigfilechunking": true,
    "blacklisted_files": [
      {}
    ],
    "forbidden_filenames": [
      "string"
    ],
    "forbidden_filename_basenames": [
      "string"
    ],
    "forbidden_filename_characters": [
      "string"
    ],
    "forbidden_filename_extensions": [
      "string"
    ],
    "chunked_upload": {
      "max_size": 0,
      "max_parallel_count": 0
    },
    "file_conversions": [
      {}
    ],
    "directEditing": {
      "url": "string",
      "etag": "string",
      "supportsFileId": true
    }
  }
}
```

--------------------------------

### Response Example for GET /ocs/v2.php/taskprocessing/tasks/app/{appId}

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/operations/core-task_processing_api-list-tasks-by-app

Shows the JSON response body for a successful 200 response, containing the OCS meta and data objects with a list of tasks. The example includes all task fields such as id, status, userId, appId, input/output maps, and various timestamps.

```json
{
  "ocs": {
    "meta": {
      "status": "string",
      "statuscode": 0,
      "message": "string",
      "totalitems": "string",
      "itemsperpage": "string"
    },
    "data": {
      "tasks": [
        {
          "id": 0,
          "lastUpdated": 0,
          "type": "string",
          "status": "STATUS_CANCELLED",
          "userId": "string",
          "appId": "string",
          "input": {
            "property1": 0,
            "property2": 0
          },
          "output": {
            "property1": 0,
            "property2": 0
          },
          "customId": "string",
          "completionExpectedAt": 0,
          "progress": 0,
          "scheduledAt": 0,
          "startedAt": 0,
          "endedAt": 0,
          "allowCleanup": true,
          "includeWatermark": true,
          "userFacingErrorMessage": "string",
          "preferStreaming": true
        }
      ]
    }
  }
}
```

--------------------------------

### Example CorePublicCapabilities JSON

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/CorePublicCapabilities

Example JSON object showing the structure of CorePublicCapabilities with bruteforce delay and allow-listed fields.

```json
{
  "bruteforce": {
    "delay": 0,
    "allow-listed": true
  }
}
```

--------------------------------

### Example FilesVersionsCapabilities JSON

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesVersionsCapabilities

Example JSON object showing the structure of FilesVersionsCapabilities with all required properties set to true.

```json
{
  "files": {
    "versioning": true,
    "version_labeling": true,
    "version_deletion": true
  }
}
```

--------------------------------

### Example JSON for ProvisioningApiUserDetails

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/ProvisioningApiUserDetails

A complete JSON example of the ProvisioningApiUserDetails object, showing all properties with placeholder values. Use as a reference for the expected structure when working with the Provisioning API.

```json
{
  "additional_mail": [
    "string"
  ],
  "additional_mailScope": [
    "v2-private"
  ],
  "address": "string",
  "addressScope": "v2-private",
  "avatarScope": "v2-private",
  "backend": "string",
  "backendCapabilities": {
    "setDisplayName": true,
    "setPassword": true
  },
  "biography": "string",
  "biographyScope": "v2-private",
  "display-name": "string",
  "displayname": "string",
  "displaynameScope": "v2-private",
  "email": "string",
  "emailScope": "v2-private",
  "enabled": true,
  "fediverse": "string",
  "fediverseScope": "v2-private",
  "groups": [
    "string"
  ],
  "headline": "string",
  "headlineScope": "v2-private",
  "id": "string",
  "language": "string",
  "firstLoginTimestamp": 0,
  "lastLoginTimestamp": 0,
  "lastLogin": 0,
  "locale": "string",
  "manager": "string",
  "notify_email": "string",
  "organisation": "string",
  "organisationScope": "v2-private",
  "phone": "string",
  "phoneScope": "v2-private",
  "profile_enabled": "string",
  "profile_enabledScope": "v2-private",
  "pronouns": "string",
  "pronounsScope": "v2-private",
  "quota": {
    "free": 0,
    "quota": 0,
    "relative": 0,
    "total": 0,
    "used": 0
  },
  "role": "string",
  "roleScope": "v2-private",
  "storageLocation": "string",
  "subadmin": [
    "string"
  ],
  "timezone": "string",
  "twitter": "string",
  "twitterScope": "v2-private",
  "bluesky": "string",
  "blueskyScope": "v2-private",
  "website": "string",
  "websiteScope": "v2-private"
}
```

--------------------------------

### SharingCapabilities JSON example

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/SharingCapabilities

Example JSON response for the SharingCapabilities object. Shows the structure with api_versions, source_types, and permission_presets arrays.

```json
{
  "sharing": {
    "api_versions": [
      "v1"
    ],
    "source_types": [
      {}
    ],
    "permission_presets": [
      {}
    ]
  }
}
```

--------------------------------

### CommentsCapabilities JSON Example

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/CommentsCapabilities

Example JSON object showing the required 'files' object with the 'comments' boolean set to true.

```json
{
  "files": {
    "comments": true
  }
}
```

--------------------------------

### SharingUser JSON Example

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/SharingUser

Example JSON representation of the SharingUser object with all required properties: user_id, instance, display_name, and icon containing an SVG string.

```json
{
  "user_id": "string",
  "instance": "string",
  "display_name": "string",
  "icon": {
    "svg": "string"
  }
}
```

--------------------------------

### FilesTemplate JSON example

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesTemplate

Example JSON object for the FilesTemplate schema, showing all required fields including templateType, templateId, basename, etag, fileid, filename, lastmod, mime, size, type, hasPreview, previewUrl, and fields array.

```json
{
  "templateType": "string",
  "templateId": "string",
  "basename": "string",
  "etag": "string",
  "fileid": 0,
  "filename": "string",
  "lastmod": 0,
  "mime": "string",
  "size": 0,
  "type": "string",
  "hasPreview": true,
  "previewUrl": "string",
  "fields": [
    {
      "index": "string",
      "type": "string",
      "alias": "string",
      "tag": "string",
      "id": 0,
      "content": "string",
      "checked": true
    }
  ]
}
```

--------------------------------

### CoreResource JSON Example

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/CoreResource

Example JSON object for CoreResource with all required fields: richObjectType, richObject, openGraphObject, and accessible.

```json
{
  "richObjectType": "string",
  "richObject": {
    "property1": {},
    "property2": {}
  },
  "openGraphObject": {
    "id": "string",
    "name": "string",
    "description": "string",
    "thumb": "string",
    "link": "string"
  },
  "accessible": true
}
```

--------------------------------

### FilesTemplateFileCreatorWithTemplates JSON example

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesTemplateFileCreatorWithTemplates

Example JSON object representing a file creator with templates. It shows the structure with all required fields, including an array of template objects with properties like templateType, templateId, basename, etag, fileid, filename, lastmod, mime, size, type, hasPreview, previewUrl, and fields.

```json
{
  "app": "string",
  "label": "string",
  "extension": "string",
  "iconClass": "string",
  "iconSvgInline": "string",
  "mimetypes": [
    "string"
  ],
  "ratio": 0,
  "actionLabel": "string",
  "templates": [
    {
      "templateType": "string",
      "templateId": "string",
      "basename": "string",
      "etag": "string",
      "fileid": 0,
      "filename": "string",
      "lastmod": 0,
      "mime": "string",
      "size": 0,
      "type": "string",
      "hasPreview": true,
      "previewUrl": "string",
      "fields": [
        {}
      ]
    }
  ]
}
```

--------------------------------

### SharebymailCapabilities JSON Example

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/SharebymailCapabilities

Example JSON response for the SharebymailCapabilities object. It shows the structure with 'files_sharing' and 'sharebymail' keys, including 'enabled', 'send_password_by_mail', 'upload_files_drop', 'password', and 'expire_date' fields.

```json
{
  "files_sharing": {
    "sharebymail": {
      "enabled": true,
      "send_password_by_mail": true,
      "upload_files_drop": {},
      "password": {},
      "expire_date": {}
    }
  }
}
```

--------------------------------

### WorkflowengineCheck JSON example

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/WorkflowengineCheck

Example JSON object for WorkflowengineCheck with class, value, and operator fields. The operator field must be one of the allowed values: is, in, match, less, greater, matchesIPv4, matchesIPv6, and their negated forms.

```json
{
  "class": "string",
  "value": "string",
  "operator": "is"
}
```

--------------------------------

### SharingShare JSON Example

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/SharingShare

Example JSON object for the SharingShare schema, showing all fields with placeholder values. The 'state' field can be 'active', 'draft', or 'deleted'; 'user_status' can be 'pending', 'accepted', or 'rejected'. The 'properties' array contains objects with 'type' set to 'date' and optional 'min_date'/'max_date' in ISO 8601 format.

```json
{
  "id": "string",
  "owner": {
    "user_id": "string",
    "instance": "string",
    "display_name": "string",
    "icon": {
      "svg": "string"
    }
  },
  "last_updated": "string",
  "state": "active",
  "user_status": "pending",
  "sources": [
    {
      "class": "string",
      "value": "string",
      "display_name": "string",
      "icon": {}
    }
  ],
  "recipients": [
    {
      "class": "string",
      "value": "string",
      "instance": "string",
      "display_name": "string",
      "icon": {},
      "secret": {},
      "initiator": {},
      "permissions": [
        {}
      ]
    }
  ],
  "properties": [
    {
      "class": "string",
      "display_name": "string",
      "hint": "string",
      "priority": 1,
      "required": true,
      "advanced": true,
      "value": "string",
      "type": "date",
      "min_date": "string",
      "max_date": "string"
    }
  ],
  "permissions": [
    {
      "class": "string",
      "source_class": "string",
      "display_name": "string",
      "hint": "string",
      "priority": 1,
      "presets": [
        null
      ],
      "enabled": true
    }
  ],
  "permission_preset": "string"
}
```

--------------------------------

### Theming Icon API

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesSharingCapabilities

Get themed icons.

```APIDOC
## Theming Icon API

### Description
Returns themed icons for the instance.

### Endpoints
- `/theming/icon` - Get icon

### Methods
- GET

### Parameters
- `icon` (string) - Required - Icon name

### Response
- `image` (binary) - Icon image

```

--------------------------------

### SettingsDeclarativeFormField JSON example

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/SettingsDeclarativeFormField

Example JSON object for a SettingsDeclarativeFormField, showing all properties with sample values. The 'type' property must be one of the allowed values: text, password, email, tel, url, number, checkbox, multi-checkbox, radio, select, or multi-select.

```json
{
  "id": "string",
  "title": "string",
  "description": "string",
  "type": "text",
  "placeholder": "string",
  "label": "string",
  "default": {},
  "options": [
    "string"
  ],
  "value": "string",
  "sensitive": true
}
```

--------------------------------

### GET /ocs/v2.php/taskprocessing/tasks_consumer/tasktypes

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/operations/core-task_processing_api-task-types-ex-app-endpoint

Returns all available TaskProcessing task types. This endpoint is for ExApp usage without user context and requires admin access.

```APIDOC
## GET /ocs/v2.php/taskprocessing/tasks_consumer/tasktypes

### Description
Returns all available TaskProcessing task types. This endpoint is for ExApp usage without user context and requires admin access.

### Method
GET

### Endpoint
/ocs/v2.php/taskprocessing/tasks_consumer/tasktypes

### Security
- Bearer Auth (bearer_auth)
- Basic Auth (basic_auth)

### Parameters
#### Headers
- **OCS-APIRequest** (boolean) - Required - Required to be true for the API request to pass. Default: true

### Response
#### Success Response (200)
- **ocs** (object) - Required - OCS response wrapper
  - **meta** (object) - Required - Metadata about the response
    - **status** (string) - Status message
    - **statuscode** (integer) - HTTP status code
    - **message** (string) - Response message
    - **totalitems** (string) - Total number of items
    - **itemsperpage** (string) - Items per page
  - **data** (object) - Required - Response data
    - **types** (object) - Task types object
      - **property1** (object) - Task type definition
        - **name** (string) - Task type name
        - **description** (string) - Task type description
        - **inputShape** (object) - Input shape definition
          - **property1** (object) - Input property
            - **name** (string) - Property name
            - **description** (string) - Property description
            - **type** (string) - Property type (e.g., "Number")
        - **inputShapeEnumValues** (object) - Enum values for input shape
          - **property1** (array) - Enum value list
            - **name** (string) - Enum value name
            - **value** (string) - Enum value
        - **inputShapeDefaults** (object) - Default values for input shape
          - **property1** (number) - Default value
        - **optionalInputShape** (object) - Optional input shape definition
          - **property1** (object) - Optional input property
            - **name** (string) - Property name
            - **description** (string) - Property description
            - **type** (string) - Property type
        - **optionalInputShapeEnumValues** (object) - Enum values for optional input shape
          - **property1** (array) - Enum value list
            - **name** (string) - Enum value name
            - **value** (string) - Enum value
        - **optionalInputShapeDefaults** (object) - Default values for optional input shape
          - **property1** (number) - Default value
        - **outputShape** (object) - Output shape definition
          - **property1** (object) - Output property
            - **name** (string) - Property name
            - **description** (string) - Property description
            - **type** (string) - Property type
        - **outputShapeEnumValues** (object) - Enum values for output shape
          - **property1** (array) - Enum value list
            - **name** (string) - Enum value name
            - **value** (string) - Enum value
        - **optionalOutputShape** (object) - Optional output shape definition
          - **property1** (object) - Optional output property
            - **name** (string) - Property name
            - **description** (string) - Property description
            - **type** (string) - Property type
        - **optionalOutputShapeEnumValues** (object) - Enum values for optional output shape
          - **property1** (array) - Enum value list
            - **name** (string) - Enum value name
            - **value** (string) - Enum value

#### Response Example
```json
{
  "ocs": {
    "meta": {
      "status": "string",
      "statuscode": 0,
      "message": "string",
      "totalitems": "string",
      "itemsperpage": "string"
    },
    "data": {
      "types": {
        "property1": {
          "name": "string",
          "description": "string",
          "inputShape": {
            "property1": {
              "name": "string",
              "description": "string",
              "type": "Number"
            }
          },
          "inputShapeEnumValues": {
            "property1": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          },
          "inputShapeDefaults": {
            "property1": 0
          },
          "optionalInputShape": {
            "property1": {
              "name": "string",
              "description": "string",
              "type": "Number"
            }
          },
          "optionalInputShapeEnumValues": {
            "property1": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          },
          "optionalInputShapeDefaults": {
            "property1": 0
          },
          "outputShape": {
            "property1": {
              "name": "string",
              "description": "string",
              "type": "Number"
            }
          },
          "outputShapeEnumValues": {
            "property1": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          },
          "optionalOutputShape": {
            "property1": {
              "name": "string",
              "description": "string",
              "type": "Number"
            }
          },
          "optionalOutputShapeEnumValues": {
            "property1": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          }
        }
      }
    }
  }
}
```

### Error Responses
- **401** - Unauthorized
- **403** - Forbidden
```

--------------------------------

### GET /ocs/v2.php/taskprocessing/tasks_provider/next_batch

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/operations/core-task_processing_api-get-next-scheduled-task-batch

Retrieves the next batch of scheduled tasks for the given provider and task type IDs. The response is capped at approximately 50MiB and requires admin access.

```APIDOC
## GET /ocs/v2.php/taskprocessing/tasks_provider/next_batch

### Description
Returns the next n scheduled tasks for the specified set of taskTypes and providers. The returned tasks are capped at ~50MiB. This endpoint requires admin access.

### Method
GET

### Endpoint
/ocs/v2.php/taskprocessing/tasks_provider/next_batch

### Parameters
#### Query Parameters
- **providerIds[]** (array[string]) - Required - The ids of the providers
- **taskTypeIds[]** (array[string]) - Required - The ids of the task types
- **numberOfTasks** (integer<int64>) - Optional - The number of tasks to return. Default: 1. Range: >= -9007199254740991, <= 9007199254740991

#### Headers
- **OCS-APIRequest** (boolean) - Required - Required to be true for the API request to pass. Default: true

### Security
- Bearer Auth (bearer_auth)
- Basic Auth (basic_auth)

### Responses
#### Success Response (200)
- **ocs** (object) - Required - Contains meta and data
  - **meta** (object) - Required - Response metadata
    - **status** (string) - Status message
    - **statuscode** (integer) - HTTP status code
    - **message** (string) - Response message
    - **totalitems** (string) - Total items count
    - **itemsperpage** (string) - Items per page
  - **data** (object) - Required - Response data
    - **tasks** (array) - List of tasks
      - **task** (object) - Task details
        - **id** (integer) - Task ID
        - **lastUpdated** (integer) - Last updated timestamp
        - **type** (string) - Task type
        - **status** (string) - Task status (e.g., STATUS_CANCELLED)
        - **userId** (string) - User ID
        - **appId** (string) - App ID
        - **input** (object) - Input data
        - **output** (object) - Output data
        - **customId** (string) - Custom ID
        - **completionExpectedAt** (integer) - Expected completion timestamp
        - **progress** (integer) - Progress percentage
        - **scheduledAt** (integer) - Scheduled timestamp
        - **startedAt** (integer) - Started timestamp
        - **endedAt** (integer) - Ended timestamp
        - **allowCleanup** (boolean) - Whether cleanup is allowed
        - **includeWatermark** (boolean) - Whether watermark is included
        - **userFacingErrorMessage** (string) - User-facing error message
        - **preferStreaming** (boolean) - Whether streaming is preferred
      - **provider** (string) - Provider ID
    - **has_more** (boolean) - Whether more tasks are available

#### Response Example
```json
{
  "ocs": {
    "meta": {
      "status": "string",
      "statuscode": 0,
      "message": "string",
      "totalitems": "string",
      "itemsperpage": "string"
    },
    "data": {
      "tasks": [
        {
          "task": {
            "id": 0,
            "lastUpdated": 0,
            "type": "string",
            "status": "STATUS_CANCELLED",
            "userId": "string",
            "appId": "string",
            "input": {
              "property1": 0,
              "property2": 0
            },
            "output": {
              "property1": 0,
              "property2": 0
            },
            "customId": "string",
            "completionExpectedAt": 0,
            "progress": 0,
            "scheduledAt": 0,
            "startedAt": 0,
            "endedAt": 0,
            "allowCleanup": true,
            "includeWatermark": true,
            "userFacingErrorMessage": "string",
            "preferStreaming": true
          },
          "provider": "string"
        }
      ],
      "has_more": true
    }
  }
}
```

### Error Responses
- **401** - Unauthorized
- **403** - Forbidden
- **500** - Internal Server Error
```

--------------------------------

### GET /ocs/v2.php/taskprocessing/tasks_provider/{taskId}/file/{fileId}

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/operations/core-task_processing_api-get-file-contents-ex-app

Returns the contents of a file referenced in a task. This endpoint requires admin access and uses the ExApp route version.

```APIDOC
## GET /ocs/v2.php/taskprocessing/tasks_provider/{taskId}/file/{fileId}

### Description
Returns the contents of a file referenced in a task. This endpoint requires admin access.

### Method
GET

### Endpoint
/ocs/v2.php/taskprocessing/tasks_provider/{taskId}/file/{fileId}

### Parameters
#### Path Parameters
- **fileId** (integer<int64>) - Required - The file id of the file to retrieve. Value range: >= -9007199254740991 and <= 9007199254740991.
- **taskId** (integer<int64>) - Required - The id of the task. Value range: >= -9007199254740991 and <= 9007199254740991.

#### Headers
- **OCS-APIRequest** (boolean) - Required - Required to be true for the API request to pass. Default: true.

### Security
- Bearer Auth (bearer_auth)
- Basic Auth (basic_auth)

### Responses
#### Success Response (200)
File content returned.

#### Error Responses
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **500** - Internal Server Error

### Response Body
Content-Type: */*

Response body is the file content as a string.
```

--------------------------------

### Provisioning API Apps

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesSharingCapabilities

Manage apps via provisioning API.

```APIDOC
## Provisioning API Apps

### Description
Endpoints for enabling, disabling, and configuring apps.

### Endpoints
- `/provisioning_api/apps` - List apps
- `/provisioning_api/apps/{appId}` - Enable or disable app

### Methods
- GET, POST

### Parameters
- `appId` (string) - Required - App identifier
- `enabled` (boolean) - Required - Enable or disable

### Response
- `apps` (array) - List of apps

```

--------------------------------

### CoreLoginFlowV2 JSON Example

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/CoreLoginFlowV2

Example JSON representation of the CoreLoginFlowV2 object with required fields: poll (containing token and endpoint) and login.

```json
{
  "poll": {
    "token": "string",
    "endpoint": "string"
  },
  "login": "string"
}
```

--------------------------------

### Provisioning API Preferences

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesSharingCapabilities

Manage user preferences via provisioning API.

```APIDOC
## Provisioning API Preferences

### Description
Endpoints for getting and setting user preferences.

### Endpoints
- `/provisioning_api/preferences` - Get preferences
- `/provisioning_api/preferences` - Set preference

### Methods
- GET, POST

### Parameters
- `userId` (string) - Required - User ID
- `key` (string) - Required - Preference key
- `value` (string) - Required - Preference value

### Response
- `preferences` (object) - User preferences

```

--------------------------------

### CoreTaskProcessingTaskType JSON Example

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/CoreTaskProcessingTaskType

Example JSON object for CoreTaskProcessingTaskType, showing all properties including inputShape, outputShape, and their enum values and defaults.

```json
{
  "name": "string",
  "description": "string",
  "inputShape": {
    "property1": {
      "name": "string",
      "description": "string",
      "type": "Number"
    },
    "property2": {
      "name": "string",
      "description": "string",
      "type": "Number"
    }
  },
  "inputShapeEnumValues": {
    "property1": [
      {}
    ],
    "property2": [
      {}
    ]
  },
  "inputShapeDefaults": {
    "property1": 0,
    "property2": 0
  },
  "optionalInputShape": {
    "property1": {
      "name": "string",
      "description": "string",
      "type": "Number"
    },
    "property2": {
      "name": "string",
      "description": "string",
      "type": "Number"
    }
  },
  "optionalInputShapeEnumValues": {
    "property1": [
      {}
    ],
    "property2": [
      {}
    ]
  },
  "optionalInputShapeDefaults": {
    "property1": 0,
    "property2": 0
  },
  "outputShape": {
    "property1": {
      "name": "string",
      "description": "string",
      "type": "Number"
    },
    "property2": {
      "name": "string",
      "description": "string",
      "type": "Number"
    }
  },
  "outputShapeEnumValues": {
    "property1": [
      {}
    ],
    "property2": [
      {}
    ]
  },
  "optionalOutputShape": {
    "property1": {
      "name": "string",
      "description": "string",
      "type": "Number"
    },
    "property2": {
      "name": "string",
      "description": "string",
      "type": "Number"
    }
  },
  "optionalOutputShapeEnumValues": {
    "property1": [
      {}
    ],
    "property2": [
      {}
    ]
  }
}
```

--------------------------------

### Provisioning API App Config

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesSharingCapabilities

Manage app configuration via provisioning API.

```APIDOC
## Provisioning API App Config

### Description
Endpoints for getting and setting app configuration values.

### Endpoints
- `/provisioning_api/app_config` - Get app config
- `/provisioning_api/app_config` - Set app config

### Methods
- GET, POST

### Parameters
- `appId` (string) - Required - App identifier
- `key` (string) - Required - Configuration key
- `value` (string) - Required - Configuration value

### Response
- `config` (object) - App configuration

```

--------------------------------

### Core Preview API

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesSharingCapabilities

Generate previews for files.

```APIDOC
## Core Preview API

### Description
Returns a preview image for a file.

### Endpoints
- `/preview` - Get file preview

### Methods
- GET

### Parameters
- `file` (string) - Required - File path
- `x` (int) - Optional - Width
- `y` (int) - Optional - Height

### Response
- `image` (binary) - Preview image

```

--------------------------------

### SharingPropertyEnum JSON Example

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/SharingPropertyEnum

Example JSON object for SharingPropertyEnum, showing all required properties: class, display_name, hint, priority, required, advanced, value, type, and valid_values. The type is 'enum' and valid_values is an array of strings.

```json
{
  "class": "string",
  "display_name": "string",
  "hint": "string",
  "priority": 1,
  "required": true,
  "advanced": true,
  "value": "string",
  "type": "enum",
  "valid_values": [
    "string"
  ]
}
```

--------------------------------

### Theming API

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesSharingCapabilities

Endpoints for managing theme settings.

```APIDOC
## Theming API

### Description
Allows retrieving and updating the instance theme.

### Endpoints
- `/theming` - Get current theme
- `/theming` - Update theme settings

### Methods
- GET, PUT

### Parameters
- `name` (string) - Optional - Theme name
- `color` (string) - Optional - Primary color

### Response
- `theme` (object) - Theme configuration

```

--------------------------------

### core-task_processing_api-get-task

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/operations/core-task_processing_api-get-task

Gets a task including its status and result.

```APIDOC
## GET /ocs/v2.php/taskprocessing/task/{taskId}

### Description
Gets a task including its status and result.

### Method
GET

### Endpoint
/ocs/v2.php/taskprocessing/task/{taskId}

### Parameters
#### Path Parameters
- **taskId** (integer) - Required - The ID of the task.

### Response
#### Success Response (200)
- **ocs** (object) - The OCS response envelope.

#### Response Example
{
  "ocs": {
    "data": {
      "id": 1,
      "status": "string",
      "result": {}
    }
  }
}
```

--------------------------------

### theming/theming

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/operations/core-task_processing_api-delete-task

Endpoints for theming the Nextcloud interface.

```APIDOC
## theming/theming

### Description
Endpoints for theming the Nextcloud interface.
```

--------------------------------

### Weather Status API

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesSharingCapabilities

Get weather information.

```APIDOC
## Weather Status API

### Description
Provides weather status for a location.

### Endpoints
- `/weather_status` - Get weather

### Methods
- GET

### Parameters
- `lat` (float) - Required - Latitude
- `lon` (float) - Required - Longitude

### Response
- `weather` (object) - Weather data

```

--------------------------------

### Provisioning API Users

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesSharingCapabilities

Manage users via provisioning API.

```APIDOC
## Provisioning API Users

### Description
Endpoints for creating, updating, and deleting users.

### Endpoints
- `/provisioning_api/users` - List users
- `/provisioning_api/users` - Create user
- `/provisioning_api/users/{userId}` - Update or delete user

### Methods
- GET, POST, PUT, DELETE

### Parameters
- `userId` (string) - Required - User ID
- `password` (string) - Optional - User password
- `email` (string) - Optional - User email

### Response
- `users` (array) - List of users

```

--------------------------------

### Files Trashbin Preview API

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesSharingCapabilities

Preview files in trashbin.

```APIDOC
## Files Trashbin Preview API

### Description
Generates previews for files in the trashbin.

### Endpoints
- `/files_trashbin/preview` - Get trashbin preview

### Methods
- GET

### Parameters
- `fileId` (string) - Required - File ID

### Response
- `image` (binary) - Preview image

```

--------------------------------

### Federation Settings API

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesSharingCapabilities

Manage federation settings.

```APIDOC
## Federation Settings API

### Description
Endpoints for viewing and updating federation settings.

### Endpoints
- `/federation/settings` - Get settings
- `/federation/settings` - Update settings

### Methods
- GET, PUT

### Parameters
- `enabled` (boolean) - Optional - Enable federation
- `trustedServers` (array) - Optional - List of trusted servers

### Response
- `settings` (object) - Federation settings

```

--------------------------------

### POST /ocs/v2.php/taskprocessing/tasks_consumer/schedule

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/operations/core-task_processing_api-schedule-ex-app-endpoint

Schedules a task for ExApp usage without user context. Files cannot be referenced. Requires admin access and authentication via Bearer or Basic Auth.

```APIDOC
## POST /ocs/v2.php/taskprocessing/tasks_consumer/schedule

### Description
Schedules a task for ExApp usage without user context. Files cannot be referenced in this case. This endpoint requires admin access.

### Method
POST

### Endpoint
/ocs/v2.php/taskprocessing/tasks_consumer/schedule

### Authentication
- Bearer Auth (bearer_auth)
- Basic Auth (basic_auth)

### Headers
- **OCS-APIRequest** (boolean) - Required - Required to be true for the API request to pass. Default: true

### Request Body
- **input** (dictionary[string, object]) - Required - Task's input parameters
- **type** (string) - Required - Type of the task
- **appId** (string) - Required - ID of the app that will execute the task
- **customId** (string) - Optional - An arbitrary identifier for the task
- **webhookUri** (string or null) - Optional - URI to be requested when the task finishes. Default: null
- **webhookMethod** (string or null) - Optional - Method used for the webhook request (HTTP:GET, HTTP:POST, HTTP:PUT, HTTP:DELETE or AppAPI:APP_ID:GET, AppAPI:APP_ID:POST...). Default: null
- **includeWatermark** (boolean) - Optional - Whether to include a watermark in the output file or not. Default: true
- **preferStreaming** (boolean) - Optional - Whether to prefer getting a progressive output from the provider or not. Default: false

### Request Example
```json
{
  "input": {},
  "type": "string",
  "appId": "string",
  "customId": "string",
  "webhookUri": "string",
  "webhookMethod": "string",
  "includeWatermark": true,
  "preferStreaming": false
}
```

### Responses

#### Success Response (200)
- **ocs** (object) - Required - OCS response wrapper
  - **meta** (object) - Required - Metadata
  - **data** (object) - Required - Data containing the scheduled task
    - **task** (object) - The scheduled task details
      - **id** (integer) - Task ID
      - **lastUpdated** (integer) - Last updated timestamp
      - **type** (string) - Task type
      - **status** (string) - Task status (e.g., STATUS_CANCELLED)
      - **userId** (string) - User ID
      - **appId** (string) - App ID
      - **input** (object) - Input parameters
      - **output** (object) - Output parameters
      - **customId** (string) - Custom identifier
      - **completionExpectedAt** (integer) - Expected completion timestamp
      - **progress** (integer) - Progress percentage
      - **scheduledAt** (integer) - Scheduled timestamp
      - **startedAt** (integer) - Started timestamp
      - **endedAt** (integer) - Ended timestamp
      - **allowCleanup** (boolean) - Whether cleanup is allowed
      - **includeWatermark** (boolean) - Whether watermark is included
      - **userFacingErrorMessage** (string) - User-facing error message
      - **preferStreaming** (boolean) - Whether streaming is preferred

#### Response Example
```json
{
  "ocs": {
    "meta": {
      "status": "string",
      "statuscode": 0,
      "message": "string",
      "totalitems": "string",
      "itemsperpage": "string"
    },
    "data": {
      "task": {
        "id": 0,
        "lastUpdated": 0,
        "type": "string",
        "status": "STATUS_CANCELLED",
        "userId": "string",
        "appId": "string",
        "input": {
          "property1": 0,
          "property2": 0
        },
        "output": {
          "property1": 0,
          "property2": 0
        },
        "customId": "string",
        "completionExpectedAt": 0,
        "progress": 0,
        "scheduledAt": 0,
        "startedAt": 0,
        "endedAt": 0,
        "allowCleanup": true,
        "includeWatermark": true,
        "userFacingErrorMessage": "string",
        "preferStreaming": true
      }
    }
  }
}
```

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **403** - Forbidden
- **412** - Precondition Failed
- **500** - Internal Server Error
```

--------------------------------

### WorkflowengineRule JSON example

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/WorkflowengineRule

Example JSON representation of a WorkflowengineRule object, showing all required fields including id, class, name, checks, operation, entity, and events. The checks array contains an object with class, value, and operator, where operator is set to 'is'.

```json
{
  "id": 0,
  "class": "string",
  "name": "string",
  "checks": [
    {
      "class": "string",
      "value": "string",
      "operator": "is"
    }
  ],
  "operation": "string",
  "entity": "string",
  "events": [
    "string"
  ]
}
```

--------------------------------

### Provisioning API Groups

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesSharingCapabilities

Manage groups via provisioning API.

```APIDOC
## Provisioning API Groups

### Description
Endpoints for creating, updating, and deleting groups.

### Endpoints
- `/provisioning_api/groups` - List groups
- `/provisioning_api/groups` - Create group
- `/provisioning_api/groups/{groupId}` - Update or delete group

### Methods
- GET, POST, PUT, DELETE

### Parameters
- `groupName` (string) - Required - Group name
- `groupId` (string) - Required - Group ID

### Response
- `groups` (array) - List of groups

```

--------------------------------

### User Status User Status API

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesSharingCapabilities

Get own user status.

```APIDOC
## User Status User Status API

### Description
Returns the current user's status.

### Endpoints
- `/user_status/user_status` - Get own status

### Methods
- GET

### Response
- `status` (object) - User status

```

--------------------------------

### User Status Predefined Status API

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesSharingCapabilities

Get predefined statuses.

```APIDOC
## User Status Predefined Status API

### Description
Returns a list of predefined user statuses.

### Endpoints
- `/user_status/predefined_status` - Get predefined statuses

### Methods
- GET

### Response
- `statuses` (array) - List of predefined statuses

```

--------------------------------

### appstore/api

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/operations/core-task_processing_api-delete-task

Endpoints for the app store.

```APIDOC
## appstore/api

### Description
Endpoints for the app store.
```

--------------------------------

### Files Sharing Share Info API

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesSharingCapabilities

Get information about a share.

```APIDOC
## Files Sharing Share Info API

### Description
Returns details about a specific share.

### Endpoints
- `/files_sharing/share-info` - Get share info

### Methods
- GET

### Parameters
- `token` (string) - Required - Share token

### Response
- `share` (object) - Share details

```

--------------------------------

### core/reference

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/operations/core-task_processing_api-delete-task

Endpoints for reference handling.

```APIDOC
## core/reference

### Description
Endpoints for reference handling.
```

--------------------------------

### DAV Upcoming Events API

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/FilesSharingCapabilities

Get upcoming calendar events.

```APIDOC
## DAV Upcoming Events API

### Description
Returns upcoming events from calendars.

### Endpoints
- `/dav/upcoming-events` - Get upcoming events

### Methods
- GET

### Parameters
- `calendarId` (string) - Optional - Calendar ID
- `limit` (int) - Optional - Number of events

### Response
- `events` (array) - List of events

```

--------------------------------

### Schemas

Source: https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/schemas/SharingSource

A list of all available schemas in the Nextcloud Server OpenAPI documentation.

```APIDOC
## Schemas

- CoreAutocompleteResult
- CoreCapabilities
- CoreCollection
- CoreContactsAction
- CoreLoginFlowV2
- CoreLoginFlowV2Credentials
- CoreNavigationEntry
- CoreNavigationSettingsEntry
- OCSMeta
- CoreOpenGraphObject
- CoreProfileAction
- CoreProfileData
- CoreProfileFields
- CorePublicCapabilities
- CoreReference
- CoreReferenceProvider
- CoreResource
- CoreStatus
- CoreTaskProcessingIO
- CoreTaskProcessingShape
- CoreTaskProcessingTask
- CoreTaskProcessingTaskType
- CoreTeam

```
Tokens:
Raw