You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: openapi.json
+68-4Lines changed: 68 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -37752,279 +37752,343 @@
37752
37752
"tags": [
37753
37753
{
37754
37754
"name": "Authorization",
37755
+
"description": "A set of endpoints used to\nmanage user authorization process.",
37755
37756
"x-box-tag": "authorization",
37756
37757
"x-box-priority": true
37757
37758
},
37758
37759
{
37759
37760
"name": "Sign requests",
37761
+
"description": "Sign requests are used\nto submit a file for\nsignature.",
37760
37762
"x-box-tag": "sign_requests"
37761
37763
},
37762
37764
{
37763
37765
"name": "Classifications",
37766
+
"description": "Classification labels are\nused for content that is\nsensitive or under security\nrestrictions.",
37764
37767
"x-box-tag": "classifications"
37765
37768
},
37766
37769
{
37767
37770
"name": "Classifications on files",
37771
+
"description": "Classification labels are\nused for files that are\nsensitive or under security\nrestrictions.",
37768
37772
"x-box-tag": "file_classifications"
37769
37773
},
37770
37774
{
37771
37775
"name": "Classifications on folders",
37776
+
"description": "Classification labels are\nused for folders that are\nsensitive or under security\nrestrictions.",
37772
37777
"x-box-tag": "folder_classifications"
37773
37778
},
37774
37779
{
37775
37780
"name": "Collaborations",
37781
+
"description": "Collaborations define access permissions\nfor users and groups to files and folders,\nsimilar to access control lists.",
37776
37782
"x-box-tag": "user_collaborations"
37777
37783
},
37778
37784
{
37779
37785
"name": "Collaborations (List)",
37786
+
"description": "A set of endpoints used to\nretrieve file, folder,\npending, and group collaborations.",
37780
37787
"x-box-tag": "list_collaborations"
37781
37788
},
37782
37789
{
37783
37790
"name": "Collections",
37791
+
"description": "Collections are a way to group files,\nfolders, and web links without putting them\nall into a folder.",
37784
37792
"x-box-tag": "collections"
37785
37793
},
37786
37794
{
37787
37795
"name": "Comments",
37796
+
"description": "Comments are messages generated by users on files,\nallowing users to collaborate on a file,\ndiscussing any feedback they might\nhave on the content.",
37788
37797
"x-box-tag": "comments"
37789
37798
},
37790
37799
{
37791
37800
"name": "Device pinners",
37801
+
"description": "Device pinners allow enterprises to\ncontrol what devices can use\nnative Box applications.",
37792
37802
"x-box-tag": "device_pinners"
37793
37803
},
37794
37804
{
37795
37805
"name": "Domain restrictions (User exemptions)",
37806
+
"description": "A set of endpoints that allow exempting users\nfrom restrictions imposed by the list of\nallowed collaboration domains for a specific enterprise.",
"description": "A set of endpoints that manage domains for which users\ncan collaborate with files and folders in an enterprise.",
37800
37812
"x-box-tag": "collaboration_allowlist_entries"
37801
37813
},
37802
37814
{
37803
37815
"name": "Downloads",
37816
+
"description": "Downloads allow saving files to the application's server,\nor directly by the end user in a browser.",
37804
37817
"x-box-tag": "downloads"
37805
37818
},
37806
37819
{
37807
37820
"name": "Email aliases",
37821
+
"description": "Email aliases provide a list of emails additional\nto the user's primary login email.",
37808
37822
"x-box-tag": "email_aliases"
37809
37823
},
37810
37824
{
37811
37825
"name": "Events",
37826
+
"description": "Events provide a way for an\napplication to subscribe to\nany actions performed by\nany user, users, or service in an enterprise.",
37812
37827
"x-box-tag": "events"
37813
37828
},
37814
37829
{
37815
37830
"name": "File requests",
37831
+
"description": "File Requests provide a fast and\nsecure way to request files and associated metadata\nfrom anyone.\nUsers can create new file requests\nbased on an existing file request,\nupdate file request settings, activate, deactivate, and delete\nfile requests programmatically.",
37816
37832
"x-box-tag": "file_requests"
37817
37833
},
37818
37834
{
37819
37835
"name": "File version legal holds",
37836
+
"description": "A legal hold is a process that an enterprise\ncan use to preserve all forms of potentially relevant\ninformation when\nlitigation is pending or reasonably anticipated.\nA File Version Legal Hold represents all the policies that\nare assigned to a specific file version.",
37820
37837
"x-box-tag": "file_version_legal_holds"
37821
37838
},
37822
37839
{
37823
37840
"name": "File version retentions",
37841
+
"description": "A retention policy blocks permanent\ndeletion of content for a specified amount of time.\nA file version retention is a record for a retained file.",
37824
37842
"x-box-tag": "file_version_retentions"
37825
37843
},
37826
37844
{
37827
37845
"name": "File versions",
37846
+
"description": "A set of endpoints used to manage specific\nversions of a file.",
37828
37847
"x-box-tag": "file_versions"
37829
37848
},
37830
37849
{
37831
37850
"name": "Files",
37851
+
"description": "Files, together with Folders,\nare at the core of the Box API.\nFiles can be uploaded and downloaded,\nas well as hold important metadata\ninformation about the content.",
37832
37852
"x-box-tag": "files"
37833
37853
},
37834
37854
{
37835
37855
"name": "Folder Locks",
37856
+
"description": "Folder locks define access restrictions\nplaced by folder owners to prevent\nspecific folders from being moved or deleted.",
37836
37857
"x-box-tag": "folder_locks"
37837
37858
},
37838
37859
{
37839
37860
"name": "Folders",
37861
+
"description": "Folders, together with Files,\nare at the core of the Box API.\nFolders can be uploaded and downloaded,\nas well as hold important metadata\ninformation about the content.",
37840
37862
"x-box-tag": "folders"
37841
37863
},
37842
37864
{
37843
37865
"name": "Integration mappings",
37866
+
"description": "Integration Mappings allow the users\nto manage where content from partner apps is stored in Box.",
37844
37867
"x-box-tag": "integration_mappings"
37845
37868
},
37846
37869
{
37847
37870
"name": "Group memberships",
37871
+
"description": "Group memberships signify that\na user is a part of the group.",
37848
37872
"x-box-tag": "memberships"
37849
37873
},
37850
37874
{
37851
37875
"name": "Groups",
37876
+
"description": "Groups created in an enterprise.",
37852
37877
"x-box-tag": "groups"
37853
37878
},
37854
37879
{
37855
37880
"name": "Invites",
37881
+
"description": "Invites are used to invite the user to\nan enterprise.",
37856
37882
"x-box-tag": "invites"
37857
37883
},
37858
37884
{
37859
37885
"name": "Legal hold policies",
37886
+
"description": "A legal hold is a process that an enterprise\ncan use to preserve all forms of potentially\nrelevant information when litigation is pending or\nreasonably anticipated.",
37860
37887
"x-box-tag": "legal_hold_policies"
37861
37888
},
37862
37889
{
37863
37890
"name": "Legal hold policy assignments",
37891
+
"description": "A Legal Hold Policy Assignment\nis a relation between a policy and custodian.\nIn this case, a custodian can be a user, folder,\nfile, or file version.",
37864
37892
"x-box-tag": "legal_hold_policy_assignments"
37865
37893
},
37866
37894
{
37867
37895
"name": "Metadata cascade policies",
37896
+
"description": "A metadata cascade policy describes how metadata\ninstances applied to a folder should be applied\nto any item within that folder.",
37868
37897
"x-box-tag": "metadata_cascade_policies"
37869
37898
},
37870
37899
{
37871
37900
"name": "Metadata instances (Files)",
37901
+
"description": "A metadata instance describes\nthe relation between a template and a file,\nincluding the values that are assigned for every field.",
37872
37902
"x-box-tag": "file_metadata"
37873
37903
},
37874
37904
{
37875
37905
"name": "Metadata instances (Folders)",
37906
+
"description": "A metadata instance describes the relation between a template and a folder,\nincluding the values that are assigned for every field.",
37876
37907
"x-box-tag": "folder_metadata"
37877
37908
},
37878
37909
{
37879
37910
"name": "Metadata templates",
37911
+
"description": "A metadata template describes a reusable set\nof key/value pairs that can be assigned to a file.",
37880
37912
"x-box-tag": "metadata_templates"
37881
37913
},
37882
37914
{
37883
37915
"name": "Recent items",
37916
+
"description": "Recent items represent items such\nas files or folders that\nthe user accessed recently.",
37884
37917
"x-box-tag": "recent_items"
37885
37918
},
37886
37919
{
37887
37920
"name": "Retention policies",
37921
+
"description": "A retention policy blocks permanent deletion of content\nfor a specified amount of time. Admins can create\nretention policies and then assign them to\nspecific folders or their entire enterprise.",
37888
37922
"x-box-tag": "retention_policies"
37889
37923
},
37890
37924
{
37891
37925
"name": "Retention policy assignments",
37926
+
"description": "A Retention Policy Assignment is a relation\nbetween a policy and folder or enterprise.\nCreating an assignment puts a retention on\nall the file versions that belong to that folder or enterprise.",
37892
37927
"x-box-tag": "retention_policy_assignments"
37893
37928
},
37894
37929
{
37895
37930
"name": "Search",
37931
+
"description": "The Box API provides a way to find content in Box\nusing full-text search queries.",
37896
37932
"x-box-tag": "search"
37897
37933
},
37898
37934
{
37899
37935
"name": "Session termination",
37936
+
"description": "Session termination API is used to\nvalidate the roles and permissions of the group,\nand creates asynchronous jobs to terminate the group's sessions.",
37900
37937
"x-box-tag": "session_termination"
37901
37938
},
37902
37939
{
37903
37940
"name": "Shared links (Files)",
37941
+
"description": "Files shared links are URLs that are generated for files stored in Box,\nwhich provide direct, read-only access to the resource.",
37904
37942
"x-box-tag": "shared_links_files"
37905
37943
},
37906
37944
{
37907
37945
"name": "Shared links (Folders)",
37946
+
"description": "Folders shared links are URLs that are generated for folders stored in Box,\nwhich provide direct, read-only access to the resource.",
37908
37947
"x-box-tag": "shared_links_folders"
37909
37948
},
37910
37949
{
37911
37950
"name": "Shared links (Web Links)",
37951
+
"description": "Web links for files are URLs that are generated\nfor web links in Box,\nwhich provide direct, read-only access to the resource.",
37912
37952
"x-box-tag": "shared_links_web_links"
37913
37953
},
37914
37954
{
37915
37955
"name": "Shield information barriers",
37956
+
"description": "Shield information barrier in Box defines an ethical wall.\nAn ethical wall is a mechanism that prevents exchanges or communication that\ncould lead to conflicts of interest and therefore result in\nbusiness activities ethically or legally questionable.",
37916
37957
"x-box-tag": "shield_information_barriers"
37917
37958
},
37918
37959
{
37919
37960
"name": "Shield information barrier segments",
37961
+
"description": "Shield information barrier segment represents\na defined group of users. A user can be a member\nof only one segment, which makes segments\ndifferent from groups.",
"description": "Shield information barrier reports\ncontain information on what existing collaborations\nwill be removed permanently when the information barrier is enabled.",
37928
37972
"x-box-tag": "shield_information_barrier_reports"
37929
37973
},
37930
37974
{
37931
37975
"name": "Shield information barrier segment restrictions",
37976
+
"description": "Shield information barrier segment restriction is\nan access restriction based on the content (file or folder) owner.",
"description": "Sign templates allow you to use a predefined Box Sign\ntemplate when creating a sign request.\nThe template includes placeholders that\nare automatically populated with data when creating the request.",
37936
37982
"x-box-tag": "sign_templates"
37937
37983
},
37938
37984
{
37939
37985
"name": "Skills",
37986
+
"description": "Box Skills are designed to allow custom processing\nof files uploaded to Box, with the\nintent of enhancing the underlying metadata of the file.",
37940
37987
"x-box-tag": "skills"
37941
37988
},
37942
37989
{
37943
37990
"name": "Standard and Zones Storage Policies",
37991
+
"description": "Storage policy assignment represents the\nstorage zone for items in a given enterprise.",
37944
37992
"x-box-tag": "storage_policies"
37945
37993
},
37946
37994
{
37947
37995
"name": "Standard and Zones Storage Policy Assignments",
37996
+
"description": "Storage policy assignment represents the\nrelation between storage zone and the\nassigned item (for example a file stored\nin a specific zone).",
37948
37997
"x-box-tag": "storage_policy_assignments"
37949
37998
},
37950
37999
{
37951
38000
"name": "Task assignments",
38001
+
"description": "A task assignment defines which\ntask is assigned to which user to complete.",
37952
38002
"x-box-tag": "task_assignments"
37953
38003
},
37954
38004
{
37955
38005
"name": "Tasks",
38006
+
"description": "Tasks allow users to request collaborators on a file\nto review a file or complete a piece of work.\nTasks can be used by developers to create file-centric workflows.",
37956
38007
"x-box-tag": "tasks"
37957
38008
},
37958
38009
{
37959
38010
"name": "Terms of service",
38011
+
"description": "A set of endpoints used to\nmanage terms of service agreements.",
37960
38012
"x-box-tag": "terms_of_services"
37961
38013
},
37962
38014
{
37963
38015
"name": "Terms of service user statuses",
38016
+
"description": "A set of endpoints used to\nmanage the status of terms of service\nfor a particular user.",
37964
38017
"x-box-tag": "terms_of_service_user_statuses"
37965
38018
},
37966
-
{
37967
-
"name": "Termination message",
37968
-
"x-box-tag": "termination_message"
37969
-
},
37970
38019
{
37971
38020
"name": "Transfer folders",
38021
+
"description": "API designed to move all of the items\n(files, folders and workflows)\nowned by a user into another user's account.",
37972
38022
"x-box-tag": "transfer"
37973
38023
},
37974
38024
{
37975
38025
"name": "Trashed files",
38026
+
"description": "Files that were deleted and\nmoved to trash.",
37976
38027
"x-box-tag": "trashed_files"
37977
38028
},
37978
38029
{
37979
38030
"name": "Trashed folders",
38031
+
"description": "Folders that were deleted and\nmoved to trash.",
37980
38032
"x-box-tag": "trashed_folders"
37981
38033
},
37982
38034
{
37983
38035
"name": "Trashed items",
38036
+
"description": "Items that were deleted and\nmoved to trash.",
37984
38037
"x-box-tag": "trashed_items"
37985
38038
},
37986
38039
{
37987
38040
"name": "Trashed web links",
38041
+
"description": "Web links that were deleted and\nmoved to trash.",
37988
38042
"x-box-tag": "trashed_web_links"
37989
38043
},
37990
38044
{
37991
38045
"name": "Uploads",
38046
+
"description": "The direct file upload API supports files\nup to 50MB in size and sends all\nthe binary data to the Box API in 1 API request.",
37992
38047
"x-box-tag": "uploads"
37993
38048
},
37994
38049
{
37995
38050
"name": "Uploads (Chunked)",
38051
+
"description": "The chunked upload endpoints support files from\n20MB in size and allow an application\nto upload the file in parts,\nallowing for more control to catch any errors\nand retry parts individually.",
37996
38052
"x-box-tag": "chunked_uploads"
37997
38053
},
37998
38054
{
37999
38055
"name": "User avatars",
38056
+
"description": "User avatars are JPG or PNG files\nuploaded to Box to represent the\nuser image. They are then displayed\nin the user account.",
38000
38057
"x-box-tag": "avatars"
38001
38058
},
38002
38059
{
38003
38060
"name": "Users",
38061
+
"description": "Box API supports a variety of users,\nranging from real employees\nlogging in with their Managed User account,\nto applications using App Users to drive powerful\nautomation workflows.",
38004
38062
"x-box-tag": "users"
38005
38063
},
38006
38064
{
38007
38065
"name": "Watermarks (Files)",
38066
+
"description": "A watermark is a semi-transparent\noverlay on an embedded file\npreview that displays a viewer's email address\nor user ID and the time of access over\nthe file.",
38008
38067
"x-box-tag": "file_watermarks"
38009
38068
},
38010
38069
{
38011
38070
"name": "Watermarks (Folders)",
38071
+
"description": "A watermark is a semi-transparent overlay on an embedded folder\npreview that displays a viewer's email address or user ID\nand the time of access over\nthe folder content.",
38012
38072
"x-box-tag": "folder_watermarks"
38013
38073
},
38014
38074
{
38015
38075
"name": "Web links",
38076
+
"description": "Web links are objects that point to URLs.\nThese objects are also known as bookmarks\nwithin the Box web application.",
38016
38077
"x-box-tag": "web_links"
38017
38078
},
38018
38079
{
38019
38080
"name": "Webhooks",
38081
+
"description": "Webhooks allow you to monitor Box content for events,\nand receive notifications to a URL of your choice when they occur.\nFor example, a workflow may include waiting\nfor a file to be downloaded to delete a shared link.",
38020
38082
"x-box-tag": "webhooks"
38021
38083
},
38022
38084
{
38023
38085
"name": "Workflows",
38086
+
"description": "Box Relay Workflows are objects that represent\na named collection of flows.",
38024
38087
"x-box-tag": "workflows"
38025
38088
},
38026
38089
{
38027
38090
"name": "Zip Downloads",
38091
+
"description": "Zip downloads represent a successful request\nto create a ZIP archive with files and folders.",
0 commit comments