Connectors
File Storage & Transfer
Nextcloud
Self-hosted file sharing: files, shares, users, groups, and notifications
- Signs in with
- Username and password
- Runs on
- Cloud or On-Prem Worker
- Operations
- 318
- Ready-made triggers
- 0
Connect Nextcloud
- In Neblex open Connect › Connections and click New Connection.
- Search for Nextcloud and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| ServerRequired | Nextcloud host without the scheme, for example cloud.example.com; add a path when Nextcloud is served below one. |
| Login nameRequired | The account's login name. |
| App passwordRequiredSecret | An app password from Personal settings, Security. Works with two-factor authentication. |
Use it in a flow
- Open a flow, open the node library and search for Nextcloud.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
To start a flow from Nextcloud without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if Nextcloud can send webhooks, a Webhook trigger receives them at its own URL.
Operations
318 operations in 28 groups. Each one is a step you can add to a flow.
App store7
Disable an appappstoreApiDisableApp | POST | Disable an app This endpoint requires admin access This endpoint requires password confirmation |
Enable all apps of a bundleappstoreApiEnableBundle | POST | Enable all apps of a bundle This endpoint requires admin access This endpoint requires password confirmation |
Enable one appsappstoreApiEnableApp | POST | Enable one apps App will be enabled for specific groups only if $groups is defined This endpoint requires admin access This endpoint requires password confirmation |
Get all available appsappstoreApiListApps | GET | Get all available apps This endpoint requires admin access |
Get all available categoriesappstoreApiListCategories | GET | Get all available categories This endpoint requires admin access |
Uninstall an appappstoreApiUninstallApp | POST | Uninstall an app. |
Update an appappstoreApiUpdateApp | POST | Update an app This endpoint requires admin access This endpoint requires password confirmation |
Cloud federation3
Add sharecloudFederationApiRequestHandlerAddShare | POST | Add share |
Inform the sender that an invitation was accepted to start sharingcloudFederationApiRequestHandlerInviteAccepted | POST | Inform the sender that an invitation was accepted to start sharing Inform about an accepted invitation so the user on the sender provider's side can initiate the OCM share creation. |
Send a notification about an existing sharecloudFederationApiRequestHandlerReceiveNotification | POST | Send a notification about an existing share |
Comments5
Add a commentdavCreateComment | POST | POST a comment on a file. |
Delete a commentdavDeleteComment | DELETE | DELETE one comment. |
List commentsdavListComments | REPORT | REPORT the comments on a file with oc:limit and oc:offset. |
Mark comments readdavMarkCommentsRead | PROPPATCH | PROPPATCH oc:readMarker on a file's comments. |
Update a commentdavUpdateComment | PROPPATCH | PROPPATCH oc:message on one comment. |
Core83
Add a resource to a collectioncoreCollaborationResourcesAddResource | POST | Add a resource to a collection |
Autocomplete a querycoreAutoCompleteGet | GET | Autocomplete a query |
Cancels a taskcoreTaskProcessingApiCancelTask | POST | Cancels a task |
Cancels a taskcoreTaskProcessingApiCancelTaskExAppEndpoint | POST | Cancels a task Endpoint for ExApp usage without user context This endpoint requires admin access |
Check if the device should be wipedcoreWipeCheckWipe | POST | Check if the device should be wiped |
Check whether this feature is availablecoreTextToImageApiIsAvailable | GET | Check whether this feature is available |
Confirm the user passwordcoreAppPasswordConfirmUserPassword | PUT | Confirm the user password |
Confirm the user passwordcoreLoginConfirmPassword | POST | Confirm the user password |
Core get statuscoreGetStatus | GET | Nextcloud GET /status.php. |
Core OCM discoverycoreOcmDiscovery | GET | generate a OCMProvider with local data and send it as DataResponse. |
Core task processing API get next scheduled task batchcoreTaskProcessingApiGetNextScheduledTaskBatch | GET | 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 |
Core text processing API get taskcoreTextProcessingApiGetTask | GET | This endpoint allows checking the status and results of a task. |
Core text processing API list tasks by appcoreTextProcessingApiListTasksByApp | GET | This endpoint returns a list of tasks of a user that are related with a specific appId and optionally with an identifier |
Core text to image API get taskcoreTextToImageApiGetTask | GET | This endpoint allows checking the status and results of a task. |
Core text to image API list tasks by appcoreTextToImageApiListTasksByApp | GET | This endpoint returns a list of tasks of a user that are related with a specific appId and optionally with an identifier |
Create a collection for a resourcecoreCollaborationResourcesCreateCollectionOnResource | POST | Create a collection for a resource |
Create app passwordcoreAppPasswordGetAppPassword | GET | Create app password This endpoint requires password confirmation |
Delete app passwordcoreAppPasswordDeleteAppPassword | DELETE | Delete app password |
Deletes a taskcoreTaskProcessingApiDeleteTask | DELETE | Deletes a task |
Deletes a taskcoreTaskProcessingApiDeleteTaskExAppEndpoint | DELETE | Deletes a task Endpoint for ExApp usage without user context This endpoint requires admin access |
Disable two factor authentication providers for specific usercoreTwoFactorApiDisable | POST | Disable two factor authentication providers for specific user This endpoint requires admin access This endpoint requires password confirmation |
Enable two factor authentication providers for specific usercoreTwoFactorApiEnable | POST | Enable two factor authentication providers for specific user This endpoint requires admin access This endpoint requires password confirmation |
Extract references from a textcoreReferenceApiExtract | POST | Extract references from a text |
Extract references from a textcoreReferenceApiExtractPublic | POST | Extract references from a text |
Finish the wipecoreWipeWipeDone | POST | Finish the wipe |
Get a collectioncoreCollaborationResourcesListCollection | GET | Get a collection |
Get a preview by file IDcorePreviewGetPreviewByFileId | GET | Get a preview by file ID |
Get a preview by file pathcorePreviewGetPreview | GET | Get a preview by file path |
Get a preview by mimecorePreviewGetMimeIconUrl | GET | Get a preview by mime |
Get a preview for a referencecoreReferencePreview | GET | Get a preview for a reference |
Get all resources of a teamcoreTeamsApiResolveOne | GET | Get all resources of a team |
Get all teams of a resourcecoreTeamsApiListTeams | GET | Get all teams of a resource |
Get app password with one-time passwordcoreAppPasswordGetAppPasswordWithOneTimePassword | GET | Get app password with one-time password |
Get collections by resourcecoreCollaborationResourcesGetCollectionsByResource | GET | Get collections by resource |
Get profile fields for another usercoreProfileApiGetProfileFields | GET | Get profile fields for another user |
Get the account details for a hovercardcoreHoverCardGetUser | GET | Get the account details for a hovercard |
Get the apps navigationcoreNavigationGetAppsNavigation | GET | Get the apps navigation |
Get the avatarcoreAvatarGetAvatar | GET | Get the avatar |
Get the capabilitiescoreOcsGetCapabilities | GET | Get the capabilities |
Get the dark avatarcoreAvatarGetAvatarDark | GET | Get the dark avatar |
Get the list of supported languagescoreTranslationApiLanguages | GET | Get the list of supported languages |
Get the providerscoreReferenceApiGetProvidersInfo | GET | Get the providers |
Get the providers for unified searchcoreUnifiedSearchGetProviders | GET | Get the providers for unified search |
Get the settings navigationcoreNavigationGetSettingsNavigation | GET | Get the settings navigation |
Get two factor authentication provider statescoreTwoFactorApiState | GET | Get two factor authentication provider states This endpoint requires admin access |
Gets a task including status and resultcoreTaskProcessingApiGetTask | GET | Gets a task including status and result Tasks are removed 1 week after receiving their last update |
Gets a task including status and resultcoreTaskProcessingApiGetTaskExAppEndpoint | GET | Gets a task including status and result Endpoint for ExApp usage without user context Tasks are removed 1 week after receiving their last update This endpoint requires admin access |
Init a login flowcoreClientFlowLoginV2Init | POST | Init a login flow |
Launch a search for a specific search providercoreUnifiedSearchSearch | GET | Launch a search for a specific search provider. |
Poll the login flow credentialscoreClientFlowLoginV2Poll | POST | Poll the login flow credentials |
Remove a resource from a collectioncoreCollaborationResourcesRemoveResource | DELETE | Remove a resource from a collection |
Rename a collectioncoreCollaborationResourcesRenameCollection | PUT | Rename a collection |
Resolve a referencecoreReferenceApiResolveOne | GET | Resolve a reference |
Resolve from a public pagecoreReferenceApiResolveOnePublic | GET | Resolve from a public page |
Resolve multiple referencescoreReferenceApiResolve | POST | Resolve multiple references |
Resolve multiple references from a public pagecoreReferenceApiResolvePublic | POST | Resolve multiple references from a public page |
Returns a dark guest avatar image responsecoreGuestAvatarGetAvatarDark | GET | Returns a dark guest avatar image response |
Returns a guest avatar image responsecoreGuestAvatarGetAvatar | GET | Returns a guest avatar image response |
Returns a new CSRF tokencoreCsrfTokenIndex | GET | Returns a new CSRF token. |
Returns all available TaskProcessing task typescoreTaskProcessingApiTaskTypes | GET | Returns all available TaskProcessing task types |
Returns all available TaskProcessing task typescoreTaskProcessingApiTaskTypesExAppEndpoint | GET | Returns all available TaskProcessing task types Endpoint for ExApp usage without user context This endpoint requires admin access |
Returns queue statistics for task processingcoreTaskProcessingApiQueueStats | GET | Returns queue statistics for task processing Returns the count of scheduled and running tasks, optionally filtered by task type(s). |
Returns tasks for the current user filtered by the appId and optional customIdcoreTaskProcessingApiListTasksByApp | GET | Returns tasks for the current user filtered by the appId and optional customId |
Returns tasks for the current user filtered by the optional taskType and optional customIdcoreTaskProcessingApiListTasks | GET | Returns tasks for the current user filtered by the optional taskType and optional customId |
Returns the contents of a file referenced in a taskcoreTaskProcessingApiGetFileContents | GET | Returns the contents of a file referenced in a task |
Returns the contents of a file referenced in a task(ExApp route version)coreTaskProcessingApiGetFileContentsExApp | GET | Returns the contents of a file referenced in a task(ExApp route version) This endpoint requires admin access |
Returns the next scheduled task for the taskTypeIdcoreTaskProcessingApiGetNextScheduledTask | GET | Returns the next scheduled task for the taskTypeId This endpoint requires admin access |
Rotate app passwordcoreAppPasswordRotateAppPassword | POST | Rotate app password |
Schedules a taskcoreTaskProcessingApiSchedule | POST | Schedules a task |
Schedules a taskcoreTaskProcessingApiScheduleExAppEndpoint | POST | Schedules a task Endpoint for ExApp usage without user context. |
Search for collectionscoreCollaborationResourcesSearchCollections | GET | Search for collections |
Sets the task progresscoreTaskProcessingApiSetProgress | POST | Sets the task progress This endpoint requires admin access |
Sets the task resultcoreTaskProcessingApiSetResult | POST | Sets the task result This endpoint requires admin access |
This endpoint allows downloading the resulting image of a taskcoreTextToImageApiGetImage | GET | This endpoint allows downloading the resulting image of a task |
This endpoint allows scheduling a language model taskcoreTextProcessingApiSchedule | POST | This endpoint allows scheduling a language model task |
This endpoint allows scheduling a text to image taskcoreTextToImageApiSchedule | POST | This endpoint allows scheduling a text to image task |
This endpoint allows to delete a scheduled task for a usercoreTextProcessingApiDeleteTask | DELETE | This endpoint allows to delete a scheduled task for a user |
This endpoint allows to delete a scheduled task for a usercoreTextToImageApiDeleteTask | DELETE | This endpoint allows to delete a scheduled task for a user |
This endpoint returns all available LanguageModel task typescoreTextProcessingApiTaskTypes | GET | This endpoint returns all available LanguageModel task types |
Touch a providercoreReferenceApiTouchProvider | PUT | Touch a provider |
Translate a textcoreTranslationApiTranslate | POST | Translate a text |
Update the visibility of a parametercoreProfileApiSetVisibility | PUT | Update the visibility of a parameter This endpoint requires password confirmation |
Upload a file so it can be referenced in a task result (ExApp route version)coreTaskProcessingApiSetFileContentsExApp | POST | Upload a file so it can be referenced in a task result (ExApp route version) Use field 'file' for the file upload This endpoint requires admin access |
Dashboard7
Get the items for the widgetsdashboardDashboardApiGetWidgetItems | GET | Get the items for the widgets |
Get the items for the widgetsdashboardDashboardApiGetWidgetItemsV2 | GET | Get the items for the widgets |
Get the layoutdashboardDashboardApiGetLayout | GET | Get the layout |
Get the statusesdashboardDashboardApiGetStatuses | GET | Get the statuses |
Get the widgetsdashboardDashboardApiGetWidgets | GET | Get the widgets |
Update the layoutdashboardDashboardApiUpdateLayout | POST | Update the layout |
Update the statusesdashboardDashboardApiUpdateStatuses | POST | Update the statuses |
DAV9
Accept a pending federated calendar invitationdavFederatedCalendarAccept | POST | Accept a pending federated calendar invitation |
Clear the out-of-officedavOutOfOfficeClearOutOfOffice | DELETE | Clear the out-of-office |
Decline a pending federated calendar invitationdavFederatedCalendarDecline | DELETE | Decline a pending federated calendar invitation |
Get a direct link to a filedavDirectGetUrl | POST | Get a direct link to a file |
Get information about upcoming eventsdavUpcomingEventsGetEvents | GET | Get information about upcoming events |
Get the configured out-of-office data of a userdavOutOfOfficeGetOutOfOffice | GET | Get the configured out-of-office data of a user. |
Get the currently configured out-of-office data of a userdavOutOfOfficeGetCurrentOutOfOfficeData | GET | Get the currently configured out-of-office data of a user |
Get the pending federated calendar invitations of the current userdavFederatedCalendarGetPending | GET | Get the pending federated calendar invitations of the current user |
Set out-of-office absencedavOutOfOfficeSetOutOfOffice | POST | Set out-of-office absence |
Federated file sharing9
accept server-to-server sharefederatedfilesharingRequestHandlerAcceptShare | POST | accept server-to-server share |
change the owner of a server-to-server sharefederatedfilesharingRequestHandlerMove | POST | change the owner of a server-to-server share |
create a new sharefederatedfilesharingRequestHandlerCreateShare | POST | create a new share |
create re-share on behalf of another userfederatedfilesharingRequestHandlerReShare | POST | create re-share on behalf of another user |
decline server-to-server sharefederatedfilesharingRequestHandlerDeclineShare | POST | decline server-to-server share |
federated share was revoked, either by the owner or the re-sharerfederatedfilesharingRequestHandlerRevoke | POST | federated share was revoked, either by the owner or the re-sharer |
remove server-to-server share if it was unshared by the ownerfederatedfilesharingRequestHandlerUnshare | POST | remove server-to-server share if it was unshared by the owner |
send federated share to a user of a public linkfederatedfilesharingMountPublicLinkCreateFederatedShare | POST | send federated share to a user of a public link |
Update share information to keep federated re-shares in syncfederatedfilesharingRequestHandlerUpdatePermissions | POST | Update share information to keep federated re-shares in sync. |
Federation7
Add server to the list of trusted Nextcloud serversfederationSettingsAddServer | POST | Add server to the list of trusted Nextcloud servers This endpoint requires admin access |
Add server to the list of trusted Nextcloud serversfederationSettingsRemoveServer | DELETE | Add server to the list of trusted Nextcloud servers This endpoint requires admin access |
Create shared secret and return itfederationOcsAuthapiGetSharedSecret | GET | Create shared secret and return it |
Create shared secret and return it, for legacy end-pointsfederationOcsAuthapiGetSharedSecretLegacy | GET | Create shared secret and return it, for legacy end-points |
List all trusted serversfederationSettingsGetServers | GET | List all trusted servers This endpoint requires admin access |
Request received to ask remote server for a shared secretfederationOcsAuthapiRequestSharedSecret | POST | Request received to ask remote server for a shared secret |
Request received to ask remote server for a shared secret, for legacy end-pointsfederationOcsAuthapiRequestSharedSecretLegacy | POST | Request received to ask remote server for a shared secret, for legacy end-points |
Files16
Accept an ownership transferfilesTransferOwnershipAccept | POST | Accept an ownership transfer |
Converts a file from one MIME type to anotherfilesConversionApiConvert | POST | Converts a file from one MIME type to another |
Create a file for direct editingfilesDirectEditingCreate | POST | Create a file for direct editing |
Create a local editorfilesOpenLocalEditorCreate | POST | Create a local editor |
Create a templatefilesTemplateCreate | POST | Create a template |
Get the direct editing capabilitiesfilesDirectEditingInfo | GET | Get the direct editing capabilities |
Get the templates for direct editingfilesDirectEditingTemplates | GET | Get the templates for direct editing |
Gets a thumbnail of the specified filefilesApiGetThumbnail | GET | Gets a thumbnail of the specified file |
Initialize the template directoryfilesTemplatePath | POST | Initialize the template directory |
List the available templatesfilesTemplateList | GET | List the available templates |
List the fields for the template specified by the given file IDfilesTemplateListTemplateFields | GET | List the fields for the template specified by the given file ID |
Open a file for direct editingfilesDirectEditingOpen | POST | Open a file for direct editing |
Reject an ownership transferfilesTransferOwnershipReject | DELETE | Reject an ownership transfer |
Returns the folder tree of the userfilesApiGetFolderTree | GET | Returns the folder tree of the user |
Transfer the ownership to another userfilesTransferOwnershipTransfer | POST | Transfer the ownership to another user |
Validate a local editorfilesOpenLocalEditorValidate | POST | Validate a local editor |
Files external1
Get the mount points visible for this userfilesExternalApiGetUserMounts | GET | Get the mount points visible for this user |
Files reminders3
Get a reminderfilesRemindersApiGet | GET | Get a reminder |
Remove a reminderfilesRemindersApiRemove | DELETE | Remove a reminder |
Set a reminderfilesRemindersApiSet | PUT | Set a reminder |
Files sharing23
Accept a remote sharefilesSharingRemoteAcceptShare | POST | Accept a remote share. |
Accept a sharefilesSharingShareapiAcceptShare | POST | Accept a share |
Create a sharefilesSharingShareapiCreateShare | POST | Create a share |
Decline a remote sharefilesSharingRemoteDeclineShare | DELETE | Decline a remote share. |
Delete a sharefilesSharingShareapiDeleteShare | DELETE | Delete a share |
Files sharing shareapi send share emailfilesSharingShareapiSendShareEmail | POST | Send a mail notification again for a share. |
Find recommended shareesfilesSharingShareesapiFindRecommended | GET | Find recommended sharees |
Get a direct link preview for a shared filefilesSharingPublicPreviewDirectLink | GET | Get a direct link preview for a shared file |
Get a list of accepted remote sharesfilesSharingRemoteGetShares | GET | Get a list of accepted remote shares |
Get a list of all deleted sharesfilesSharingDeletedShareapiIndex | GET | Get a list of all deleted shares |
Get a preview for a shared filefilesSharingPublicPreviewGetPreview | GET | Get a preview for a shared file |
Get a specific share by idfilesSharingShareapiGetShare | GET | Get a specific share by id |
Get a unique share tokenfilesSharingShareapiGenerateToken | GET | Get a unique share token |
Get all shares relative to a file, including parent folders shares rightsfilesSharingShareapiGetInheritedShares | GET | Get all shares relative to a file, including parent folders shares rights |
Get all shares that are still pendingfilesSharingShareapiPendingShares | GET | Get all shares that are still pending |
Get info of a remote sharefilesSharingRemoteGetShare | GET | Get info of a remote share |
Get list of pending remote sharesfilesSharingRemoteGetOpenShares | GET | Get list of pending remote shares |
Get shares of the current userfilesSharingShareapiGetShares | GET | Get shares of the current user |
Get the info about a sharefilesSharingShareInfoInfo | POST | Get the info about a share |
Search for shareesfilesSharingShareesapiSearch | GET | Search for sharees |
Undelete a deleted sharefilesSharingDeletedShareapiUndelete | POST | Undelete a deleted share |
Unshare a remote sharefilesSharingRemoteUnshare | DELETE | Unshare a remote share |
Update a sharefilesSharingShareapiUpdateShare | PUT | Update a share |
Files trashbin1
Get the preview for a filefilesTrashbinPreviewGetPreview | GET | Get the preview for a file |
Files versions1
Get the preview for a file versionfilesVersionsPreviewGetPreview | GET | Get the preview for a file version |
Notifications16
Activate subscription for push notificationsnotificationsWebPushActivatewp | POST | Activate subscription for push notifications |
Check if notification IDs existnotificationsEndpointConfirmIdsForUser | POST | Check if notification IDs exist |
Delete a notificationnotificationsEndpointDeleteNotification | DELETE | Delete a notification |
Delete all notificationsnotificationsEndpointDeleteAllNotifications | DELETE | Delete all notifications |
Generate a notification for a user (deprecated, use v3 instead)notificationsApiGenerateNotification | POST | Generate a notification for a user (deprecated, use v3 instead) This endpoint requires admin access |
Generate a notification with rich object parameters for a usernotificationsApiGenerateNotificationV3 | POST | Generate a notification with rich object parameters for a user This endpoint requires admin access |
Get a notificationnotificationsEndpointGetNotification | GET | Get a notification |
Get all notificationsnotificationsEndpointListNotifications | GET | Get all notifications |
Register a subscription for push notificationsnotificationsWebPushRegisterwp | POST | Register a subscription for push notifications |
Register device for push notificationsnotificationsPushRegisterDevice | POST | Register device for push notifications |
Remove a device from push notificationsnotificationsPushRemoveDevice | DELETE | Remove a device from push notifications |
Remove a subscription from push notificationsnotificationsWebPushRemovewp | DELETE | Remove a subscription from push notifications |
Return the server VAPID public keynotificationsWebPushGetVapid | GET | Return the server VAPID public key |
Send a test notification to push registered mobile appsnotificationsApiSelfTestPush | POST | Send a test notification to push registered mobile apps Required capability: ocs-endpoints test-push |
Update default notification settings for new usersnotificationsSettingsAdmin | POST | Update default notification settings for new users This endpoint requires admin access |
Update personal notification settingsnotificationsSettingsPersonal | POST | Update personal notification settings |
OAuth 22
Authorize the useroauth2LoginRedirectorAuthorize | GET | Authorize the user |
Get a tokenoauth2OauthApiGetToken | POST | Get a token |
Provisioning API49
Add a user to a groupprovisioningApiUsersAddToGroup | POST | Add a user to a group This endpoint requires password confirmation |
Create a new groupprovisioningApiGroupsAddGroup | POST | Create a new group This endpoint requires admin access This endpoint requires password confirmation |
Create a new userprovisioningApiUsersAddUser | POST | Create a new user This endpoint requires password confirmation |
Delete a config key of an appprovisioningApiAppConfigDeleteKey | DELETE | Delete a config key of an app This endpoint requires admin access This endpoint requires password confirmation |
Delete a groupprovisioningApiGroupsDeleteGroup | DELETE | Delete a group This endpoint requires admin access This endpoint requires password confirmation |
Delete a preference for an appprovisioningApiPreferencesDeletePreference | DELETE | Delete a preference for an app |
Delete a userprovisioningApiUsersDeleteUser | DELETE | Delete a user This endpoint requires password confirmation |
Delete multiple preferences for an appprovisioningApiPreferencesDeleteMultiplePreference | DELETE | Delete multiple preferences for an app |
Disable a userprovisioningApiUsersDisableUser | PUT | Disable a user This endpoint requires password confirmation |
Disable an appprovisioningApiAppsDisable | DELETE | Disable an app This endpoint requires admin access This endpoint requires password confirmation |
Enable a userprovisioningApiUsersEnableUser | PUT | Enable a user This endpoint requires password confirmation |
Enable an appprovisioningApiAppsEnable | POST | Enable an app This endpoint requires admin access This endpoint requires password confirmation |
Get a list of appsprovisioningApiAppConfigGetApps | GET | Get a list of apps This endpoint requires admin access |
Get a list of enabled apps for the current userprovisioningApiUsersGetEnabledApps | GET | Get a list of enabled apps for the current user |
Get a list of fields that are editable for a userprovisioningApiUsersGetEditableFieldsForUser | GET | Get a list of fields that are editable for a user |
Get a list of fields that are editable for the current userprovisioningApiUsersGetEditableFields | GET | Get a list of fields that are editable for the current user |
Get a list of groupsprovisioningApiGroupsGetGroups | GET | Get a list of groups |
Get a list of groups detailsprovisioningApiGroupsGetGroupsDetails | GET | Get a list of groups details |
Get a list of groups the user belongs toprovisioningApiUsersGetUsersGroups | GET | Get a list of groups the user belongs to |
Get a list of groups with detailsprovisioningApiUsersGetUsersGroupsDetails | GET | Get a list of groups with details |
Get a list of installed appsprovisioningApiAppsGetApps | GET | Get a list of installed apps This endpoint requires admin access |
Get a list of the groups the user is a subadmin of, with detailsprovisioningApiUsersGetUserSubAdminGroupsDetails | GET | Get a list of the groups the user is a subadmin of, with details |
Get a list of usersprovisioningApiUsersGetUsers | GET | Get a list of users |
Get a list of users and their detailsprovisioningApiUsersGetUsersDetails | GET | Get a list of users and their details |
Get a list of users details in the specified groupprovisioningApiGroupsGetGroupUsersDetails | GET | Get a list of users details in the specified group |
Get a list of users in the specified groupprovisioningApiGroupsGetGroup | GET | Get a list of users in the specified group |
Get a list of users in the specified groupprovisioningApiGroupsGetGroupUsers | GET | Get a list of users in the specified group |
Get a the config value of an appprovisioningApiAppConfigGetValue | GET | Get a the config value of an app This endpoint requires admin access |
Get the app info for an appprovisioningApiAppsGetAppInfo | GET | Get the app info for an app This endpoint requires admin access |
Get the config keys of an appprovisioningApiAppConfigGetKeys | GET | Get the config keys of an app This endpoint requires admin access |
Get the details of a userprovisioningApiUsersGetUser | GET | Get the details of a user |
Get the details of the current userprovisioningApiUsersGetCurrentUser | GET | Get the details of the current user |
Get the groups a user is a subadmin of This endpoint requires admin accessprovisioningApiUsersGetUserSubAdminGroups | GET | Get the groups a user is a subadmin of This endpoint requires admin access |
Get the list of disabled users and their detailsprovisioningApiUsersGetDisabledUsersDetails | GET | Get the list of disabled users and their details |
Get the list of user IDs that are a subadmin of the groupprovisioningApiGroupsGetSubAdminsOfGroup | GET | Get the list of user IDs that are a subadmin of the group This endpoint requires admin access |
Gets the list of users sorted by lastLogin, from most recent to least recentprovisioningApiUsersGetLastLoggedInUsers | GET | Gets the list of users sorted by lastLogin, from most recent to least recent This endpoint requires admin access |
Make a user a subadmin of a groupprovisioningApiUsersAddSubAdmin | POST | Make a user a subadmin of a group This endpoint requires admin access This endpoint requires password confirmation |
Provisioning API users edit user multi fieldprovisioningApiUsersEditUserMultiField | PATCH | Update multiple user account fields atomically. |
Remove a user from a groupprovisioningApiUsersRemoveFromGroup | DELETE | Remove a user from a group This endpoint requires password confirmation |
Remove a user from the subadmins of a groupprovisioningApiUsersRemoveSubAdmin | DELETE | Remove a user from the subadmins of a group This endpoint requires admin access This endpoint requires password confirmation |
Resend the welcome messageprovisioningApiUsersResendWelcomeMessage | POST | Resend the welcome message This endpoint requires password confirmation |
Search users by their phone numbersprovisioningApiUsersSearchByPhoneNumbers | POST | Search users by their phone numbers |
Update a groupprovisioningApiGroupsUpdateGroup | PUT | Update a group This endpoint requires admin access This endpoint requires password confirmation |
Update a preference value of an appprovisioningApiPreferencesSetPreference | POST | Update a preference value of an app |
Update a value of the user's detailsprovisioningApiUsersEditUser | PUT | Update a value of the user's details This endpoint requires password confirmation |
Update multiple preference values of an appprovisioningApiPreferencesSetMultiplePreferences | POST | Update multiple preference values of an app |
Update multiple values of the user's detailsprovisioningApiUsersEditUserMultiValue | PUT | Update multiple values of the user's details This endpoint requires password confirmation |
Update the config value of an appprovisioningApiAppConfigSetValue | POST | Update the config value of an app This endpoint requires password confirmation |
Wipe all devices of a userprovisioningApiUsersWipeUserDevices | POST | Wipe all devices of a user This endpoint requires password confirmation |
Settings4
download logfilesettingsLogSettingsDownload | GET | download logfile This endpoint requires admin access |
Gets all declarative forms with the values prefilledsettingsDeclarativeSettingsGetForms | GET | Gets all declarative forms with the values prefilled. |
Sets a declarative settings valuesettingsDeclarativeSettingsSetValue | POST | Sets a declarative settings value |
Sets a declarative settings value. Password confirmation is required for sensitive valuessettingsDeclarativeSettingsSetSensitiveValue | POST | Sets a declarative settings value. |
Theming11
Delete the backgroundthemingUserThemeDeleteBackground | DELETE | Delete the background |
Disable themethemingUserThemeDisableTheme | DELETE | Disable theme |
Enable themethemingUserThemeEnableTheme | PUT | Enable theme |
Get a themed iconthemingIconGetThemedIcon | GET | Get a themed icon |
Get an imagethemingThemingGetImage | GET | Get an image |
Get the background imagethemingUserThemeGetBackground | GET | Get the background image |
Get the CSS stylesheet for a themethemingThemingGetThemeStylesheet | GET | Get the CSS stylesheet for a theme |
Get the manifest for an appthemingThemingGetManifest | GET | Get the manifest for an app |
Return a 32x32 favicon as pngthemingIconGetFavicon | GET | Return a 32x32 favicon as png |
Return a 512x512 icon for touch devicesthemingIconGetTouchIcon | GET | Return a 512x512 icon for touch devices |
Set the backgroundthemingUserThemeSetBackground | POST | Set the background |
Trash bin4
Delete from the trash bindavDeleteTrashItem | DELETE | DELETE one trash item permanently. |
Empty the trash bindavEmptyTrash | DELETE | DELETE every trash item permanently. |
List the trash bindavListTrash | PROPFIND | PROPFIND the trash bin with the trash bin properties. |
Restore from the trash bindavRestoreTrashItem | MOVE | MOVE a trash item to /remote.php/dav/trashbin/ /restore/ . |
Update notification2
Get changelog entry for an appupdatenotificationApiGetAppChangelogEntry | GET | Get changelog entry for an app This endpoint requires admin access |
List available updates for appsupdatenotificationApiGetAppList | GET | List available updates for apps This endpoint requires admin access |
User LDAP8
Clear user or group mappingsuserLdapWizardClearMappings | POST | Clear user or group mappings This endpoint requires admin access |
Copy a configurationuserLdapConfigapiCopyConfiguration | POST | Copy a configuration This endpoint requires admin access |
Create a new (empty) configuration and return the resulting prefixuserLdapConfigapiCreate | POST | Create a new (empty) configuration and return the resulting prefix This endpoint requires admin access |
Delete a LDAP configurationuserLdapConfigapiDelete | DELETE | Delete a LDAP configuration This endpoint requires admin access |
Get a configurationuserLdapConfigapiShow | GET | Get a configuration Output can look like this: ok 200 OK ldaps://my.ldap.server 7770 ou=small,dc=my,dc=ldap,dc=server ou=users,ou=small,dc=my,dc=ldap,dc=server... |
Modify a configurationuserLdapConfigapiModify | PUT | Modify a configuration This endpoint requires admin access |
Run a wizard action and returns the resultuserLdapWizardAction | POST | Run a wizard action and returns the result This endpoint requires admin access |
Test a configurationuserLdapConfigapiTestConfiguration | POST | Test a configuration This endpoint requires admin access |
User status10
Clear the message of the current useruserStatusUserStatusClearMessage | DELETE | Clear the message of the current user |
Find statuses of usersuserStatusStatusesFindAll | GET | Find statuses of users |
Find the status of a useruserStatusStatusesFind | GET | Find the status of a user |
Get all predefined messagesuserStatusPredefinedStatusFindAll | GET | Get all predefined messages |
Get the status of the current useruserStatusUserStatusGetStatus | GET | Get the status of the current user |
Keep the status aliveuserStatusHeartbeatHeartbeat | PUT | Keep the status alive |
Revert the status to the previous statususerStatusUserStatusRevertStatus | DELETE | Revert the status to the previous status |
Set the message to a custom message for the current useruserStatusUserStatusSetCustomMessage | PUT | Set the message to a custom message for the current user |
Set the message to a predefined message for the current useruserStatusUserStatusSetPredefinedMessage | PUT | Set the message to a predefined message for the current user |
Update the status type of the current useruserStatusUserStatusSetStatus | PUT | Update the status type of the current user |
Versions2
List file versionsdavListVersions | PROPFIND | PROPFIND the versions of a file; each name is the version timestamp. |
Restore a file versiondavRestoreVersion | MOVE | MOVE a version to /remote.php/dav/versions/ /restore/target. |
Weather status7
Get favorites listweatherStatusWeatherStatusGetFavorites | GET | Get favorites list |
Get forecast for current locationweatherStatusWeatherStatusGetForecast | GET | Get forecast for current location |
Get stored user locationweatherStatusWeatherStatusGetLocation | GET | Get stored user location |
Set favorites listweatherStatusWeatherStatusSetFavorites | PUT | Set favorites list |
Try to use the address set in user personal settings as weather locationweatherStatusWeatherStatusUsePersonalAddress | PUT | Try to use the address set in user personal settings as weather location |
Weather status weather status set locationweatherStatusWeatherStatusSetLocation | PUT | Set address and resolve it to get coordinates or directly set coordinates and get address with reverse geocoding |
Weather status weather status set modeweatherStatusWeatherStatusSetMode | PUT | Change the weather status mode. |
WebDAV files12
CopydavCopy | COPY | COPY a file or folder to the Destination. |
Create a folderdavCreateFolder | MKCOL | MKCOL a folder. |
Delete a file or folderdavDelete | DELETE | DELETE a file, or a folder with its contents; it moves to the trash bin when enabled. |
Download a filedavDownloadFile | GET | GET a file; the bytes stream into a file reference whatever their type. |
Download a folder as an archivedavDownloadFolder | GET | GET a folder as a ZIP or tar archive, optionally limited to listed files. |
Get file or folder propertiesdavGetProperties | PROPFIND | PROPFIND with Depth 0 for one resource. |
List a folderdavListFolder | PROPFIND | PROPFIND with Depth 1: one record per entry, the folder first. |
List favoritesdavListFavorites | REPORT | REPORT oc:filter-files with the favorite rule; searches the folder recursively. |
Move or renamedavMove | MOVE | MOVE a file or folder to the Destination. |
Search filesdavSearch | SEARCH | SEARCH (RFC 5323) with a d:searchrequest scoped to /files/ , with filters, ordering and d:limit. |
Set propertiesdavSetProperties | PROPPATCH | PROPPATCH with a d:propertyupdate document, for example oc:favorite 1 to mark a favorite. |
Upload a filedavUploadFile | PUT | PUT a file, replacing an existing one. |
Webhook listeners6
Get details on a registered webhookwebhookListenersWebhooksShow | GET | Get details on a registered webhook This endpoint requires admin access |
List registered webhookswebhookListenersWebhooksIndex | GET | List registered webhooks This endpoint requires admin access |
Register a new webhookwebhookListenersWebhooksCreate | POST | Register a new webhook This endpoint requires admin access |
Remove all existing webhook registration mapped to an AppAPI app idwebhookListenersWebhooksDeleteByAppId | DELETE | Remove all existing webhook registration mapped to an AppAPI app id This endpoint requires admin access |
Remove an existing webhook registrationwebhookListenersWebhooksDestroy | DELETE | Remove an existing webhook registration This endpoint requires admin access |
Update an existing webhook registrationwebhookListenersWebhooksUpdate | POST | Update an existing webhook registration This endpoint requires admin access |
Workflow engine10
Create a workflowworkflowengineGlobalWorkflowsCreate | POST | Create a workflow This endpoint requires admin access This endpoint requires password confirmation |
Create a workflowworkflowengineUserWorkflowsCreate | POST | Create a workflow This endpoint requires password confirmation |
Delete a workflowworkflowengineGlobalWorkflowsDestroy | DELETE | Delete a workflow This endpoint requires admin access This endpoint requires password confirmation |
Delete a workflowworkflowengineUserWorkflowsDestroy | DELETE | Delete a workflow This endpoint requires password confirmation |
Modify a workflowworkflowengineGlobalWorkflowsUpdate | PUT | Modify a workflow This endpoint requires admin access This endpoint requires password confirmation |
Modify a workflowworkflowengineUserWorkflowsUpdate | PUT | Modify a workflow This endpoint requires password confirmation |
Retrieve a specific workflowworkflowengineGlobalWorkflowsShow | GET | Retrieve a specific workflow This endpoint requires admin access |
Retrieve a specific workflowworkflowengineUserWorkflowsShow | GET | Retrieve a specific workflow |
Retrieve all configured workflow rulesworkflowengineGlobalWorkflowsIndex | GET | Retrieve all configured workflow rules This endpoint requires admin access |
Retrieve all configured workflow rulesworkflowengineUserWorkflowsIndex | GET | Retrieve all configured workflow rules |