{"version":1,"pages":[{"id":"Z8xQqrBDhVv0oYUnbRW0","title":"Couchdrop API Overview","pathname":"/","siteSpaceId":"sitesp_cKJ0A","description":""},{"id":"GlUtCXDkdyaSCIUth8fX","title":"Available Endpoints","pathname":"/available-endpoints","siteSpaceId":"sitesp_cKJ0A","description":"Couchdrop has two separate endpoints for public API access"},{"id":"JpMBKBHp4nXpt4CJ6qAf","title":"Errors and Response Codes","pathname":"/errors-and-response-codes","siteSpaceId":"sitesp_cKJ0A","description":"All API methods return a HTTP status code which indicates success or failure."},{"id":"-LkbgTNtbgOx4jS40q9_","title":"Manage domain/account","pathname":"/domains-and-accounts/master","siteSpaceId":"sitesp_cKJ0A","description":"General settings allow you to manage your account with Couchdrop. Its also the perfect place to start with API access.","breadcrumbs":[{"label":"Domains and Accounts"}]},{"id":"EgmwWFVQ7C7a742VJvwZ","title":"Authentication","pathname":"/domains-and-accounts/authentication","siteSpaceId":"sitesp_cKJ0A","description":"To authenticate with Couchdrop see the routes below","breadcrumbs":[{"label":"Domains and Accounts"}]},{"id":"-LkbhGoNSUKdhxmk_9yw","title":"Users","pathname":"/administration/managing-users","siteSpaceId":"sitesp_cKJ0A","description":"With Couchdrop you can configure additional users. Additional users cannot manage your Couchdrop service, but are able to upload/download and view files.","breadcrumbs":[{"label":"Administration"}]},{"id":"Kbg1RnnIng53267S58fq","title":"Groups","pathname":"/administration/groups","siteSpaceId":"sitesp_cKJ0A","description":"Managing groups can be done via the API. The following routes are available.","breadcrumbs":[{"label":"Administration"}]},{"id":"-MIVogKd8kpUONEUwOAM","title":"Folder Permissions","pathname":"/administration/advanced-folder-permissions","siteSpaceId":"sitesp_cKJ0A","description":"After enabling Advanced Permissions, you can configure a folder with granular access to individual users.","breadcrumbs":[{"label":"Administration"}]},{"id":"fIhEvMV9u1WmUKUW2Dqc","title":"Folder Properties","pathname":"/administration/managing-folders","siteSpaceId":"sitesp_cKJ0A","description":"With Couchdrop you can configure folders with advanced user permissions, webhook and email notifications, as well as web portal uploads.","breadcrumbs":[{"label":"Administration"}]},{"id":"-MLiy_u8fNeUeIt3GcP5","title":"Shared Links","pathname":"/administration/managing-shared-links","siteSpaceId":"sitesp_cKJ0A","description":"Shared Links can be created to provide external users with access to files. Links can be set up securely with a password requirement as well as a time for access via the link to expire.","breadcrumbs":[{"label":"Administration"}]},{"id":"5TTZCJoavXdxwiwDhdea","title":"Storage Connections","pathname":"/administration/storage-connections","siteSpaceId":"sitesp_cKJ0A","description":"Couchdrop connects to external storage engines. Managing storage engines and mappings can be done using the API.","breadcrumbs":[{"label":"Administration"}]},{"id":"v7AasWDOe7yi2aUDEHkw","title":"SFTP Connections","pathname":"/administration/storage-connections/sftp-connections","siteSpaceId":"sitesp_cKJ0A","description":"Configuring a connection to an external SFTP can be done with basic connectivity details as outlined below.","breadcrumbs":[{"label":"Administration"},{"label":"Storage Connections"}]},{"id":"8UROBW4GGHw0fHm13aj4","title":"S3 Connections","pathname":"/administration/storage-connections/s3-connections","siteSpaceId":"sitesp_cKJ0A","description":"Configuring a connection to S3 or a compatible S3 provider can be done with basic connectivity details as outlined below.","breadcrumbs":[{"label":"Administration"},{"label":"Storage Connections"}]},{"id":"fKlLTyfN5mVm5P7mwzvW","title":"FTP Connections","pathname":"/administration/storage-connections/ftp-connections","siteSpaceId":"sitesp_cKJ0A","description":"Configuring a connection to an external FTP can be done with basic connectivity details as outlined below.","breadcrumbs":[{"label":"Administration"},{"label":"Storage Connections"}]},{"id":"tq3iV0zwft4V81mBudjK","title":"Azure Connections","pathname":"/administration/storage-connections/azure-connections","siteSpaceId":"sitesp_cKJ0A","description":"","breadcrumbs":[{"label":"Administration"},{"label":"Storage Connections"}]},{"id":"5k5tDC1bhohIZI7lWnxK","title":"GCS Connections","pathname":"/administration/storage-connections/gcs-connections","siteSpaceId":"sitesp_cKJ0A","description":"","breadcrumbs":[{"label":"Administration"},{"label":"Storage Connections"}]},{"id":"YpsSuuCh77uAiryfTLuQ","title":"Other","pathname":"/administration/storage-connections/other","siteSpaceId":"sitesp_cKJ0A","description":"","breadcrumbs":[{"label":"Administration"},{"label":"Storage Connections"}]},{"id":"gEIURYj0FMzfKkJ7NaRo","title":"Automations","pathname":"/administration/automations","siteSpaceId":"sitesp_cKJ0A","description":"With Couchdrop you can configure Automations which can be created to perform actions on files and folders automatically. These workflows can be action or schedule based.","breadcrumbs":[{"label":"Administration"}]},{"id":"0udVGQc2AKKtb4sGxIqq","title":"Scheduled Automations","pathname":"/administration/automations/scheduled-automations","siteSpaceId":"sitesp_cKJ0A","description":"","breadcrumbs":[{"label":"Administration"},{"label":"Automations"}]},{"id":"AVnICPQfIL9KAsdOWavM","title":"Create/Update","pathname":"/administration/automations/scheduled-automations/create-update","siteSpaceId":"sitesp_cKJ0A","description":"Create or update a schedule workflow","breadcrumbs":[{"label":"Administration"},{"label":"Automations"},{"label":"Scheduled Automations"}]},{"id":"hpv9V8RV6fD8DpjZeOjG","title":"Get all schedule workflows","pathname":"/administration/automations/scheduled-automations/get-all-schedule-workflows","siteSpaceId":"sitesp_cKJ0A","description":"Get all configured schedule workflow configurations","breadcrumbs":[{"label":"Administration"},{"label":"Automations"},{"label":"Scheduled Automations"}]},{"id":"8BVKSpgrYgpqdrrpK3KA","title":"Get schedule workflow","pathname":"/administration/automations/scheduled-automations/get-schedule-workflow","siteSpaceId":"sitesp_cKJ0A","description":"Get a specific schedule workflow configuration.","breadcrumbs":[{"label":"Administration"},{"label":"Automations"},{"label":"Scheduled Automations"}]},{"id":"rjAXbnXoc8ZtEubl5oVw","title":"Trigger schedule workflow","pathname":"/administration/automations/scheduled-automations/trigger-schedule-workflow","siteSpaceId":"sitesp_cKJ0A","description":"Trigger specific schedule workflow for testing purposes.","breadcrumbs":[{"label":"Administration"},{"label":"Automations"},{"label":"Scheduled Automations"}]},{"id":"Ozz2zPBX9VcFR8rwc9ID","title":"Delete Scheduled Workflow","pathname":"/administration/automations/scheduled-automations/delete-scheduled-workflow","siteSpaceId":"sitesp_cKJ0A","description":"Delete a schedule workflow","breadcrumbs":[{"label":"Administration"},{"label":"Automations"},{"label":"Scheduled Automations"}]},{"id":"726FngYgWNZJHvC1Xqfx","title":"Event Automations","pathname":"/administration/automations/event-automations","siteSpaceId":"sitesp_cKJ0A","description":"","breadcrumbs":[{"label":"Administration"},{"label":"Automations"}]},{"id":"IJsHVZ4Xjjlw8Jebuw86","title":"Create/Update","pathname":"/administration/automations/event-automations/create-update","siteSpaceId":"sitesp_cKJ0A","description":"Create or update an action workflow","breadcrumbs":[{"label":"Administration"},{"label":"Automations"},{"label":"Event Automations"}]},{"id":"rCVL9ceoEHhf8Mn6kYfY","title":"Get action workflow","pathname":"/administration/automations/event-automations/get-action-workflow","siteSpaceId":"sitesp_cKJ0A","description":"Get a specific action workflow configuration.","breadcrumbs":[{"label":"Administration"},{"label":"Automations"},{"label":"Event Automations"}]},{"id":"Z3x6X0A7ge7oJSc0q7Rk","title":"Get all action workflows","pathname":"/administration/automations/event-automations/get-all-action-workflows","siteSpaceId":"sitesp_cKJ0A","description":"Get all configured action workflow configurations","breadcrumbs":[{"label":"Administration"},{"label":"Automations"},{"label":"Event Automations"}]},{"id":"d3z7MpnK7AUEpGpvqLWh","title":"Delete Action Workflow","pathname":"/administration/automations/event-automations/delete-action-workflow","siteSpaceId":"sitesp_cKJ0A","description":"Delete an action workflow","breadcrumbs":[{"label":"Administration"},{"label":"Automations"},{"label":"Event Automations"}]},{"id":"nvEQOt7TZ9nTrUq2fTFj","title":"Actions","pathname":"/administration/automations/actions","siteSpaceId":"sitesp_cKJ0A","description":"When configuring an automation, you are required to configure a set of actions. These actions apply to the files matching the conditions of the automation.","breadcrumbs":[{"label":"Administration"},{"label":"Automations"}]},{"id":"5VfS1wih2R8J2UNDYqys","title":"Webhook","pathname":"/administration/automations/actions/webhook","siteSpaceId":"sitesp_cKJ0A","description":"The webhook action sends a HTTP/HTTPS webhook to the destination specified.","breadcrumbs":[{"label":"Administration"},{"label":"Automations"},{"label":"Actions"}]},{"id":"0d61a7axS2SgR1mEza1r","title":"Rename","pathname":"/administration/automations/actions/rename","siteSpaceId":"sitesp_cKJ0A","description":"The rename action renames a file.","breadcrumbs":[{"label":"Administration"},{"label":"Automations"},{"label":"Actions"}]},{"id":"6eGvEEW95BEuUnIEDRKN","title":"Copy","pathname":"/administration/automations/actions/copy","siteSpaceId":"sitesp_cKJ0A","description":"The copy action duplicates a file, copying it to a new destination","breadcrumbs":[{"label":"Administration"},{"label":"Automations"},{"label":"Actions"}]},{"id":"WcGU4rWXRCxgV2VJkRj7","title":"Move","pathname":"/administration/automations/actions/move","siteSpaceId":"sitesp_cKJ0A","description":"The move action copies a file then removes the original object. Effectively moving the file.","breadcrumbs":[{"label":"Administration"},{"label":"Automations"},{"label":"Actions"}]},{"id":"xaUNhfGzpLLiZBS9i3Dn","title":"PGP Encrypt","pathname":"/administration/automations/actions/pgp-encrypt","siteSpaceId":"sitesp_cKJ0A","description":"The PGP encrypt action can be used to encrypt files as part of a workflow.","breadcrumbs":[{"label":"Administration"},{"label":"Automations"},{"label":"Actions"}]},{"id":"x0oaaxkPObspDCf2jio7","title":"Paths","pathname":"/administration/automations/actions/paths","siteSpaceId":"sitesp_cKJ0A","description":"Certain operations work on paths. Couchdrop has a bunch of path variables available that can be used to craft relevant paths.","breadcrumbs":[{"label":"Administration"},{"label":"Automations"},{"label":"Actions"}]},{"id":"60IX7UILrKzeazPptj0b","title":"Conditions","pathname":"/administration/automations/conditions","siteSpaceId":"sitesp_cKJ0A","description":"When configuring an automation, you can set additional conditions on it which are required to match before the automation will fire.","breadcrumbs":[{"label":"Administration"},{"label":"Automations"}]},{"id":"FvIG3Q2Pgdd9UBHwjc3c","title":"Symlinks/Shortcuts","pathname":"/administration/symlinks-shortcuts","siteSpaceId":"sitesp_cKJ0A","description":"Symbolic links or Shortcuts provide a versatile and easy way to work with directories in multiple locations. A symlink/shortcut can point to any folder in the Couchdrop virtual file system.","breadcrumbs":[{"label":"Administration"}]},{"id":"ybRAPmtYyo9hksJmxvKG","title":"Auditing and Reporting","pathname":"/administration/auditing-and-reporting","siteSpaceId":"sitesp_cKJ0A","description":"Couchdrop has comprehensive auditing across all operations. Audit events can be pulled from the API","breadcrumbs":[{"label":"Administration"}]},{"id":"-MkK2FWUM0y5dTWRg3m1","title":"Using webhooks","pathname":"/webhooks/using-webhooks","siteSpaceId":"sitesp_cKJ0A","description":"Couchdrop provides configurable webhooks on all file events. Webhooks can be sent to a HTTPS endpoint and always contain a JSON body with the event details.","breadcrumbs":[{"label":"Webhooks"}]},{"id":"TwiMMuBYn2DTuffNe5nQ","title":"Listing files/folders","pathname":"/filesystem-operations/managing-files","siteSpaceId":"sitesp_cKJ0A","description":"","breadcrumbs":[{"label":"Filesystem Operations"}]},{"id":"-Ly7-E5lWn7xpjjT0y_Q","title":"Downloading a file","pathname":"/filesystem-operations/downloading-a-file","siteSpaceId":"sitesp_cKJ0A","description":"How to stream a file with Couchdrop","breadcrumbs":[{"label":"Filesystem Operations"}]},{"id":"-LxOnvdIIWq2KnoPUGex","title":"Uploading a File","pathname":"/filesystem-operations/uploading-a-file","siteSpaceId":"sitesp_cKJ0A","description":"Uploading a file is the most common use case for our API. Files are uploaded in binary form as the post body.","breadcrumbs":[{"label":"Filesystem Operations"}]},{"id":"5a5xDE6gymzhvHK3j2I8","title":"Rename files/folders","pathname":"/filesystem-operations/managing-files-1","siteSpaceId":"sitesp_cKJ0A","description":"","breadcrumbs":[{"label":"Filesystem Operations"}]},{"id":"-LxOneMzCikHBOUWxQ-9","title":"Deleting files/folders","pathname":"/filesystem-operations/managing-files-2","siteSpaceId":"sitesp_cKJ0A","description":"","breadcrumbs":[{"label":"Filesystem Operations"}]},{"id":"Eo1e5SWA3KFQd6toBdkz","title":"Create a folder","pathname":"/filesystem-operations/managing-folders","siteSpaceId":"sitesp_cKJ0A","description":"","breadcrumbs":[{"label":"Filesystem Operations"}]}]}