{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:exavault/get-account":{"get":{"operationId":"cloud_exavault_get_account","summary":"Get account settings","description":"GET /account","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API Key required for the request","schema":{"type":"string","description":"API Key required for the request"}},{"name":"ev-access-token","in":"query","required":true,"description":"Access Token for the request","schema":{"type":"string","description":"Access Token for the request"}},{"name":"include","in":"query","required":false,"description":"Related records to include in the response. Valid option is **masterUser**","schema":{"type":"string","description":"Related records to include in the response. Valid option is **masterUser**"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/update-account":{"post":{"operationId":"cloud_exavault_update_account","summary":"Update account settings","description":"PATCH /account","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-session-logs":{"get":{"operationId":"cloud_exavault_get_session_logs","summary":"Get activity logs","description":"GET /activity/session","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API Key","schema":{"type":"string","description":"API Key"}},{"name":"ev-access-token","in":"query","required":true,"description":"Access Token","schema":{"type":"string","description":"Access Token"}},{"name":"startDate","in":"query","required":false,"description":"Start date of the filter data range","schema":{"type":"string","description":"Start date of the filter data range"},"example":"2025-10-15T13:51:03.345Z"},{"name":"endDate","in":"query","required":false,"description":"End date of the filter data range","schema":{"type":"string","description":"End date of the filter data range"},"example":"2025-10-15T13:51:03.345Z"},{"name":"ipAddress","in":"query","required":false,"description":"Used to filter session logs by ip address.","schema":{"type":"string","description":"Used to filter session logs by ip address."},"example":"127.0.0.1"},{"name":"username","in":"query","required":false,"description":"Username used for filtering a list","schema":{"type":"string","description":"Username used for filtering a list"},"example":"jdoe"},{"name":"path","in":"query","required":false,"description":"Path used to filter records","schema":{"type":"string","description":"Path used to filter records"},"example":"/folder*"},{"name":"type","in":"query","required":false,"description":"Filter session logs for operation type (see table above for acceptable values)","schema":{"type":"string","description":"Filter session logs for operation type (see table above for acceptable values)"},"example":"EDIT_SHARE"},{"name":"offset","in":"query","required":false,"description":"Offset of the records list","schema":{"type":"integer","description":"Offset of the records list"},"example":100},{"name":"limit","in":"query","required":false,"description":"Limit of the records list","schema":{"type":"integer","description":"Limit of the records list"},"example":10},{"name":"sort","in":"query","required":false,"description":"Comma separated list sort params","schema":{"type":"string","description":"Comma separated list sort params"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-webhook-logs":{"get":{"operationId":"cloud_exavault_get_webhook_logs","summary":"Get webhook logs","description":"GET /activity/webhooks","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API Key","schema":{"type":"string","description":"API Key"}},{"name":"ev-access-token","in":"query","required":true,"description":"Access Token","schema":{"type":"string","description":"Access Token"}},{"name":"startDate","in":"query","required":false,"description":"Earliest date of entries to include in list","schema":{"type":"string","description":"Earliest date of entries to include in list"}},{"name":"endDate","in":"query","required":false,"description":"Latest date of entries to include in list","schema":{"type":"string","description":"Latest date of entries to include in list"}},{"name":"endpointUrl","in":"query","required":false,"description":"Webhook listener endpoint","schema":{"type":"string","description":"Webhook listener endpoint"}},{"name":"event","in":"query","required":false,"description":"Type of activity that triggered the webhook attempt","schema":{"type":"string","description":"Type of activity that triggered the webhook attempt"}},{"name":"statusCode","in":"query","required":false,"description":"Response code from the webhook endpoint","schema":{"type":"integer","description":"Response code from the webhook endpoint"},"example":200},{"name":"resourcePath","in":"query","required":false,"description":"Path of the resource that triggered the webhook attempt","schema":{"type":"string","description":"Path of the resource that triggered the webhook attempt"},"example":"/folder*"},{"name":"username","in":"query","required":false,"description":"Filter by triggering username.","schema":{"type":"string","description":"Filter by triggering username."}},{"name":"offset","in":"query","required":false,"description":"Records to skip before returning results.","schema":{"type":"integer","description":"Records to skip before returning results."},"example":100},{"name":"limit","in":"query","required":false,"description":"Limit of the records list","schema":{"type":"integer","description":"Limit of the records list"},"example":10},{"name":"sort","in":"query","required":false,"description":"Comma separated list sort params","schema":{"type":"string","description":"Comma separated list sort params"},"example":"-date,event"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-email-lists":{"get":{"operationId":"cloud_exavault_get_email_lists","summary":"Get all email groups","description":"GET /email-lists","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API Key required to make the API call.","schema":{"type":"string","description":"API Key required to make the API call."},"example":"exampleaccount-zwSuWUZ8S38h33qPS8v0s"},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"},{"name":"include","in":"query","required":false,"description":"Related record types to include in the response. Valid option is `ownerUser`","schema":{"type":"string","description":"Related record types to include in the response. Valid option is `ownerUser`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/add-email-list":{"post":{"operationId":"cloud_exavault_add_email_list","summary":"Create new email list","description":"POST /email-lists","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-email-list-by-id":{"get":{"operationId":"cloud_exavault_get_email_list_by_id","summary":"Get individual email group","description":"GET /email-lists/{id}","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API Key required to make the API call.","schema":{"type":"string","description":"API Key required to make the API call."},"example":"exampleaccount-zwSuWUZ8S38h33qPS8v0s"},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"},{"name":"id","in":"query","required":true,"description":"ID of the email list to return.","schema":{"type":"integer","description":"ID of the email list to return."}},{"name":"include","in":"query","required":false,"description":"Related record types to include in the response. Valid option is `ownerUser`","schema":{"type":"string","description":"Related record types to include in the response. Valid option is `ownerUser`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/update-email-list-by-id":{"post":{"operationId":"cloud_exavault_update_email_list_by_id","summary":"Update an email group","description":"PATCH /email-lists/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token","id"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"id":{"type":"integer","description":"ID of the email list to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/delete-email-list-by-id":{"post":{"operationId":"cloud_exavault_delete_email_list_by_id","summary":"Delete an email group with given id","description":"DELETE /email-lists/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token","id"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"id":{"type":"integer","description":"ID of the email list to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/send-referral-email":{"post":{"operationId":"cloud_exavault_send_referral_email","summary":"Send referral email to a given address","description":"POST /email/referral","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/send-welcome-email":{"post":{"operationId":"cloud_exavault_send_welcome_email","summary":"Resend welcome email to specific user","description":"POST /email/welcome/{username}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token","username"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"username":{"type":"string","description":"A username to send the welcome email to."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-form-by-share-hash":{"get":{"operationId":"cloud_exavault_get_form_by_share_hash","summary":"Get receive folder form settings","description":"GET /forms","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API key required to make the API call.","schema":{"type":"string","description":"API key required to make the API call."}},{"name":"ev-access-token","in":"query","required":true,"description":"Access Token required to make the API call.","schema":{"type":"string","description":"Access Token required to make the API call."}},{"name":"shareHash","in":"query","required":true,"description":"Share hash to retrieve the form for.","schema":{"type":"string","description":"Share hash to retrieve the form for."}},{"name":"include","in":"query","required":false,"description":"Related record types to include in the response. Valid option is **share**","schema":{"type":"string","enum":["share"],"description":"Related record types to include in the response. Valid option is **share**"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-form-entries":{"get":{"operationId":"cloud_exavault_get_form_entries","summary":"Get form data entries for a receive","description":"GET /forms/entries/{id}","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API Key required to make the API call.","schema":{"type":"string","description":"API Key required to make the API call."}},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"},{"name":"id","in":"query","required":true,"description":"ID of the form to retrieve entries for.","schema":{"type":"integer","description":"ID of the form to retrieve entries for."}},{"name":"limit","in":"query","required":false,"description":"Limit of records to be returned (for pagination)","schema":{"type":"integer","description":"Limit of records to be returned (for pagination)"},"example":10},{"name":"offset","in":"query","required":false,"description":"Current offset of records (for pagination)","schema":{"type":"integer","description":"Current offset of records (for pagination)"},"example":100}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/delete-form-message-by-id":{"post":{"operationId":"cloud_exavault_delete_form_message_by_id","summary":"Delete a receive form submission","description":"DELETE /forms/entries/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token","id"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"id":{"type":"integer","description":"ID of the entry to be deleted data for"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-form-by-id":{"get":{"operationId":"cloud_exavault_get_form_by_id","summary":"Get receive folder form by Id","description":"GET /forms/{id}","tags":["cloud"],"parameters":[{"name":"id","in":"query","required":true,"description":"Form unique ID number.","schema":{"type":"integer","description":"Form unique ID number."}},{"name":"ev-api-key","in":"query","required":true,"description":"API key required to make the API call.","schema":{"type":"string","description":"API key required to make the API call."}},{"name":"ev-access-token","in":"query","required":true,"description":"Access Token required to make the API call.","schema":{"type":"string","description":"Access Token required to make the API call."}},{"name":"include","in":"query","required":false,"description":"Enter \"**share**\" to get information about associated receive folder.","schema":{"type":"string","description":"Enter \"**share**\" to get information about associated receive folder."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/update-form-by-id":{"post":{"operationId":"cloud_exavault_update_form_by_id","summary":"Updates a form with given parameters","description":"PATCH /forms/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","ev-api-key","ev-access-token"],"properties":{"id":{"type":"integer","description":"Form unique ID number."},"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/list-notifications":{"get":{"operationId":"cloud_exavault_list_notifications","summary":"Get a list of notifications","description":"GET /notifications","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API Key required to make the API call.","schema":{"type":"string","description":"API Key required to make the API call."}},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"},{"name":"type","in":"query","required":false,"description":"Type of notification include in the list. Valid options are **file**, **folder**, **send_receipt**, **share_receipt**, **file_drop** If…","schema":{"type":"string","enum":["file","folder","shared_folder","send_receipt","share_receipt","file_drop"],"description":"Type of notification include in the list. Valid options are **file**, **folder**, **send_receipt**, **share_receipt**, **file_drop** If…"},"example":"file"},{"name":"offset","in":"query","required":false,"description":"Starting notification record in the result set. Can be used for pagination.","schema":{"type":"integer","default":0,"description":"Starting notification record in the result set. Can be used for pagination."},"example":50},{"name":"sort","in":"query","required":false,"description":"What order the list of matches should be in. Valid sort fields are **resourcename**, **date**, **action** and **type**. The sort order for…","schema":{"type":"string","description":"What order the list of matches should be in. Valid sort fields are **resourcename**, **date**, **action** and **type**. The sort order for…"},"example":"date"},{"name":"limit","in":"query","required":false,"description":"Number of notification records to return. Can be used for pagination.","schema":{"type":"integer","default":25,"description":"Number of notification records to return. Can be used for pagination."},"example":100},{"name":"include","in":"query","required":false,"description":"Related records to include in the response. Valid options are **ownerUser**, **resource**, **share**","schema":{"type":"string","enum":["resource","share","user"],"description":"Related records to include in the response. Valid options are **ownerUser**, **resource**, **share**"},"example":"resource,share,user"},{"name":"action","in":"query","required":false,"description":"The kind of action which triggers the notification. Valid choices are **connect** (only for delivery receipts), **download**, **upload**,…","schema":{"type":"string","enum":["connect","download","upload","delete","all"],"description":"The kind of action which triggers the notification. Valid choices are **connect** (only for delivery receipts), **download**, **upload**,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/add-notification":{"post":{"operationId":"cloud_exavault_add_notification","summary":"Create a new notification","description":"POST /notifications","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-notification-by-id":{"get":{"operationId":"cloud_exavault_get_notification_by_id","summary":"Get notification details","description":"GET /notifications/{id}","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API Key required to make the API call.","schema":{"type":"string","description":"API Key required to make the API call."}},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"},{"name":"id","in":"query","required":true,"description":"ID of the notification. Use [GET /notifications](#operation/listNotifications) if you need to lookup an ID.","schema":{"type":"integer","description":"ID of the notification. Use [GET /notifications](#operation/listNotifications) if you need to lookup an ID."},"example":3},{"name":"include","in":"query","required":false,"description":"Related record types to include in the response. You can include multiple types by separating them with commas. Valid options are…","schema":{"type":"string","description":"Related record types to include in the response. You can include multiple types by separating them with commas. Valid options are…"},"example":"resource,share"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/update-notification-by-id":{"post":{"operationId":"cloud_exavault_update_notification_by_id","summary":"Update a notification","description":"PATCH /notifications/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token","id"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"id":{"type":"integer","description":"ID of the notification. Use [GET /notifications](#operation/listNotifications) if you need to lookup an ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/delete-notification-by-id":{"post":{"operationId":"cloud_exavault_delete_notification_by_id","summary":"Delete a notification","description":"DELETE /notifications/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token","id"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"id":{"type":"integer","description":"ID of the notification. Use [GET /notifications](#operation/listNotifications) if you need to lookup an ID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/resend-invitations-for-share":{"post":{"operationId":"cloud_exavault_resend_invitations_for_share","summary":"Resend invitations to share recipients","description":"POST /recipients/shares/invites/{shareId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token","shareId"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"shareId":{"type":"integer","description":"ID of the share to resend invites for."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-resource-info":{"get":{"operationId":"cloud_exavault_get_resource_info","summary":"Get Resource Properties","description":"GET /resources","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API Key required to make the API call.","schema":{"type":"string","description":"API Key required to make the API call."}},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"},{"name":"resource","in":"query","required":true,"description":"Resource identifier of the file or folder to get metadata for.","schema":{"type":"string","description":"Resource identifier of the file or folder to get metadata for."}},{"name":"include","in":"query","required":false,"description":"Comma separated list of relationships to include in response. Possible values are **share**, **notifications**, **directFile**,…","schema":{"type":"string","description":"Comma separated list of relationships to include in response. Possible values are **share**, **notifications**, **directFile**,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/add-folder":{"post":{"operationId":"cloud_exavault_add_folder","summary":"Create a folder","description":"POST /resources","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/delete-resources":{"post":{"operationId":"cloud_exavault_delete_resources","summary":"Delete Resources","description":"DELETE /resources","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token"],"properties":{"ev-api-key":{"type":"string","description":"API Key"},"ev-access-token":{"type":"string","description":"Access Token"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/compress-files":{"post":{"operationId":"cloud_exavault_compress_files","summary":"Compress resources","description":"POST /resources/compress","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/copy-resources":{"post":{"operationId":"cloud_exavault_copy_resources","summary":"Copy resources","description":"POST /resources/copy","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/download":{"get":{"operationId":"cloud_exavault_download","summary":"Download a file","description":"GET /resources/download","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API Key required to make the API call.","schema":{"type":"string","description":"API Key required to make the API call."}},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"},{"name":"resources[]","in":"query","required":true,"description":"Path of file or folder to be downloaded, starting from the root. Can also be an array of paths.","schema":{"type":"array","description":"Path of file or folder to be downloaded, starting from the root. Can also be an array of paths."}},{"name":"downloadArchiveName","in":"query","required":false,"description":"When downloading multiple files, this will be used as the name of the zip file that is created.","schema":{"type":"string","description":"When downloading multiple files, this will be used as the name of the zip file that is created."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/extract-files":{"post":{"operationId":"cloud_exavault_extract_files","summary":"Extract resources","description":"POST /resources/extract","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/list-resources":{"get":{"operationId":"cloud_exavault_list_resources","summary":"Get a list of all resources","description":"GET /resources/list","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API Key required to make the API call.","schema":{"type":"string","description":"API Key required to make the API call."}},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"},{"name":"resource","in":"query","required":true,"description":"Resource identifier to get resources for. Can be path/id/name.","schema":{"type":"string","description":"Resource identifier to get resources for. Can be path/id/name."}},{"name":"sort","in":"query","required":false,"description":"Endpoint support multiple sort fields by allowing array of sort params. Sort fields should be applied in the order specified. The sort…","schema":{"type":"string","description":"Endpoint support multiple sort fields by allowing array of sort params. Sort fields should be applied in the order specified. The sort…"}},{"name":"offset","in":"query","required":false,"description":"Determines which item to start on for pagination. Use zero (0) to start at the beginning of the list. e.g, setting `offset=200` would…","schema":{"type":"integer","default":0,"description":"Determines which item to start on for pagination. Use zero (0) to start at the beginning of the list. e.g, setting `offset=200` would…"}},{"name":"limit","in":"query","required":false,"description":"The number of files to limit the result. If you have more files in your directory than this limit, make multiple calls, incrementing the…","schema":{"type":"integer","description":"The number of files to limit the result. If you have more files in your directory than this limit, make multiple calls, incrementing the…"}},{"name":"type","in":"query","required":false,"description":"Limit types of resources returned to \"file\" or \"dir\" only. This is ignored if you are using the `name` parameter to trigger a search.","schema":{"type":"string","description":"Limit types of resources returned to \"file\" or \"dir\" only. This is ignored if you are using the `name` parameter to trigger a search."}},{"name":"name","in":"query","required":false,"description":"Text to match resource names. This allows you to filter the results returned. For example, to locate only zip archive files, you can enter…","schema":{"type":"string","description":"Text to match resource names. This allows you to filter the results returned. For example, to locate only zip archive files, you can enter…"}},{"name":"include","in":"query","required":false,"description":"Comma separated list of relationships to include in response. Possible values are **share**, **notifications**, **directFile**,…","schema":{"type":"string","description":"Comma separated list of relationships to include in response. Possible values are **share**, **notifications**, **directFile**,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/list-resource-contents":{"get":{"operationId":"cloud_exavault_list_resource_contents","summary":"List contents of folder","description":"GET /resources/list/{id}","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API Key required to make the API call.","schema":{"type":"string","description":"API Key required to make the API call."}},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"},{"name":"id","in":"query","required":true,"description":"ID of the parent resource to get a list of resources for.","schema":{"type":"integer","description":"ID of the parent resource to get a list of resources for."}},{"name":"sort","in":"query","required":false,"description":"Endpoint support multiple sort fields by allowing array of sort params. Sort fields should be applied in the order specified. The sort…","schema":{"type":"string","description":"Endpoint support multiple sort fields by allowing array of sort params. Sort fields should be applied in the order specified. The sort…"}},{"name":"offset","in":"query","required":false,"description":"Determines which item to start on for pagination. Use zero (0) to start at the beginning of the list.","schema":{"type":"integer","default":0,"description":"Determines which item to start on for pagination. Use zero (0) to start at the beginning of the list."}},{"name":"limit","in":"query","required":false,"description":"The number of files to limit the result. Cannot be set higher than 100. If you have more than one hundred files in your directory, make…","schema":{"type":"integer","description":"The number of files to limit the result. Cannot be set higher than 100. If you have more than one hundred files in your directory, make…"}},{"name":"type","in":"query","required":false,"description":"Limit types of resources returned to \"file\" or \"dir\" only.","schema":{"type":"string","description":"Limit types of resources returned to \"file\" or \"dir\" only."}},{"name":"include","in":"query","required":false,"description":"Comma separated list of relationships to include in response. Possible values are **share**, **notifications**, **directFile**,…","schema":{"type":"string","description":"Comma separated list of relationships to include in response. Possible values are **share**, **notifications**, **directFile**,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/move-resources":{"post":{"operationId":"cloud_exavault_move_resources","summary":"Move resources","description":"POST /resources/move","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-preview-image":{"get":{"operationId":"cloud_exavault_get_preview_image","summary":"Preview a file","description":"GET /resources/preview","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API Key","schema":{"type":"string","description":"API Key"}},{"name":"ev-access-token","in":"query","required":true,"description":"Access Token","schema":{"type":"string","description":"Access Token"}},{"name":"resource","in":"query","required":true,"description":"Resource identifier for the image file.","schema":{"type":"string","description":"Resource identifier for the image file."}},{"name":"size","in":"query","required":true,"description":"The size of the image.","schema":{"type":"string","enum":["small","medium","large"],"description":"The size of the image."}},{"name":"width","in":"query","required":false,"description":"Overrides sizes. Sets to a specific width.","schema":{"type":"integer","description":"Overrides sizes. Sets to a specific width."}},{"name":"height","in":"query","required":false,"description":"Overrides sizes. Sets to a specific height.","schema":{"type":"integer","description":"Overrides sizes. Sets to a specific height."}},{"name":"page","in":"query","required":false,"description":"Page number to extract from a multi-page document (0 is the first page). Vaild for **.pdf** or **.doc** files.","schema":{"type":"integer","default":0,"description":"Page number to extract from a multi-page document (0 is the first page). Vaild for **.pdf** or **.doc** files."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/upload-file":{"post":{"operationId":"cloud_exavault_upload_file","summary":"Upload a file","description":"POST /resources/upload","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token","path","fileSize"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"offsetBytes":{"type":"integer","description":"Allows a file upload to resume at a certain number of bytes."},"path":{"type":"string","description":"Destination path for the file being uploaded, including the file name."},"fileSize":{"type":"integer","description":"File size, in bits, of the file being uploaded."},"resume":{"type":"boolean","default":"true","description":"True if upload resume is supported, false if it isn't."},"allowOverwrite":{"type":"boolean","default":"false","description":"True if a file with the same name is found in the designated path, should be overwritten. False if different file names should be generated."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-resource-info-by-id":{"get":{"operationId":"cloud_exavault_get_resource_info_by_id","summary":"Get resource metadata","description":"GET /resources/{id}","tags":["cloud"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID number of the resource","schema":{"type":"integer","description":"ID number of the resource"}},{"name":"ev-api-key","in":"query","required":true,"description":"API Key required to make the API call.","schema":{"type":"string","description":"API Key required to make the API call."}},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"},{"name":"include","in":"query","required":false,"description":"Comma separated list of relationships to include in response. Possible values are **share**, **notifications**, **directFile**,…","schema":{"type":"string","description":"Comma separated list of relationships to include in response. Possible values are **share**, **notifications**, **directFile**,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/update-resource-by-id":{"post":{"operationId":"cloud_exavault_update_resource_by_id","summary":"Rename a resource.","description":"PATCH /resources/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","ev-access-token","ev-api-key"],"properties":{"id":{"type":"integer","description":"ID number of the resource"},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"ev-api-key":{"type":"string","description":"API key required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/delete-resource-by-id":{"post":{"operationId":"cloud_exavault_delete_resource_by_id","summary":"Delete a Resource","description":"DELETE /resources/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","ev-api-key","ev-access-token"],"properties":{"id":{"type":"integer","description":"ID number of the resource"},"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/list-shares":{"get":{"operationId":"cloud_exavault_list_shares","summary":"Get a list of shares","description":"GET /shares","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API Key required to make the API call.","schema":{"type":"string","description":"API Key required to make the API call."},"example":"exampleaccount-zwSuWUZ8S38h33qPS8v0s"},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"},{"name":"offset","in":"query","required":false,"description":"Current offset of records (for pagination)","schema":{"type":"integer","description":"Current offset of records (for pagination)"},"example":100},{"name":"limit","in":"query","required":false,"description":"Limit of records to be returned (for pagination)","schema":{"type":"integer","default":100,"description":"Limit of records to be returned (for pagination)"},"example":10},{"name":"scope","in":"query","required":false,"description":"Set of shares to return. (**all**=all of them, **active**=shares that are currently active, **curentUser**=shares created by you)","schema":{"type":"string","enum":["all","active","currentUser"],"description":"Set of shares to return. (**all**=all of them, **active**=shares that are currently active, **curentUser**=shares created by you)"},"example":"active"},{"name":"sort","in":"query","required":false,"description":"What order the list of matches should be in.","schema":{"type":"string","enum":["created","-created"],"description":"What order the list of matches should be in."},"example":"created"},{"name":"type","in":"query","required":false,"description":"Limit the list of matches to only certain types of shares.","schema":{"type":"string","enum":["receive","shared_folder","send"],"description":"Limit the list of matches to only certain types of shares."},"example":"receive"},{"name":"include","in":"query","required":false,"description":"Comma separated list of relationships to include in response. Possible values are **owner**, **resources**, **notifications**, **activity**.","schema":{"type":"string","description":"Comma separated list of relationships to include in response. Possible values are **owner**, **resources**, **notifications**, **activity**."},"example":"owner,notifications"},{"name":"name","in":"query","required":false,"description":"When provided, only shares whose names include this value will be in the list. Supports wildcards, such as **send\\*** to return everything…","schema":{"type":"string","description":"When provided, only shares whose names include this value will be in the list. Supports wildcards, such as **send\\*** to return everything…"}},{"name":"recipient","in":"query","required":false,"description":"Filter the results to include only shares that invited a certain email address. Supports wildcard matching so that **\\*@example.com** will…","schema":{"type":"string","description":"Filter the results to include only shares that invited a certain email address. Supports wildcard matching so that **\\*@example.com** will…"}},{"name":"message","in":"query","required":false,"description":"When provided, only shares with a message that contains the text will be included in the list of matches. Both the subject and the body of…","schema":{"type":"string","description":"When provided, only shares with a message that contains the text will be included in the list of matches. Both the subject and the body of…"}},{"name":"username","in":"query","required":false,"description":"When provided, only shares created by the user with that `username` will be included in the list. Does not support wildcard searching.","schema":{"type":"string","description":"When provided, only shares created by the user with that `username` will be included in the list. Does not support wildcard searching."}},{"name":"search","in":"query","required":false,"description":"Searches the share name, username, recipients, share messages fields for the provided value. Supports wildcard searches.","schema":{"type":"string","description":"Searches the share name, username, recipients, share messages fields for the provided value. Supports wildcard searches."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/add-share":{"post":{"operationId":"cloud_exavault_add_share","summary":"Creates a share","description":"POST /shares","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token"],"properties":{"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/complete-direct-send":{"post":{"operationId":"cloud_exavault_complete_direct_send","summary":"Complete send files","description":"POST /shares/complete-send/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token","id"],"properties":{"ev-api-key":{"type":"string","description":"API Key"},"ev-access-token":{"type":"string","description":"Access Token"},"id":{"type":"integer","description":"ID of the share to trigger invitations for."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-share-by-id":{"get":{"operationId":"cloud_exavault_get_share_by_id","summary":"Get a share","description":"GET /shares/{id}","tags":["cloud"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of the share entry","schema":{"type":"integer","description":"ID of the share entry"}},{"name":"ev-api-key","in":"query","required":true,"description":"API Key","schema":{"type":"string","description":"API Key"}},{"name":"ev-access-token","in":"query","required":true,"description":"Access Token","schema":{"type":"string","description":"Access Token"}},{"name":"include","in":"query","required":false,"description":"Comma separated list of relationships to include in response. Possible values are **owner**, **resources**, **notifications**, **activity**.","schema":{"type":"string","description":"Comma separated list of relationships to include in response. Possible values are **owner**, **resources**, **notifications**, **activity**."},"example":"owner,notifications"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/update-share-by-id":{"post":{"operationId":"cloud_exavault_update_share_by_id","summary":"Update a share","description":"PATCH /shares/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","ev-api-key","ev-access-token","body"],"properties":{"id":{"type":"integer","description":"ID of the share entry"},"ev-api-key":{"type":"string","description":"API Key"},"ev-access-token":{"type":"string","description":"Access Token"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/delete-share-by-id":{"post":{"operationId":"cloud_exavault_delete_share_by_id","summary":"Deactivate a share","description":"DELETE /shares/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","ev-api-key","ev-access-token"],"properties":{"id":{"type":"integer","description":"ID of the share entry"},"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-sshkeys-list":{"get":{"operationId":"cloud_exavault_get_sshkeys_list","summary":"Get metadata for a list of SSH Keys","description":"GET /ssh-keys","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API key required to make the API call.","schema":{"type":"string","description":"API key required to make the API call."}},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"},{"name":"userId","in":"query","required":false,"description":"Only return results for the given user ID. This is not the username, but the numeric ID of the user.","schema":{"type":"string","description":"Only return results for the given user ID. This is not the username, but the numeric ID of the user."}},{"name":"limit","in":"query","required":false,"description":"Limits the results by the given number. Cannot be set higher than 100.","schema":{"type":"integer","description":"Limits the results by the given number. Cannot be set higher than 100."}},{"name":"offset","in":"query","required":false,"description":"Determines which item to start on for pagination. Use zero (0) to start at the beginning of the list.","schema":{"type":"integer","description":"Determines which item to start on for pagination. Use zero (0) to start at the beginning of the list."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/add-sshkey":{"post":{"operationId":"cloud_exavault_add_sshkey","summary":"Create a new SSH Key","description":"POST /ssh-keys","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token"],"properties":{"ev-api-key":{"type":"string","description":"API key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-sshkey":{"get":{"operationId":"cloud_exavault_get_sshkey","summary":"Get metadata for an SSH Key","description":"GET /ssh-keys/{id}","tags":["cloud"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}},{"name":"ev-api-key","in":"query","required":true,"description":"API key required to make the API call.","schema":{"type":"string","description":"API key required to make the API call."}},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/delete-sshkey":{"post":{"operationId":"cloud_exavault_delete_sshkey","summary":"Delete an SSH Key","description":"DELETE /ssh-keys/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","ev-api-key","ev-access-token"],"properties":{"id":{"type":"string"},"ev-api-key":{"type":"string","description":"API key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/list-users":{"get":{"operationId":"cloud_exavault_list_users","summary":"Get a list of users","description":"GET /users","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API key required to make the API call.","schema":{"type":"string","description":"API key required to make the API call."}},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"},{"name":"username","in":"query","required":false,"description":"The username of the user you are looking for. Only entries with the same username as this will be in the list of results. Does not support…","schema":{"type":"string","description":"The username of the user you are looking for. Only entries with the same username as this will be in the list of results. Does not support…"},"example":"testuser"},{"name":"homeResource","in":"query","required":false,"description":"Resource identifier for user's home directory. Does not support wildcard searches.","schema":{"type":"string","description":"Resource identifier for user's home directory. Does not support wildcard searches."}},{"name":"nickname","in":"query","required":false,"description":"Nickname to search for. Ignored if `username` is provided. Supports wildcard searches.","schema":{"type":"string","description":"Nickname to search for. Ignored if `username` is provided. Supports wildcard searches."}},{"name":"email","in":"query","required":false,"description":"Email to search for. Ignored if `username` is provided. Supports wildcard searches","schema":{"type":"string","description":"Email to search for. Ignored if `username` is provided. Supports wildcard searches"}},{"name":"role","in":"query","required":false,"description":"Types of users to include the list. Ignored if `username` is provided. Valid options are **admin**, **master** and **user**","schema":{"type":"string","description":"Types of users to include the list. Ignored if `username` is provided. Valid options are **admin**, **master** and **user**"}},{"name":"status","in":"query","required":false,"description":"Whether a user is locked. Ignored if `username` is provided. **0** means user is locked, **1** means user is not locked.","schema":{"type":"integer","description":"Whether a user is locked. Ignored if `username` is provided. **0** means user is locked, **1** means user is not locked."}},{"name":"search","in":"query","required":false,"description":"Searches the nickname, email, role and homeDir fields for the provided value. Ignored if `username` is provided. Supports wildcard searches.","schema":{"type":"string","description":"Searches the nickname, email, role and homeDir fields for the provided value. Ignored if `username` is provided. Supports wildcard searches."}},{"name":"offset","in":"query","required":false,"description":"Starting user record in the result set. Can be used for pagination.","schema":{"type":"integer","description":"Starting user record in the result set. Can be used for pagination."},"example":50},{"name":"sort","in":"query","required":false,"description":"Sort order or matching users. You can sort by multiple columns by separating sort options with a comma; the sort will be applied in the…","schema":{"type":"string","description":"Sort order or matching users. You can sort by multiple columns by separating sort options with a comma; the sort will be applied in the…"}},{"name":"limit","in":"query","required":false,"description":"Number of users to return. Can be used for pagination.","schema":{"type":"integer","description":"Number of users to return. Can be used for pagination."},"example":100},{"name":"include","in":"query","required":false,"description":"Comma separated list of relationships to include in response. Valid options are **homeResource** and **ownerAccount**.","schema":{"type":"string","description":"Comma separated list of relationships to include in response. Valid options are **homeResource** and **ownerAccount**."},"example":"homeResource,ownerAccount"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/add-user":{"post":{"operationId":"cloud_exavault_add_user","summary":"Create a user","description":"POST /users","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token"],"properties":{"ev-api-key":{"type":"string","description":"API key required to make the API call"},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-user-by-id":{"get":{"operationId":"cloud_exavault_get_user_by_id","summary":"Get info for a user","description":"GET /users/{id}","tags":["cloud"],"parameters":[{"name":"id","in":"query","required":true,"description":"The user's ID. Note that this is our internal ID, and _not the username_. You can obtain it by calling the [GET…","schema":{"type":"integer","description":"The user's ID. Note that this is our internal ID, and _not the username_. You can obtain it by calling the [GET…"}},{"name":"ev-api-key","in":"query","required":true,"description":"API Key","schema":{"type":"string","description":"API Key"}},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"},{"name":"include","in":"query","required":false,"description":"Comma-separated list of relationships to include in response. Possible values include **homeResource** and **ownerAccount**.","schema":{"type":"string","description":"Comma-separated list of relationships to include in response. Possible values include **homeResource** and **ownerAccount**."},"example":"homeResource,owneraccount"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/update-user":{"post":{"operationId":"cloud_exavault_update_user","summary":"Update a user","description":"PATCH /users/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","ev-api-key","ev-access-token"],"properties":{"id":{"type":"integer","description":"The user's ID. Note that this is our internal ID, and _not the username_. You can obtain it by calling the [GET…"},"ev-api-key":{"type":"string","description":"API key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/delete-user":{"post":{"operationId":"cloud_exavault_delete_user","summary":"Delete a user","description":"DELETE /users/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","ev-api-key","ev-access-token"],"properties":{"id":{"type":"integer","description":"The user's ID. Note that this is our internal ID, and _not the username_. You can obtain it by calling the [GET…"},"ev-api-key":{"type":"string","description":"API Key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-wehooks-list":{"get":{"operationId":"cloud_exavault_get_wehooks_list","summary":"Get Webhooks List","description":"GET /webhooks","tags":["cloud"],"parameters":[{"name":"ev-api-key","in":"query","required":true,"description":"API key required to make the API call.","schema":{"type":"string","description":"API key required to make the API call."}},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"},{"name":"include","in":"query","required":false,"description":"List of related record types to include. Valid options are `owningAccount` and `resource`","schema":{"type":"string","description":"List of related record types to include. Valid options are `owningAccount` and `resource`"}},{"name":"offset","in":"query","required":false,"description":"Records to skip before returning results.","schema":{"type":"integer","description":"Records to skip before returning results."},"example":100},{"name":"limit","in":"query","required":false,"description":"Limit of the records list","schema":{"type":"integer","description":"Limit of the records list"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/add-webhook":{"post":{"operationId":"cloud_exavault_add_webhook","summary":"Add A New Webhook","description":"POST /webhooks","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ev-api-key","ev-access-token"],"properties":{"ev-api-key":{"type":"string","description":"API key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/regenerate-webhook-token":{"post":{"operationId":"cloud_exavault_regenerate_webhook_token","summary":"Regenerate security token","description":"POST /webhooks/regenerate-token/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","ev-api-key","ev-access-token"],"properties":{"id":{"type":"string","description":"Webhook ID"},"ev-api-key":{"type":"string","description":"API key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/resend-webhook-activity-entry":{"post":{"operationId":"cloud_exavault_resend_webhook_activity_entry","summary":"Resend a webhook message","description":"POST /webhooks/resend/{activityId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["activityId","ev-api-key","ev-access-token"],"properties":{"activityId":{"type":"string","description":"Webhooks activity entry ID"},"ev-api-key":{"type":"string","description":"API key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/get-webhook-by-id":{"get":{"operationId":"cloud_exavault_get_webhook_by_id","summary":"Get info for a webhook","description":"GET /webhooks/{id}","tags":["cloud"],"parameters":[{"name":"id","in":"query","required":true,"description":"Webhook endpoint ID","schema":{"type":"integer","description":"Webhook endpoint ID"}},{"name":"ev-api-key","in":"query","required":true,"description":"API key required to make the API call.","schema":{"type":"string","description":"API key required to make the API call."}},{"name":"ev-access-token","in":"query","required":true,"description":"Access token required to make the API call.","schema":{"type":"string","description":"Access token required to make the API call."},"example":"5dc97cc607985eb8da033220e7447647e7915fbf73808"},{"name":"include","in":"query","required":false,"description":"Include metadata for related items; `ownerAccount` and/or `resource`","schema":{"type":"string","description":"Include metadata for related items; `ownerAccount` and/or `resource`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/cloud:exavault/update-webhook":{"post":{"operationId":"cloud_exavault_update_webhook","summary":"Update a webhook","description":"PATCH /webhooks/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","ev-api-key","ev-access-token"],"properties":{"id":{"type":"integer","description":"Webhook endpoint ID"},"ev-api-key":{"type":"string","description":"API key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/cloud:exavault/delete-webhook":{"post":{"operationId":"cloud_exavault_delete_webhook","summary":"Delete a webhook","description":"DELETE /webhooks/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","ev-api-key","ev-access-token"],"properties":{"id":{"type":"integer","description":"Webhook endpoint ID"},"ev-api-key":{"type":"string","description":"API key required to make the API call."},"ev-access-token":{"type":"string","description":"Access token required to make the API call."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}