openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 745 kB
JSON
{"openapi":"3.0.0","servers":[{"url":"//app.files.com/api/rest/v1"}],"info":{"contact":{"email":"support@files.com","name":"Files.com Customer Success Team"},"title":"Files.com API","version":"0.0.1","x-apisguru-categories":["developer_tools"],"x-origin":[{"format":"openapi","url":"https://app.files.com/api/rest/v1/swagger_doc.json","version":"3.0"}],"x-providerName":"files.com"},"tags":[{"description":"Operations about action_notification_exports","name":"action_notification_exports"},{"description":"Operations about action_notification_export_results","name":"action_notification_export_results"},{"description":"Operations about action_webhook_failures","name":"action_webhook_failures"},{"description":"Operations about api_keys","name":"api_key"},{"description":"Operations about api_keys","name":"api_keys"},{"description":"Operations about sites","name":"site"},{"description":"Operations about users","name":"user"},{"description":"Operations about users","name":"users"},{"description":"Operations about apps","name":"apps"},{"description":"Operations about as2_incoming_messages","name":"as2_incoming_messages"},{"description":"Operations about as2_outgoing_messages","name":"as2_outgoing_messages"},{"description":"Operations about as2_partners","name":"as2_partners"},{"description":"Operations about as2_stations","name":"as2_stations"},{"description":"Operations about automations","name":"automations"},{"description":"Operations about automation_runs","name":"automation_runs"},{"description":"Operations about bandwidth_snapshots","name":"bandwidth_snapshots"},{"description":"Operations about behaviors","name":"behaviors"},{"description":"Operations about bundles","name":"bundles"},{"description":"Operations about bundle_downloads","name":"bundle_downloads"},{"description":"Operations about bundle_notifications","name":"bundle_notifications"},{"description":"Operations about bundle_recipients","name":"bundle_recipients"},{"description":"Operations about bundle_registrations","name":"bundle_registrations"},{"description":"Operations about clickwraps","name":"clickwraps"},{"description":"Operations about dns_records","name":"dns_records"},{"description":"Operations about external_events","name":"external_events"},{"description":"Operations about files","name":"files"},{"description":"Operations about file_actions","name":"file_actions"},{"description":"Operations about file_comments","name":"file_comments"},{"description":"Operations about file_comment_reactions","name":"file_comment_reactions"},{"description":"Operations about file_migrations","name":"file_migrations"},{"description":"Operations about folders","name":"folders"},{"description":"Operations about form_field_sets","name":"form_field_sets"},{"description":"Operations about groups","name":"groups"},{"description":"Operations about group_users","name":"group_users"},{"description":"Operations about histories","name":"history"},{"description":"Operations about history_exports","name":"history_exports"},{"description":"Operations about history_export_results","name":"history_export_results"},{"description":"Operations about inbox_recipients","name":"inbox_recipients"},{"description":"Operations about inbox_registrations","name":"inbox_registrations"},{"description":"Operations about inbox_uploads","name":"inbox_uploads"},{"description":"Operations about invoices","name":"invoices"},{"description":"Operations about ip_addresses","name":"ip_addresses"},{"description":"Operations about locks","name":"locks"},{"description":"Operations about messages","name":"messages"},{"description":"Operations about message_comments","name":"message_comments"},{"description":"Operations about message_comment_reactions","name":"message_comment_reactions"},{"description":"Operations about message_reactions","name":"message_reactions"},{"description":"Operations about notifications","name":"notifications"},{"description":"Operations about payments","name":"payments"},{"description":"Operations about permissions","name":"permissions"},{"description":"Operations about priorities","name":"priorities"},{"description":"Operations about projects","name":"projects"},{"description":"Operations about public_keys","name":"public_keys"},{"description":"Operations about remote_bandwidth_snapshots","name":"remote_bandwidth_snapshots"},{"description":"Operations about remote_servers","name":"remote_servers"},{"description":"Operations about requests","name":"requests"},{"description":"Operations about sessions","name":"sessions"},{"description":"Operations about settings_changes","name":"settings_changes"},{"description":"Operations about sftp_host_keys","name":"sftp_host_keys"},{"description":"Operations about sso_strategies","name":"sso_strategies"},{"description":"Operations about styles","name":"styles"},{"description":"Operations about usage_snapshots","name":"usage_snapshots"},{"description":"Operations about usage_daily_snapshots","name":"usage_daily_snapshots"},{"description":"Operations about user_cipher_uses","name":"user_cipher_uses"},{"description":"Operations about user_requests","name":"user_requests"},{"description":"Operations about webhook_tests","name":"webhook_tests"}],"paths":{"/action_notification_export_results":{"get":{"description":"List Action Notification Export Results","operationId":"GetActionNotificationExportResults","parameters":[{"description":"User ID. Provide a value of `0` to operate the current session's user.","in":"query","name":"user_id","required":false,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"User ID. Provide a value of `0` to operate the current session's user."},{"description":"Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.","in":"query","name":"cursor","required":false,"schema":{"type":"string"},"x-ms-summary":"Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination."},{"description":"Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).","in":"query","name":"per_page","required":false,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"Number of records to show per page. (Max: 10,000, 1,000 or less is recommended)."},{"description":"ID of the associated action notification export.","in":"query","name":"action_notification_export_id","required":true,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"ID of the associated action notification export."}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ActionNotificationExportResultEntity"},"type":"array"}}},"description":"A list of ActionNotificationExportResults objects.","x-ms-summary":"A list of ActionNotificationExportResults objects."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"List Action Notification Export Results","tags":["action_notification_export_results"],"x-authentication":["folder_admin"]}},"/action_notification_exports":{"post":{"description":"Create Action Notification Export","operationId":"PostActionNotificationExports","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"end_at":{"description":"End date/time of export range.","example":"2025-06-15T13:48:58.050Z","format":"date-time","type":"string","x-ms-summary":"End date/time of export range."},"query_folder":{"description":"Return notifications that were triggered by actions in this folder.","example":"MyFolder","type":"string","x-ms-summary":"Return notifications that were triggered by actions in this folder."},"query_message":{"description":"Error message associated with the request, if any.","example":"Connection Refused","type":"string","x-ms-summary":"Error message associated with the request, if any."},"query_path":{"description":"Return notifications that were triggered by actions on this specific path.","example":"MyFile.txt","type":"string","x-ms-summary":"Return notifications that were triggered by actions on this specific path."},"query_request_method":{"description":"The HTTP request method used by the webhook.","example":"GET","type":"string","x-ms-summary":"The HTTP request method used by the webhook."},"query_request_url":{"description":"The target webhook URL.","example":"http://example.com/webhook","type":"string","x-ms-summary":"The target webhook URL."},"query_status":{"description":"The HTTP status returned from the server in response to the webhook request.","example":"200","type":"string","x-ms-summary":"The HTTP status returned from the server in response to the webhook request."},"query_success":{"description":"true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.","example":true,"type":"boolean","x-ms-summary":"true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise."},"start_at":{"description":"Start date/time of export range.","example":"2025-06-15T13:48:58.051Z","format":"date-time","type":"string","x-ms-summary":"Start date/time of export range."},"user_id":{"description":"User ID. Provide a value of `0` to operate the current session's user.","format":"int32","type":"integer","x-ms-summary":"User ID. Provide a value of `0` to operate the current session's user."}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionNotificationExportEntity"}}},"description":"The ActionNotificationExports object.","x-ms-summary":"The ActionNotificationExports object."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"Create Action Notification Export","tags":["action_notification_exports"],"x-authentication":["folder_admin",{"path_params":["query_path","query_folder"]}]}},"/action_notification_exports/{id}":{"get":{"description":"Show Action Notification Export","operationId":"GetActionNotificationExportsId","parameters":[{"description":"Action Notification Export ID.","in":"path","name":"id","required":true,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"Action Notification Export ID."}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionNotificationExportEntity"}}},"description":"The ActionNotificationExports object.","x-ms-summary":"The ActionNotificationExports object."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"Show Action Notification Export","tags":["action_notification_exports"],"x-authentication":["folder_admin"]}},"/action_webhook_failures/{id}/retry":{"post":{"description":"retry Action Webhook Failure","operationId":"PostActionWebhookFailuresIdRetry","parameters":[{"description":"Action Webhook Failure ID.","in":"path","name":"id","required":true,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"Action Webhook Failure ID."}],"responses":{"201":{"description":"The ActionWebhookFailures object.","x-ms-summary":"The ActionWebhookFailures object."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"retry Action Webhook Failure","tags":["action_webhook_failures"],"x-authentication":["site"]}},"/api_key":{"delete":{"description":"Delete current API key. (Requires current API connection to be using an API key.)","operationId":"ApiKeyDeleteCurrent","responses":{"204":{"description":"No body.","x-ms-summary":"No body."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"Delete current API key. (Requires current API connection to be using an API key.)","tags":["api_key"],"x-authentication":["native_app","office_integration"]},"get":{"description":"Show information about current API key. (Requires current API connection to be using an API key.)","operationId":"ApiKeyFindCurrent","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyEntity"}}},"description":"The ApiKey object.","x-ms-summary":"The ApiKey object."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"Show information about current API key. (Requires current API connection to be using an API key.)","tags":["api_key"],"x-authentication":["native_app","office_integration"]},"patch":{"description":"Update current API key. (Requires current API connection to be using an API key.)","operationId":"ApiKeyUpdateCurrent","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"expires_at":{"description":"API Key expiration date","example":"2025-06-15T13:48:58.051Z","format":"date-time","type":"string","x-ms-summary":"API Key expiration date"},"name":{"description":"Internal name for the API Key. For your use.","example":"My Main API Key","type":"string","x-ms-summary":"Internal name for the API Key. For your use."},"permission_set":{"description":"Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.","enum":["none","full","desktop_app","sync_app","office_integration","mobile_app"],"example":"full","type":"string","x-ms-summary":"Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know."}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyEntity"}}},"description":"The ApiKey object.","x-ms-summary":"The ApiKey object."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"Update current API key. (Requires current API connection to be using an API key.)","tags":["api_key"],"x-authentication":["native_app","office_integration"]}},"/api_keys":{"get":{"description":"List Api Keys","operationId":"GetApiKeys","parameters":[{"description":"User ID. Provide a value of `0` to operate the current session's user.","in":"query","name":"user_id","required":false,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"User ID. Provide a value of `0` to operate the current session's user."},{"description":"Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.","in":"query","name":"cursor","required":false,"schema":{"type":"string"},"x-ms-summary":"Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination."},{"description":"Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).","in":"query","name":"per_page","required":false,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"Number of records to show per page. (Max: 10,000, 1,000 or less is recommended)."},{"description":"If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[expires_at]=desc`). Valid fields are `expires_at`.","in":"query","name":"sort_by","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[expires_at]=desc`). Valid fields are `expires_at`."},{"description":"If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.","in":"query","name":"filter","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`."},{"description":"If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.","in":"query","name":"filter_gt","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`."},{"description":"If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `expires_at`.","in":"query","name":"filter_gteq","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `expires_at`."},{"description":"If set, return records where the specified field is less than the supplied value. Valid fields are `expires_at`.","in":"query","name":"filter_lt","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is less than the supplied value. Valid fields are `expires_at`."},{"description":"If set, return records where the specified field is less than or equal the supplied value. Valid fields are `expires_at`.","in":"query","name":"filter_lteq","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is less than or equal the supplied value. Valid fields are `expires_at`."}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ApiKeyEntity"},"type":"array"}}},"description":"A list of ApiKeys objects.","x-ms-summary":"A list of ApiKeys objects."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"List Api Keys","tags":["api_keys"],"x-authentication":["self_managed"],"x-path_aliases":["site/api_keys","user/api_keys","users/:user_id/api_keys"]},"post":{"description":"Create Api Key","operationId":"PostApiKeys","requestBody":{"$ref":"#/components/requestBodies/PostApiKeys"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyEntity"}}},"description":"The ApiKeys object.","x-ms-summary":"The ApiKeys object."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"Create Api Key","tags":["api_keys"],"x-authentication":[],"x-path_aliases":["site/api_keys","user/api_keys","users/:user_id/api_keys"]}},"/api_keys/{id}":{"delete":{"description":"Delete Api Key","operationId":"DeleteApiKeysId","parameters":[{"description":"Api Key ID.","in":"path","name":"id","required":true,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"Api Key ID."}],"responses":{"204":{"description":"No body.","x-ms-summary":"No body."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"Delete Api Key","tags":["api_keys"],"x-authentication":["self_managed"]},"get":{"description":"Show Api Key","operationId":"GetApiKeysId","parameters":[{"description":"Api Key ID.","in":"path","name":"id","required":true,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"Api Key ID."}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyEntity"}}},"description":"The ApiKeys object.","x-ms-summary":"The ApiKeys object."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"Show Api Key","tags":["api_keys"],"x-authentication":["self_managed"]},"patch":{"description":"Update Api Key","operationId":"PatchApiKeysId","parameters":[{"description":"Api Key ID.","in":"path","name":"id","required":true,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"Api Key ID."}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"description":{"description":"User-supplied description of API key.","example":"example","type":"string","x-ms-summary":"User-supplied description of API key."},"expires_at":{"description":"API Key expiration date","example":"2025-06-15T13:48:58.051Z","format":"date-time","type":"string","x-ms-summary":"API Key expiration date"},"name":{"description":"Internal name for the API Key. For your use.","example":"My Main API Key","type":"string","x-ms-summary":"Internal name for the API Key. For your use."},"permission_set":{"description":"Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.","enum":["none","full","desktop_app","sync_app","office_integration","mobile_app"],"example":"full","type":"string","x-ms-summary":"Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know."}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyEntity"}}},"description":"The ApiKeys object.","x-ms-summary":"The ApiKeys object."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"Update Api Key","tags":["api_keys"],"x-authentication":["self_managed"]}},"/apps":{"get":{"description":"List Apps","operationId":"GetApps","parameters":[{"description":"Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.","in":"query","name":"cursor","required":false,"schema":{"type":"string"},"x-ms-summary":"Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination."},{"description":"Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).","in":"query","name":"per_page","required":false,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"Number of records to show per page. (Max: 10,000, 1,000 or less is recommended)."},{"description":"If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[name]=desc`). Valid fields are `name` and `app_type`.","in":"query","name":"sort_by","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[name]=desc`). Valid fields are `name` and `app_type`."},{"description":"If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.","in":"query","name":"filter","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`."},{"description":"If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.","in":"query","name":"filter_prefix","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`."}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AppEntity"},"type":"array"}}},"description":"A list of Apps objects.","x-ms-summary":"A list of Apps objects."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"List Apps","tags":["apps"],"x-authentication":["none"]}},"/as2_incoming_messages":{"get":{"description":"List As2 Incoming Messages","operationId":"GetAs2IncomingMessages","parameters":[{"description":"Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.","in":"query","name":"cursor","required":false,"schema":{"type":"string"},"x-ms-summary":"Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination."},{"description":"Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).","in":"query","name":"per_page","required":false,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"Number of records to show per page. (Max: 10,000, 1,000 or less is recommended)."},{"description":"If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at` and `as2_partner_id`.","in":"query","name":"sort_by","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at` and `as2_partner_id`."},{"description":"If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.","in":"query","name":"filter","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`."},{"description":"If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.","in":"query","name":"filter_gt","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`."},{"description":"If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.","in":"query","name":"filter_gteq","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`."},{"description":"If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.","in":"query","name":"filter_lt","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`."},{"description":"If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.","in":"query","name":"filter_lteq","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`."},{"description":"As2 Partner ID. If provided, will return message specific to that partner.","in":"query","name":"as2_partner_id","required":false,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"As2 Partner ID. If provided, will return message specific to that partner."}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/As2IncomingMessageEntity"},"type":"array"}}},"description":"A list of As2IncomingMessages objects.","x-ms-summary":"A list of As2IncomingMessages objects."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"List As2 Incoming Messages","tags":["as2_incoming_messages"],"x-authentication":["site"]}},"/as2_outgoing_messages":{"get":{"description":"List As2 Outgoing Messages","operationId":"GetAs2OutgoingMessages","parameters":[{"description":"Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.","in":"query","name":"cursor","required":false,"schema":{"type":"string"},"x-ms-summary":"Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination."},{"description":"Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).","in":"query","name":"per_page","required":false,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"Number of records to show per page. (Max: 10,000, 1,000 or less is recommended)."},{"description":"If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at` and `as2_partner_id`.","in":"query","name":"sort_by","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at` and `as2_partner_id`."},{"description":"If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.","in":"query","name":"filter","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`."},{"description":"If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.","in":"query","name":"filter_gt","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`."},{"description":"If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.","in":"query","name":"filter_gteq","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`."},{"description":"If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.","in":"query","name":"filter_lt","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`."},{"description":"If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.","in":"query","name":"filter_lteq","required":false,"schema":{"type":"object"},"x-ms-summary":"If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`."},{"description":"As2 Partner ID. If provided, will return message specific to that partner.","in":"query","name":"as2_partner_id","required":false,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"As2 Partner ID. If provided, will return message specific to that partner."}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/As2OutgoingMessageEntity"},"type":"array"}}},"description":"A list of As2OutgoingMessages objects.","x-ms-summary":"A list of As2OutgoingMessages objects."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"List As2 Outgoing Messages","tags":["as2_outgoing_messages"],"x-authentication":["site"]}},"/as2_partners":{"get":{"description":"List As2 Partners","operationId":"GetAs2Partners","parameters":[{"description":"Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.","in":"query","name":"cursor","required":false,"schema":{"type":"string"},"x-ms-summary":"Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination."},{"description":"Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).","in":"query","name":"per_page","required":false,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"Number of records to show per page. (Max: 10,000, 1,000 or less is recommended)."}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/As2PartnerEntity"},"type":"array"}}},"description":"A list of As2Partners objects.","x-ms-summary":"A list of As2Partners objects."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"List As2 Partners","tags":["as2_partners"],"x-authentication":["site"]},"post":{"description":"Create As2 Partner","operationId":"PostAs2Partners","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"as2_station_id":{"description":"Id of As2Station for this partner","format":"int32","type":"integer","x-ms-summary":"Id of As2Station for this partner"},"enable_dedicated_ips":{"type":"boolean","x-ms-summary":null},"name":{"description":"AS2 Name","type":"string","x-ms-summary":"AS2 Name"},"public_certificate":{"type":"string","x-ms-summary":null},"server_certificate":{"description":"Remote server certificate security setting","type":"string","x-ms-summary":"Remote server certificate security setting"},"uri":{"description":"URL base for AS2 responses","type":"string","x-ms-summary":"URL base for AS2 responses"}},"required":["name","uri","public_certificate","as2_station_id"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/As2PartnerEntity"}}},"description":"The As2Partners object.","x-ms-summary":"The As2Partners object."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"Create As2 Partner","tags":["as2_partners"],"x-authentication":["site"]}},"/as2_partners/{id}":{"delete":{"description":"Delete As2 Partner","operationId":"DeleteAs2PartnersId","parameters":[{"description":"As2 Partner ID.","in":"path","name":"id","required":true,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"As2 Partner ID."}],"responses":{"204":{"description":"No body.","x-ms-summary":"No body."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"Delete As2 Partner","tags":["as2_partners"],"x-authentication":["site"]},"get":{"description":"Show As2 Partner","operationId":"GetAs2PartnersId","parameters":[{"description":"As2 Partner ID.","in":"path","name":"id","required":true,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"As2 Partner ID."}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/As2PartnerEntity"}}},"description":"The As2Partners object.","x-ms-summary":"The As2Partners object."},"400":{"description":"Bad Request","x-ms-summary":"Bad Request"},"401":{"description":"Unauthorized","x-ms-summary":"Unauthorized"},"403":{"description":"Forbidden","x-ms-summary":"Forbidden"},"404":{"description":"Not Found","x-ms-summary":"Not Found"},"405":{"description":"Method Not Allowed","x-ms-summary":"Method Not Allowed"},"409":{"description":"Conflict","x-ms-summary":"Conflict"},"412":{"description":"Precondition Failed","x-ms-summary":"Precondition Failed"},"422":{"description":"Unprocessable Entity","x-ms-summary":"Unprocessable Entity"},"423":{"description":"Locked","x-ms-summary":"Locked"},"429":{"description":"Too Many Requests","x-ms-summary":"Too Many Requests"}},"summary":"Show As2 Partner","tags":["as2_partners"],"x-authentication":["site"]},"patch":{"description":"Update As2 Partner","operationId":"PatchAs2PartnersId","parameters":[{"description":"As2 Partner ID.","in":"path","name":"id","required":true,"schema":{"format":"int32","type":"integer"},"x-ms-summary":"As2 Partner ID."}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"enable_dedicated_ips":{"type":"boolean","x-ms-summary":null},"name":{"description":"AS2 Name","type":"string","x-ms-summary":"AS2 Name"},"public_certificate":{"type":"string","x-ms-summary":null},"server_certificate":{"description":"Remote server certificate security setting","type":"string","x-ms-summary":"Remote server certificate security setting"},"uri":{"description":"URL base for AS2 responses","type":"string","x-ms-summary":"URL base for AS2 responses"}},"type":"object"}}}},"responses":{"2