{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:box/get-authorize":{"get":{"operationId":"cloud_box_get_authorize","summary":"Authorize user","description":"GET /authorize","tags":["cloud"],"parameters":[{"name":"response_type","in":"query","required":true,"description":"The type of response we'd like to receive.","schema":{"type":"string","enum":["code"],"description":"The type of response we'd like to receive."},"example":"code"},{"name":"client_id","in":"query","required":true,"description":"The Client ID of the application that is requesting to authenticate the user. To get the Client ID for your application, log in to your…","schema":{"type":"string","description":"The Client ID of the application that is requesting to authenticate the user. To get the Client ID for your application, log in to your…"},"example":"ly1nj6n11vionaie65emwzk575hnnmrk"},{"name":"redirect_uri","in":"query","required":false,"description":"The URI to which Box redirects the browser after the user has granted or denied the application permission. This URI match one of the…","schema":{"type":"string","description":"The URI to which Box redirects the browser after the user has granted or denied the application permission. This URI match one of the…"},"example":"http://example.com/auth/callback"},{"name":"state","in":"query","required":false,"description":"A custom string of your choice. Box will pass the same string to the redirect URL when authentication is complete. This parameter can be…","schema":{"type":"string","description":"A custom string of your choice. Box will pass the same string to the redirect URL when authentication is complete. This parameter can be…"},"example":"my_state"},{"name":"scope","in":"query","required":false,"description":"A space-separated list of application scopes you'd like to authenticate the user for. This defaults to all the scopes configured for the…","schema":{"type":"string","description":"A space-separated list of application scopes you'd like to authenticate the user for. This defaults to all the scopes configured for the…"},"example":"admin_readwrite"}],"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":"byok"}},"/v1/cloud:box/post-oauth2-token":{"post":{"operationId":"cloud_box_post_oauth2_token","summary":"Request access token","description":"POST /oauth2/token","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/post-oauth2-token-refresh":{"post":{"operationId":"cloud_box_post_oauth2_token_refresh","summary":"Refresh access token","description":"POST /oauth2/token","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/post-oauth2-revoke":{"post":{"operationId":"cloud_box_post_oauth2_revoke","summary":"Revoke access token","description":"POST /oauth2/revoke","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-files-id":{"get":{"operationId":"cloud_box_get_files_id","summary":"Get file information","description":"GET /files/{file_id}","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":true,"description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…","schema":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"example":"12345"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"if-none-match","in":"query","required":false,"description":"Ensures an item is only returned if it has changed. Pass in the item's last observed `etag` value into this header and the endpoint will…","schema":{"type":"string","description":"Ensures an item is only returned if it has changed. Pass in the item's last observed `etag` value into this header and the endpoint will…"},"example":"1"},{"name":"boxapi","in":"query","required":false,"description":"The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly…","schema":{"type":"string","description":"The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly…"},"example":"shared_link=[link]&shared_link_password=[password]"},{"name":"x-rep-hints","in":"query","required":false,"description":"A header required to request specific `representations` of a file. Use this in combination with the `fields` query parameter to request a…","schema":{"type":"string","description":"A header required to request specific `representations` of a file. Use this in combination with the `fields` query parameter to request a…"},"example":"[pdf]"}],"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":"byok"}},"/v1/cloud:box/post-files-id":{"post":{"operationId":"cloud_box_post_files_id","summary":"Restore file","description":"POST /files/{file_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"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":"byok"}},"/v1/cloud:box/put-files-id":{"post":{"operationId":"cloud_box_put_files_id","summary":"Update file","description":"PUT /files/{file_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"if-match":{"type":"string","description":"Ensures this item hasn't recently changed before making changes. Pass in the item's last observed `etag` value into this header and the…"},"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":"byok"}},"/v1/cloud:box/delete-files-id":{"post":{"operationId":"cloud_box_delete_files_id","summary":"Delete file","description":"DELETE /files/{file_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"if-match":{"type":"string","description":"Ensures this item hasn't recently changed before making changes. Pass in the item's last observed `etag` value into this header and the…"}}}}}},"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":"byok"}},"/v1/cloud:box/get-files-id-app-item-associations":{"get":{"operationId":"cloud_box_get_files_id_app_item_associations","summary":"List file app item associations","description":"GET /files/{file_id}/app_item_associations","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":true,"description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…","schema":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"example":"12345"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"application_type","in":"query","required":false,"description":"If given, only return app items for this application type.","schema":{"type":"string","description":"If given, only return app items for this application type."},"example":"hubs"}],"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":"byok"}},"/v1/cloud:box/get-files-id-content":{"get":{"operationId":"cloud_box_get_files_id_content","summary":"Download file","description":"GET /files/{file_id}/content","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":true,"description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…","schema":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"example":"12345"},{"name":"range","in":"query","required":false,"description":"The byte range of the content to download. The format `bytes={start_byte}-{end_byte}` can be used to specify what section of the file to…","schema":{"type":"string","description":"The byte range of the content to download. The format `bytes={start_byte}-{end_byte}` can be used to specify what section of the file to…"},"example":"bytes=0-1024"},{"name":"boxapi","in":"query","required":false,"description":"The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly…","schema":{"type":"string","description":"The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly…"},"example":"shared_link=[link]&shared_link_password=[password]"},{"name":"version","in":"query","required":false,"description":"The file version to download.","schema":{"type":"string","description":"The file version to download."},"example":"4"},{"name":"access_token","in":"query","required":false,"description":"An optional access token that can be used to pre-authenticate this request, which means that a download link can be shared with a browser…","schema":{"type":"string","description":"An optional access token that can be used to pre-authenticate this request, which means that a download link can be shared with a browser…"},"example":"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ"}],"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":"byok"}},"/v1/cloud:box/post-files-id-content":{"post":{"operationId":"cloud_box_post_files_id_content","summary":"Upload file version","description":"POST /files/{file_id}/content","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"if-match":{"type":"string","description":"Ensures this item hasn't recently changed before making changes. Pass in the item's last observed `etag` value into this header and the…"},"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"content-md5":{"type":"string","description":"An optional header containing the SHA1 hash of the file to ensure that the file was not corrupted in transit."},"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":"byok"}},"/v1/cloud:box/post-files-content":{"post":{"operationId":"cloud_box_post_files_content","summary":"Upload file","description":"POST /files/content","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"content-md5":{"type":"string","description":"An optional header containing the SHA1 hash of the file to ensure that the file was not corrupted in transit."},"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":"byok"}},"/v1/cloud:box/post-files-upload-sessions":{"post":{"operationId":"cloud_box_post_files_upload_sessions","summary":"Create upload session","description":"POST /files/upload_sessions","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/post-files-id-upload-sessions":{"post":{"operationId":"cloud_box_post_files_id_upload_sessions","summary":"Create upload session for existing file","description":"POST /files/{file_id}/upload_sessions","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"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":"byok"}},"/v1/cloud:box/get-files-upload-sessions-id":{"get":{"operationId":"cloud_box_get_files_upload_sessions_id","summary":"Get upload session","description":"GET /files/upload_sessions/{upload_session_id}","tags":["cloud"],"parameters":[{"name":"upload_session_id","in":"query","required":true,"description":"The ID of the upload session.","schema":{"type":"string","description":"The ID of the upload session."},"example":"D5E3F7A"}],"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":"byok"}},"/v1/cloud:box/put-files-upload-sessions-id":{"post":{"operationId":"cloud_box_put_files_upload_sessions_id","summary":"Upload part of file","description":"PUT /files/upload_sessions/{upload_session_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["upload_session_id","digest","content-range"],"properties":{"upload_session_id":{"type":"string","description":"The ID of the upload session."},"digest":{"type":"string","description":"The [RFC3230][1] message digest of the chunk uploaded. `SHA-1` and `SHA-512` ([RFC5843][2]) are supported. The digest must be base64…"},"content-range":{"type":"string","description":"The byte range of the chunk. Must not overlap with the range of a part already uploaded this session. Each part’s size must be exactly…"}}}}}},"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":"byok"}},"/v1/cloud:box/delete-files-upload-sessions-id":{"post":{"operationId":"cloud_box_delete_files_upload_sessions_id","summary":"Remove upload session","description":"DELETE /files/upload_sessions/{upload_session_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["upload_session_id"],"properties":{"upload_session_id":{"type":"string","description":"The ID of the upload session."}}}}}},"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":"byok"}},"/v1/cloud:box/get-files-upload-sessions-id-parts":{"get":{"operationId":"cloud_box_get_files_upload_sessions_id_parts","summary":"List parts","description":"GET /files/upload_sessions/{upload_session_id}/parts","tags":["cloud"],"parameters":[{"name":"upload_session_id","in":"query","required":true,"description":"The ID of the upload session.","schema":{"type":"string","description":"The ID of the upload session."},"example":"D5E3F7A"},{"name":"offset","in":"query","required":false,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…","schema":{"type":"integer","default":0,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…"},"example":1000},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-files-upload-sessions-id-plan":{"post":{"operationId":"cloud_box_post_files_upload_sessions_id_plan","summary":"Plan upload session","description":"POST /files/upload_sessions/{upload_session_id}/plan","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["upload_session_id"],"properties":{"upload_session_id":{"type":"string","description":"The ID of the upload session."},"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":"byok"}},"/v1/cloud:box/post-files-upload-sessions-id-commit":{"post":{"operationId":"cloud_box_post_files_upload_sessions_id_commit","summary":"Commit upload session","description":"POST /files/upload_sessions/{upload_session_id}/commit","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["upload_session_id","digest"],"properties":{"upload_session_id":{"type":"string","description":"The ID of the upload session."},"digest":{"type":"string","description":"The [RFC3230][1] message digest of the whole file. Only SHA1 is supported. The SHA1 digest must be Base64 encoded. The format of this…"},"if-match":{"type":"string","description":"Ensures this item hasn't recently changed before making changes. Pass in the item's last observed `etag` value into this header and the…"},"if-none-match":{"type":"string","description":"Ensures an item is only returned if it has changed. Pass in the item's last observed `etag` value into this header and the endpoint will…"},"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":"byok"}},"/v1/cloud:box/post-files-id-copy":{"post":{"operationId":"cloud_box_post_files_id_copy","summary":"Copy file","description":"POST /files/{file_id}/copy","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"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":"byok"}},"/v1/cloud:box/get-files-id-thumbnail-id":{"get":{"operationId":"cloud_box_get_files_id_thumbnail_id","summary":"Get file thumbnail","description":"GET /files/{file_id}/thumbnail.{extension}","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":true,"description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…","schema":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"example":"12345"},{"name":"extension","in":"query","required":true,"description":"The file format for the thumbnail.","schema":{"type":"string","enum":["png","jpg"],"description":"The file format for the thumbnail."},"example":"png"},{"name":"min_height","in":"query","required":false,"description":"The minimum height of the thumbnail.","schema":{"type":"integer","description":"The minimum height of the thumbnail."},"example":32},{"name":"min_width","in":"query","required":false,"description":"The minimum width of the thumbnail.","schema":{"type":"integer","description":"The minimum width of the thumbnail."},"example":32},{"name":"max_height","in":"query","required":false,"description":"The maximum height of the thumbnail.","schema":{"type":"integer","description":"The maximum height of the thumbnail."},"example":320},{"name":"max_width","in":"query","required":false,"description":"The maximum width of the thumbnail.","schema":{"type":"integer","description":"The maximum width of the thumbnail."},"example":320}],"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":"byok"}},"/v1/cloud:box/get-files-id-collaborations":{"get":{"operationId":"cloud_box_get_files_id_collaborations","summary":"List file collaborations","description":"GET /files/{file_id}/collaborations","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":true,"description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…","schema":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"example":"12345"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"}],"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":"byok"}},"/v1/cloud:box/get-files-id-comments":{"get":{"operationId":"cloud_box_get_files_id_comments","summary":"List file comments","description":"GET /files/{file_id}/comments","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":true,"description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…","schema":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"example":"12345"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"offset","in":"query","required":false,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…","schema":{"type":"integer","default":0,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…"},"example":1000}],"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":"byok"}},"/v1/cloud:box/get-files-id-tasks":{"get":{"operationId":"cloud_box_get_files_id_tasks","summary":"List tasks on file","description":"GET /files/{file_id}/tasks","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":true,"description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…","schema":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"example":"12345"}],"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":"byok"}},"/v1/cloud:box/get-files-id-trash":{"get":{"operationId":"cloud_box_get_files_id_trash","summary":"Get trashed file","description":"GET /files/{file_id}/trash","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":true,"description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…","schema":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"example":"12345"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}}],"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":"byok"}},"/v1/cloud:box/delete-files-id-trash":{"post":{"operationId":"cloud_box_delete_files_id_trash","summary":"Permanently remove file","description":"DELETE /files/{file_id}/trash","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"}}}}}},"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":"byok"}},"/v1/cloud:box/get-files-id-versions":{"get":{"operationId":"cloud_box_get_files_id_versions","summary":"List all file versions","description":"GET /files/{file_id}/versions","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":true,"description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…","schema":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"example":"12345"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"offset","in":"query","required":false,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…","schema":{"type":"integer","default":0,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…"},"example":1000}],"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":"byok"}},"/v1/cloud:box/get-files-id-versions-id":{"get":{"operationId":"cloud_box_get_files_id_versions_id","summary":"Get file version","description":"GET /files/{file_id}/versions/{file_version_id}","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":true,"description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…","schema":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"example":"12345"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"file_version_id","in":"query","required":true,"description":"The ID of the file version.","schema":{"type":"string","description":"The ID of the file version."},"example":"1234"}],"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":"byok"}},"/v1/cloud:box/put-files-id-versions-id":{"post":{"operationId":"cloud_box_put_files_id_versions_id","summary":"Restore file version","description":"PUT /files/{file_id}/versions/{file_version_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id","file_version_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"file_version_id":{"type":"string","description":"The ID of the file version."},"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":"byok"}},"/v1/cloud:box/delete-files-id-versions-id":{"post":{"operationId":"cloud_box_delete_files_id_versions_id","summary":"Remove file version","description":"DELETE /files/{file_id}/versions/{file_version_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id","file_version_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"file_version_id":{"type":"string","description":"The ID of the file version."},"if-match":{"type":"string","description":"Ensures this item hasn't recently changed before making changes. Pass in the item's last observed `etag` value into this header and the…"}}}}}},"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":"byok"}},"/v1/cloud:box/post-files-id-versions-current":{"post":{"operationId":"cloud_box_post_files_id_versions_current","summary":"Promote file version","description":"POST /files/{file_id}/versions/current","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"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":"byok"}},"/v1/cloud:box/get-files-id-metadata":{"get":{"operationId":"cloud_box_get_files_id_metadata","summary":"List metadata instances on file","description":"GET /files/{file_id}/metadata","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":true,"description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…","schema":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"example":"12345"},{"name":"view","in":"query","required":false,"description":"Taxonomy field values are returned in `API view` by default, meaning the value is represented with a taxonomy node identifier. To retrieve…","schema":{"type":"string","description":"Taxonomy field values are returned in `API view` by default, meaning the value is represented with a taxonomy node identifier. To retrieve…"},"example":"hydrated"}],"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":"byok"}},"/v1/cloud:box/get-files-id-metadata-enterprise-security-classification-6-v":{"get":{"operationId":"cloud_box_get_files_id_metadata_enterprise_security_classification_6_v","summary":"Get classification on file","description":"GET /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":true,"description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…","schema":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"example":"12345"}],"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":"byok"}},"/v1/cloud:box/post-files-id-metadata-enterprise-security-classification-6":{"post":{"operationId":"cloud_box_post_files_id_metadata_enterprise_security_classification_6","summary":"Add classification to file","description":"POST /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"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":"byok"}},"/v1/cloud:box/put-files-id-metadata-enterprise-security-classification-6-v":{"post":{"operationId":"cloud_box_put_files_id_metadata_enterprise_security_classification_6_v","summary":"Update classification on file","description":"PUT /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"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":"byok"}},"/v1/cloud:box/delete-files-id-metadata-enterprise-security-classification":{"post":{"operationId":"cloud_box_delete_files_id_metadata_enterprise_security_classification","summary":"Remove classification from file","description":"DELETE /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"}}}}}},"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":"byok"}},"/v1/cloud:box/get-files-id-metadata-id-id":{"get":{"operationId":"cloud_box_get_files_id_metadata_id_id","summary":"Get metadata instance on file","description":"GET /files/{file_id}/metadata/{scope}/{template_key}","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":true,"description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…","schema":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"example":"12345"},{"name":"scope","in":"query","required":true,"description":"The scope of the metadata template.","schema":{"type":"string","enum":["global","enterprise"],"description":"The scope of the metadata template."},"example":"global"},{"name":"template_key","in":"query","required":true,"description":"The name of the metadata template.","schema":{"type":"string","description":"The name of the metadata template."},"example":"properties"},{"name":"view","in":"query","required":false,"description":"Taxonomy field values are returned in `API view` by default, meaning the value is represented with a taxonomy node identifier. To retrieve…","schema":{"type":"string","description":"Taxonomy field values are returned in `API view` by default, meaning the value is represented with a taxonomy node identifier. To retrieve…"},"example":"hydrated"}],"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":"byok"}},"/v1/cloud:box/post-files-id-metadata-id-id":{"post":{"operationId":"cloud_box_post_files_id_metadata_id_id","summary":"Create metadata instance on file","description":"POST /files/{file_id}/metadata/{scope}/{template_key}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id","scope","template_key"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"scope":{"type":"string","enum":["global","enterprise"],"description":"The scope of the metadata template."},"template_key":{"type":"string","description":"The name of the metadata template."},"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":"byok"}},"/v1/cloud:box/put-files-id-metadata-id-id":{"post":{"operationId":"cloud_box_put_files_id_metadata_id_id","summary":"Update metadata instance on file","description":"PUT /files/{file_id}/metadata/{scope}/{template_key}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id","scope","template_key"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"scope":{"type":"string","enum":["global","enterprise"],"description":"The scope of the metadata template."},"template_key":{"type":"string","description":"The name of the metadata template."},"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":"byok"}},"/v1/cloud:box/delete-files-id-metadata-id-id":{"post":{"operationId":"cloud_box_delete_files_id_metadata_id_id","summary":"Remove metadata instance from file","description":"DELETE /files/{file_id}/metadata/{scope}/{template_key}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id","scope","template_key"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"scope":{"type":"string","enum":["global","enterprise"],"description":"The scope of the metadata template."},"template_key":{"type":"string","description":"The name of the metadata template."}}}}}},"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":"byok"}},"/v1/cloud:box/get-files-id-metadata-global-box-skills-cards":{"get":{"operationId":"cloud_box_get_files_id_metadata_global_box_skills_cards","summary":"List Box Skill cards on file","description":"GET /files/{file_id}/metadata/global/boxSkillsCards","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":true,"description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…","schema":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"example":"12345"}],"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":"byok"}},"/v1/cloud:box/post-files-id-metadata-global-box-skills-cards":{"post":{"operationId":"cloud_box_post_files_id_metadata_global_box_skills_cards","summary":"Create Box Skill cards on file","description":"POST /files/{file_id}/metadata/global/boxSkillsCards","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"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":"byok"}},"/v1/cloud:box/put-files-id-metadata-global-box-skills-cards":{"post":{"operationId":"cloud_box_put_files_id_metadata_global_box_skills_cards","summary":"Update Box Skill cards on file","description":"PUT /files/{file_id}/metadata/global/boxSkillsCards","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"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":"byok"}},"/v1/cloud:box/delete-files-id-metadata-global-box-skills-cards":{"post":{"operationId":"cloud_box_delete_files_id_metadata_global_box_skills_cards","summary":"Remove Box Skill cards from file","description":"DELETE /files/{file_id}/metadata/global/boxSkillsCards","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"}}}}}},"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":"byok"}},"/v1/cloud:box/get-files-id-watermark":{"get":{"operationId":"cloud_box_get_files_id_watermark","summary":"Get watermark on file","description":"GET /files/{file_id}/watermark","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":true,"description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…","schema":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"example":"12345"}],"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":"byok"}},"/v1/cloud:box/put-files-id-watermark":{"post":{"operationId":"cloud_box_put_files_id_watermark","summary":"Apply watermark to file","description":"PUT /files/{file_id}/watermark","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"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":"byok"}},"/v1/cloud:box/delete-files-id-watermark":{"post":{"operationId":"cloud_box_delete_files_id_watermark","summary":"Remove watermark from file","description":"DELETE /files/{file_id}/watermark","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"}}}}}},"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":"byok"}},"/v1/cloud:box/get-file-requests-id":{"get":{"operationId":"cloud_box_get_file_requests_id","summary":"Get file request","description":"GET /file_requests/{file_request_id}","tags":["cloud"],"parameters":[{"name":"file_request_id","in":"query","required":true,"description":"The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in…","schema":{"type":"string","description":"The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in…"},"example":"123"}],"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":"byok"}},"/v1/cloud:box/put-file-requests-id":{"post":{"operationId":"cloud_box_put_file_requests_id","summary":"Update file request","description":"PUT /file_requests/{file_request_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_request_id"],"properties":{"file_request_id":{"type":"string","description":"The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in…"},"if-match":{"type":"string","description":"Ensures this item hasn't recently changed before making changes. Pass in the item's last observed `etag` value into this header and the…"},"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":"byok"}},"/v1/cloud:box/delete-file-requests-id":{"post":{"operationId":"cloud_box_delete_file_requests_id","summary":"Delete file request","description":"DELETE /file_requests/{file_request_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_request_id"],"properties":{"file_request_id":{"type":"string","description":"The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in…"}}}}}},"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":"byok"}},"/v1/cloud:box/post-file-requests-id-copy":{"post":{"operationId":"cloud_box_post_file_requests_id_copy","summary":"Copy file request","description":"POST /file_requests/{file_request_id}/copy","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_request_id"],"properties":{"file_request_id":{"type":"string","description":"The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in…"},"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":"byok"}},"/v1/cloud:box/get-folders-id":{"get":{"operationId":"cloud_box_get_folders_id","summary":"Get folder information","description":"GET /folders/{folder_id}","tags":["cloud"],"parameters":[{"name":"folder_id","in":"query","required":true,"description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…","schema":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"example":"12345"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"if-none-match","in":"query","required":false,"description":"Ensures an item is only returned if it has changed. Pass in the item's last observed `etag` value into this header and the endpoint will…","schema":{"type":"string","description":"Ensures an item is only returned if it has changed. Pass in the item's last observed `etag` value into this header and the endpoint will…"},"example":"1"},{"name":"boxapi","in":"query","required":false,"description":"The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly…","schema":{"type":"string","description":"The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly…"},"example":"shared_link=[link]&shared_link_password=[password]"},{"name":"sort","in":"query","required":false,"description":"Defines the **second** attribute by which items are sorted. The folder type affects the way the items are sorted: * **Standard folder**:…","schema":{"type":"string","enum":["id","name","date","size"],"description":"Defines the **second** attribute by which items are sorted. The folder type affects the way the items are sorted: * **Standard folder**:…"},"example":"id"},{"name":"direction","in":"query","required":false,"description":"The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order.","schema":{"type":"string","enum":["ASC","DESC"],"description":"The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order."},"example":"ASC"},{"name":"offset","in":"query","required":false,"description":"The offset of the item at which to begin the response. Offset-based pagination is not guaranteed to work reliably for high offset values…","schema":{"type":"integer","default":0,"description":"The offset of the item at which to begin the response. Offset-based pagination is not guaranteed to work reliably for high offset values…"},"example":1000},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-folders-id":{"post":{"operationId":"cloud_box_post_folders_id","summary":"Restore folder","description":"POST /folders/{folder_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_id"],"properties":{"folder_id":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"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":"byok"}},"/v1/cloud:box/put-folders-id":{"post":{"operationId":"cloud_box_put_folders_id","summary":"Update folder","description":"PUT /folders/{folder_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_id"],"properties":{"folder_id":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"if-match":{"type":"string","description":"Ensures this item hasn't recently changed before making changes. Pass in the item's last observed `etag` value into this header and the…"},"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":"byok"}},"/v1/cloud:box/delete-folders-id":{"post":{"operationId":"cloud_box_delete_folders_id","summary":"Delete folder","description":"DELETE /folders/{folder_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_id"],"properties":{"folder_id":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"if-match":{"type":"string","description":"Ensures this item hasn't recently changed before making changes. Pass in the item's last observed `etag` value into this header and the…"},"recursive":{"type":"boolean","description":"Delete a folder that is not empty by recursively deleting the folder and all of its content."}}}}}},"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":"byok"}},"/v1/cloud:box/get-folders-id-app-item-associations":{"get":{"operationId":"cloud_box_get_folders_id_app_item_associations","summary":"List folder app item associations","description":"GET /folders/{folder_id}/app_item_associations","tags":["cloud"],"parameters":[{"name":"folder_id","in":"query","required":true,"description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…","schema":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"example":"12345"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"application_type","in":"query","required":false,"description":"If given, returns only app items for this application type.","schema":{"type":"string","description":"If given, returns only app items for this application type."},"example":"hubs"}],"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":"byok"}},"/v1/cloud:box/get-folders-id-items":{"get":{"operationId":"cloud_box_get_folders_id_items","summary":"List items in folder","description":"GET /folders/{folder_id}/items","tags":["cloud"],"parameters":[{"name":"folder_id","in":"query","required":true,"description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…","schema":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"example":"12345"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"usemarker","in":"query","required":false,"description":"Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By…","schema":{"type":"boolean","description":"Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By…"},"example":true},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"offset","in":"query","required":false,"description":"The offset of the item at which to begin the response. Offset-based pagination is not guaranteed to work reliably for high offset values…","schema":{"type":"integer","default":0,"description":"The offset of the item at which to begin the response. Offset-based pagination is not guaranteed to work reliably for high offset values…"},"example":1000},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"boxapi","in":"query","required":false,"description":"The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly…","schema":{"type":"string","description":"The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly…"},"example":"shared_link=[link]&shared_link_password=[password]"},{"name":"sort","in":"query","required":false,"description":"Defines the **second** attribute by which items are sorted. The folder type affects the way the items are sorted: * **Standard folder**:…","schema":{"type":"string","enum":["id","name","date","size"],"description":"Defines the **second** attribute by which items are sorted. The folder type affects the way the items are sorted: * **Standard folder**:…"},"example":"id"},{"name":"direction","in":"query","required":false,"description":"The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order.","schema":{"type":"string","enum":["ASC","DESC"],"description":"The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order."},"example":"ASC"}],"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":"byok"}},"/v1/cloud:box/post-folders":{"post":{"operationId":"cloud_box_post_folders","summary":"Create folder","description":"POST /folders","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"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":"byok"}},"/v1/cloud:box/post-folders-id-copy":{"post":{"operationId":"cloud_box_post_folders_id_copy","summary":"Copy folder","description":"POST /folders/{folder_id}/copy","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_id"],"properties":{"folder_id":{"type":"string","description":"The unique identifier of the folder to copy. The ID for any folder can be determined by visiting this folder in the web application and…"},"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"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":"byok"}},"/v1/cloud:box/get-folders-id-collaborations":{"get":{"operationId":"cloud_box_get_folders_id_collaborations","summary":"List folder collaborations","description":"GET /folders/{folder_id}/collaborations","tags":["cloud"],"parameters":[{"name":"folder_id","in":"query","required":true,"description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…","schema":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"example":"12345"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"}],"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":"byok"}},"/v1/cloud:box/get-folders-id-trash":{"get":{"operationId":"cloud_box_get_folders_id_trash","summary":"Get trashed folder","description":"GET /folders/{folder_id}/trash","tags":["cloud"],"parameters":[{"name":"folder_id","in":"query","required":true,"description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…","schema":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"example":"12345"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}}],"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":"byok"}},"/v1/cloud:box/delete-folders-id-trash":{"post":{"operationId":"cloud_box_delete_folders_id_trash","summary":"Permanently remove folder","description":"DELETE /folders/{folder_id}/trash","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_id"],"properties":{"folder_id":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"}}}}}},"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":"byok"}},"/v1/cloud:box/get-folders-id-metadata":{"get":{"operationId":"cloud_box_get_folders_id_metadata","summary":"List metadata instances on folder","description":"GET /folders/{folder_id}/metadata","tags":["cloud"],"parameters":[{"name":"folder_id","in":"query","required":true,"description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…","schema":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"example":"12345"},{"name":"view","in":"query","required":false,"description":"Taxonomy field values are returned in `API view` by default, meaning the value is represented with a taxonomy node identifier. To retrieve…","schema":{"type":"string","description":"Taxonomy field values are returned in `API view` by default, meaning the value is represented with a taxonomy node identifier. To retrieve…"},"example":"hydrated"}],"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":"byok"}},"/v1/cloud:box/get-folders-id-metadata-enterprise-security-classification-6":{"get":{"operationId":"cloud_box_get_folders_id_metadata_enterprise_security_classification_6","summary":"Get classification on folder","description":"GET /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo","tags":["cloud"],"parameters":[{"name":"folder_id","in":"query","required":true,"description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…","schema":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"example":"12345"}],"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":"byok"}},"/v1/cloud:box/post-folders-id-metadata-enterprise-security-classification":{"post":{"operationId":"cloud_box_post_folders_id_metadata_enterprise_security_classification","summary":"Add classification to folder","description":"POST /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_id"],"properties":{"folder_id":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"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":"byok"}},"/v1/cloud:box/put-folders-id-metadata-enterprise-security-classification-6":{"post":{"operationId":"cloud_box_put_folders_id_metadata_enterprise_security_classification_6","summary":"Update classification on folder","description":"PUT /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_id"],"properties":{"folder_id":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"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":"byok"}},"/v1/cloud:box/delete-folders-id-metadata-enterprise-security-classificatio":{"post":{"operationId":"cloud_box_delete_folders_id_metadata_enterprise_security_classificatio","summary":"Remove classification from folder","description":"DELETE /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_id"],"properties":{"folder_id":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"}}}}}},"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":"byok"}},"/v1/cloud:box/get-folders-id-metadata-id-id":{"get":{"operationId":"cloud_box_get_folders_id_metadata_id_id","summary":"Get metadata instance on folder","description":"GET /folders/{folder_id}/metadata/{scope}/{template_key}","tags":["cloud"],"parameters":[{"name":"folder_id","in":"query","required":true,"description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…","schema":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"example":"12345"},{"name":"scope","in":"query","required":true,"description":"The scope of the metadata template.","schema":{"type":"string","enum":["global","enterprise"],"description":"The scope of the metadata template."},"example":"global"},{"name":"template_key","in":"query","required":true,"description":"The name of the metadata template.","schema":{"type":"string","description":"The name of the metadata template."},"example":"properties"}],"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":"byok"}},"/v1/cloud:box/post-folders-id-metadata-id-id":{"post":{"operationId":"cloud_box_post_folders_id_metadata_id_id","summary":"Create metadata instance on folder","description":"POST /folders/{folder_id}/metadata/{scope}/{template_key}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_id","scope","template_key"],"properties":{"folder_id":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"scope":{"type":"string","enum":["global","enterprise"],"description":"The scope of the metadata template."},"template_key":{"type":"string","description":"The name of the metadata template."},"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":"byok"}},"/v1/cloud:box/put-folders-id-metadata-id-id":{"post":{"operationId":"cloud_box_put_folders_id_metadata_id_id","summary":"Update metadata instance on folder","description":"PUT /folders/{folder_id}/metadata/{scope}/{template_key}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_id","scope","template_key"],"properties":{"folder_id":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"scope":{"type":"string","enum":["global","enterprise"],"description":"The scope of the metadata template."},"template_key":{"type":"string","description":"The name of the metadata template."},"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":"byok"}},"/v1/cloud:box/delete-folders-id-metadata-id-id":{"post":{"operationId":"cloud_box_delete_folders_id_metadata_id_id","summary":"Remove metadata instance from folder","description":"DELETE /folders/{folder_id}/metadata/{scope}/{template_key}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_id","scope","template_key"],"properties":{"folder_id":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"scope":{"type":"string","enum":["global","enterprise"],"description":"The scope of the metadata template."},"template_key":{"type":"string","description":"The name of the metadata template."}}}}}},"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":"byok"}},"/v1/cloud:box/get-folders-trash-items":{"get":{"operationId":"cloud_box_get_folders_trash_items","summary":"List trashed items","description":"GET /folders/trash/items","tags":["cloud"],"parameters":[{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"offset","in":"query","required":false,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…","schema":{"type":"integer","default":0,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…"},"example":1000},{"name":"usemarker","in":"query","required":false,"description":"Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By…","schema":{"type":"boolean","description":"Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By…"},"example":true},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"direction","in":"query","required":false,"description":"The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order.","schema":{"type":"string","enum":["ASC","DESC"],"description":"The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order."},"example":"ASC"},{"name":"sort","in":"query","required":false,"description":"Defines the **second** attribute by which items are sorted. Items are always sorted by their `type` first, with folders listed before…","schema":{"type":"string","enum":["name","date","size"],"description":"Defines the **second** attribute by which items are sorted. Items are always sorted by their `type` first, with folders listed before…"},"example":"name"}],"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":"byok"}},"/v1/cloud:box/get-folders-id-watermark":{"get":{"operationId":"cloud_box_get_folders_id_watermark","summary":"Get watermark for folder","description":"GET /folders/{folder_id}/watermark","tags":["cloud"],"parameters":[{"name":"folder_id","in":"query","required":true,"description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…","schema":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"example":"12345"}],"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":"byok"}},"/v1/cloud:box/put-folders-id-watermark":{"post":{"operationId":"cloud_box_put_folders_id_watermark","summary":"Apply watermark to folder","description":"PUT /folders/{folder_id}/watermark","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_id"],"properties":{"folder_id":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"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":"byok"}},"/v1/cloud:box/delete-folders-id-watermark":{"post":{"operationId":"cloud_box_delete_folders_id_watermark","summary":"Remove watermark from folder","description":"DELETE /folders/{folder_id}/watermark","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_id"],"properties":{"folder_id":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"}}}}}},"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":"byok"}},"/v1/cloud:box/get-folder-locks":{"get":{"operationId":"cloud_box_get_folder_locks","summary":"List folder locks","description":"GET /folder_locks","tags":["cloud"],"parameters":[{"name":"folder_id","in":"query","required":true,"description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…","schema":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"example":"12345"}],"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":"byok"}},"/v1/cloud:box/post-folder-locks":{"post":{"operationId":"cloud_box_post_folder_locks","summary":"Create folder lock","description":"POST /folder_locks","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/delete-folder-locks-id":{"post":{"operationId":"cloud_box_delete_folder_locks_id","summary":"Delete folder lock","description":"DELETE /folder_locks/{folder_lock_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_lock_id"],"properties":{"folder_lock_id":{"type":"string","description":"The ID of the folder lock."}}}}}},"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":"byok"}},"/v1/cloud:box/get-metadata-templates":{"get":{"operationId":"cloud_box_get_metadata_templates","summary":"Find metadata template by instance ID","description":"GET /metadata_templates","tags":["cloud"],"parameters":[{"name":"metadata_instance_id","in":"query","required":true,"description":"The ID of an instance of the metadata template to find.","schema":{"type":"string","description":"The ID of an instance of the metadata template to find."},"example":"01234500-12f1-1234-aa12-b1d234cb567e"},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/get-metadata-templates-enterprise-security-classification-6":{"get":{"operationId":"cloud_box_get_metadata_templates_enterprise_security_classification_6","summary":"List all classifications","description":"GET /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema","tags":["cloud"],"parameters":[],"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":"byok"}},"/v1/cloud:box/put-metadata-templates-enterprise-security-classification-6":{"post":{"operationId":"cloud_box_put_metadata_templates_enterprise_security_classification_6","summary":"Add classification","description":"PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/put-metadata-templates-enterprise-security-classification-6-2":{"post":{"operationId":"cloud_box_put_metadata_templates_enterprise_security_classification_6_2","summary":"Update classification","description":"PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-metadata-templates-id-id-schema":{"get":{"operationId":"cloud_box_get_metadata_templates_id_id_schema","summary":"Get metadata template by name","description":"GET /metadata_templates/{scope}/{template_key}/schema","tags":["cloud"],"parameters":[{"name":"scope","in":"query","required":true,"description":"The scope of the metadata template.","schema":{"type":"string","enum":["global","enterprise"],"description":"The scope of the metadata template."},"example":"global"},{"name":"template_key","in":"query","required":true,"description":"The name of the metadata template.","schema":{"type":"string","description":"The name of the metadata template."},"example":"properties"}],"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":"byok"}},"/v1/cloud:box/put-metadata-templates-id-id-schema":{"post":{"operationId":"cloud_box_put_metadata_templates_id_id_schema","summary":"Update metadata template","description":"PUT /metadata_templates/{scope}/{template_key}/schema","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["scope","template_key"],"properties":{"scope":{"type":"string","enum":["global","enterprise"],"description":"The scope of the metadata template."},"template_key":{"type":"string","description":"The name of the metadata template."},"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":"byok"}},"/v1/cloud:box/delete-metadata-templates-id-id-schema":{"post":{"operationId":"cloud_box_delete_metadata_templates_id_id_schema","summary":"Remove metadata template","description":"DELETE /metadata_templates/{scope}/{template_key}/schema","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["scope","template_key"],"properties":{"scope":{"type":"string","enum":["global","enterprise"],"description":"The scope of the metadata template."},"template_key":{"type":"string","description":"The name of the metadata template."}}}}}},"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":"byok"}},"/v1/cloud:box/get-metadata-templates-id":{"get":{"operationId":"cloud_box_get_metadata_templates_id","summary":"Get metadata template by ID","description":"GET /metadata_templates/{template_id}","tags":["cloud"],"parameters":[{"name":"template_id","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."},"example":"f7a9891f"}],"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":"byok"}},"/v1/cloud:box/get-metadata-templates-global":{"get":{"operationId":"cloud_box_get_metadata_templates_global","summary":"List all global metadata templates","description":"GET /metadata_templates/global","tags":["cloud"],"parameters":[{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/get-metadata-templates-enterprise":{"get":{"operationId":"cloud_box_get_metadata_templates_enterprise","summary":"List all metadata templates for enterprise","description":"GET /metadata_templates/enterprise","tags":["cloud"],"parameters":[{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-metadata-templates-schema":{"post":{"operationId":"cloud_box_post_metadata_templates_schema","summary":"Create metadata template","description":"POST /metadata_templates/schema","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/post-metadata-templates-schema-classifications":{"post":{"operationId":"cloud_box_post_metadata_templates_schema_classifications","summary":"Add initial classifications","description":"POST /metadata_templates/schema","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-metadata-cascade-policies":{"get":{"operationId":"cloud_box_get_metadata_cascade_policies","summary":"List metadata cascade policies","description":"GET /metadata_cascade_policies","tags":["cloud"],"parameters":[{"name":"folder_id","in":"query","required":true,"description":"Specifies which folder to return policies for. This can not be used on the root folder with ID `0`.","schema":{"type":"string","description":"Specifies which folder to return policies for. This can not be used on the root folder with ID `0`."},"example":"31232"},{"name":"owner_enterprise_id","in":"query","required":false,"description":"The ID of the enterprise ID for which to find metadata cascade policies. If not specified, it defaults to the current enterprise.","schema":{"type":"string","description":"The ID of the enterprise ID for which to find metadata cascade policies. If not specified, it defaults to the current enterprise."},"example":"31232"},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"offset","in":"query","required":false,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…","schema":{"type":"integer","default":0,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…"},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-metadata-cascade-policies":{"post":{"operationId":"cloud_box_post_metadata_cascade_policies","summary":"Create metadata cascade policy","description":"POST /metadata_cascade_policies","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-metadata-cascade-policies-id":{"get":{"operationId":"cloud_box_get_metadata_cascade_policies_id","summary":"Get metadata cascade policy","description":"GET /metadata_cascade_policies/{metadata_cascade_policy_id}","tags":["cloud"],"parameters":[{"name":"metadata_cascade_policy_id","in":"query","required":true,"description":"The ID of the metadata cascade policy.","schema":{"type":"string","description":"The ID of the metadata cascade policy."},"example":"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7"}],"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":"byok"}},"/v1/cloud:box/delete-metadata-cascade-policies-id":{"post":{"operationId":"cloud_box_delete_metadata_cascade_policies_id","summary":"Remove metadata cascade policy","description":"DELETE /metadata_cascade_policies/{metadata_cascade_policy_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["metadata_cascade_policy_id"],"properties":{"metadata_cascade_policy_id":{"type":"string","description":"The ID of the metadata cascade policy."}}}}}},"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":"byok"}},"/v1/cloud:box/post-metadata-cascade-policies-id-apply":{"post":{"operationId":"cloud_box_post_metadata_cascade_policies_id_apply","summary":"Force-apply metadata cascade policy to folder","description":"POST /metadata_cascade_policies/{metadata_cascade_policy_id}/apply","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["metadata_cascade_policy_id"],"properties":{"metadata_cascade_policy_id":{"type":"string","description":"The ID of the cascade policy to force-apply."},"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":"byok"}},"/v1/cloud:box/post-metadata-queries-execute-read":{"post":{"operationId":"cloud_box_post_metadata_queries_execute_read","summary":"Query files/folders by metadata","description":"POST /metadata_queries/execute_read","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-comments-id":{"get":{"operationId":"cloud_box_get_comments_id","summary":"Get comment","description":"GET /comments/{comment_id}","tags":["cloud"],"parameters":[{"name":"comment_id","in":"query","required":true,"description":"The ID of the comment.","schema":{"type":"string","description":"The ID of the comment."},"example":"12345"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}}],"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":"byok"}},"/v1/cloud:box/put-comments-id":{"post":{"operationId":"cloud_box_put_comments_id","summary":"Update comment","description":"PUT /comments/{comment_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["comment_id"],"properties":{"comment_id":{"type":"string","description":"The ID of the comment."},"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"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":"byok"}},"/v1/cloud:box/delete-comments-id":{"post":{"operationId":"cloud_box_delete_comments_id","summary":"Remove comment","description":"DELETE /comments/{comment_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["comment_id"],"properties":{"comment_id":{"type":"string","description":"The ID of the comment."}}}}}},"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":"byok"}},"/v1/cloud:box/post-comments":{"post":{"operationId":"cloud_box_post_comments","summary":"Create comment","description":"POST /comments","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"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":"byok"}},"/v1/cloud:box/get-collaborations-id":{"get":{"operationId":"cloud_box_get_collaborations_id","summary":"Get collaboration","description":"GET /collaborations/{collaboration_id}","tags":["cloud"],"parameters":[{"name":"collaboration_id","in":"query","required":true,"description":"The ID of the collaboration.","schema":{"type":"string","description":"The ID of the collaboration."},"example":"1234"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}}],"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":"byok"}},"/v1/cloud:box/put-collaborations-id":{"post":{"operationId":"cloud_box_put_collaborations_id","summary":"Update collaboration","description":"PUT /collaborations/{collaboration_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["collaboration_id"],"properties":{"collaboration_id":{"type":"string","description":"The ID of the collaboration."},"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":"byok"}},"/v1/cloud:box/delete-collaborations-id":{"post":{"operationId":"cloud_box_delete_collaborations_id","summary":"Remove collaboration","description":"DELETE /collaborations/{collaboration_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["collaboration_id"],"properties":{"collaboration_id":{"type":"string","description":"The ID of the collaboration."}}}}}},"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":"byok"}},"/v1/cloud:box/get-collaborations":{"get":{"operationId":"cloud_box_get_collaborations","summary":"List pending collaborations","description":"GET /collaborations","tags":["cloud"],"parameters":[{"name":"status","in":"query","required":true,"description":"The status of the collaborations to retrieve.","schema":{"type":"string","enum":["pending"],"description":"The status of the collaborations to retrieve."},"example":"pending"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"offset","in":"query","required":false,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…","schema":{"type":"integer","default":0,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…"},"example":1000},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-collaborations":{"post":{"operationId":"cloud_box_post_collaborations","summary":"Create collaboration","description":"POST /collaborations","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"notify":{"type":"boolean","description":"Determines if users should receive email notification for the action performed."},"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":"byok"}},"/v1/cloud:box/get-search":{"get":{"operationId":"cloud_box_get_search","summary":"Search for content","description":"GET /search","tags":["cloud"],"parameters":[{"name":"query","in":"query","required":false,"description":"The string to search for. This query is matched against item names, descriptions, text content of files, and various other fields of the…","schema":{"type":"string","description":"The string to search for. This query is matched against item names, descriptions, text content of files, and various other fields of the…"},"example":"sales"},{"name":"scope","in":"query","required":false,"description":"Limits the search results to either the files that the user has access to, or to files available to the entire enterprise. The scope…","schema":{"type":"string","enum":["user_content","enterprise_content"],"default":"user_content","description":"Limits the search results to either the files that the user has access to, or to files available to the entire enterprise. The scope…"},"example":"user_content"},{"name":"file_extensions","in":"query","required":false,"description":"Limits the search results to any files that match any of the provided file extensions. This list is a comma-separated list of file…","schema":{"type":"array","description":"Limits the search results to any files that match any of the provided file extensions. This list is a comma-separated list of file…"}},{"name":"created_at_range","in":"query","required":false,"description":"Limits the search results to any items created within a given date range. Date ranges are defined as comma separated RFC3339 timestamps.…","schema":{"type":"array","description":"Limits the search results to any items created within a given date range. Date ranges are defined as comma separated RFC3339 timestamps.…"}},{"name":"updated_at_range","in":"query","required":false,"description":"Limits the search results to any items updated within a given date range. Date ranges are defined as comma separated RFC3339 timestamps.…","schema":{"type":"array","description":"Limits the search results to any items updated within a given date range. Date ranges are defined as comma separated RFC3339 timestamps.…"}},{"name":"size_range","in":"query","required":false,"description":"Limits the search results to any items with a size within a given file size range. This applied to files and folders. Size ranges are…","schema":{"type":"array","description":"Limits the search results to any items with a size within a given file size range. This applied to files and folders. Size ranges are…"}},{"name":"owner_user_ids","in":"query","required":false,"description":"Limits the search results to any items that are owned by the given list of owners, defined as a list of comma separated user IDs. The…","schema":{"type":"array","description":"Limits the search results to any items that are owned by the given list of owners, defined as a list of comma separated user IDs. The…"}},{"name":"recent_updater_user_ids","in":"query","required":false,"description":"Limits the search results to any items that have been updated by the given list of users, defined as a list of comma separated user IDs.…","schema":{"type":"array","description":"Limits the search results to any items that have been updated by the given list of users, defined as a list of comma separated user IDs.…"}},{"name":"ancestor_folder_ids","in":"query","required":false,"description":"Limits the search results to items within the given list of folders, defined as a comma separated lists of folder IDs. Search results will…","schema":{"type":"array","description":"Limits the search results to items within the given list of folders, defined as a comma separated lists of folder IDs. Search results will…"}},{"name":"content_types","in":"query","required":false,"description":"Limits the search results to any items that match the search query for a specific part of the file, for example the file description.…","schema":{"type":"array","description":"Limits the search results to any items that match the search query for a specific part of the file, for example the file description.…"}},{"name":"type","in":"query","required":false,"description":"Limits the search results to any items of this type. This parameter only takes one value. By default the API returns items that match any…","schema":{"type":"string","enum":["file","folder","web_link"],"description":"Limits the search results to any items of this type. This parameter only takes one value. By default the API returns items that match any…"},"example":"file"},{"name":"trash_content","in":"query","required":false,"description":"Determines if the search should look in the trash for items. By default, this API only returns search results for items not currently in…","schema":{"type":"string","enum":["non_trashed_only","trashed_only","all_items"],"default":"non_trashed_only","description":"Determines if the search should look in the trash for items. By default, this API only returns search results for items not currently in…"},"example":"non_trashed_only"},{"name":"mdfilters","in":"query","required":false,"description":"Limits the search results to any items for which the metadata matches the provided filter. This parameter is a list that specifies exactly…","schema":{"type":"array","description":"Limits the search results to any items for which the metadata matches the provided filter. This parameter is a list that specifies exactly…"}},{"name":"sort","in":"query","required":false,"description":"Defines the order in which search results are returned. This API defaults to returning items by relevance unless this parameter is…","schema":{"type":"string","enum":["modified_at","relevance"],"default":"relevance","description":"Defines the order in which search results are returned. This API defaults to returning items by relevance unless this parameter is…"},"example":"modified_at"},{"name":"direction","in":"query","required":false,"description":"Defines the direction in which search results are ordered. This API defaults to returning items in descending (`DESC`) order unless this…","schema":{"type":"string","enum":["DESC","ASC"],"default":"DESC","description":"Defines the direction in which search results are ordered. This API defaults to returning items in descending (`DESC`) order unless this…"},"example":"ASC"},{"name":"limit","in":"query","required":false,"description":"Defines the maximum number of items to return as part of a page of results.","schema":{"type":"integer","default":30,"description":"Defines the maximum number of items to return as part of a page of results."},"example":100},{"name":"include_recent_shared_links","in":"query","required":false,"description":"Defines whether the search results should include any items that the user recently accessed through a shared link. When this parameter has…","schema":{"type":"boolean","default":false,"description":"Defines whether the search results should include any items that the user recently accessed through a shared link. When this parameter has…"},"example":true},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"offset","in":"query","required":false,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…","schema":{"type":"integer","default":0,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…"},"example":1000},{"name":"deleted_user_ids","in":"query","required":false,"description":"Limits the search results to items that were deleted by the given list of users, defined as a list of comma separated user IDs. The…","schema":{"type":"array","description":"Limits the search results to items that were deleted by the given list of users, defined as a list of comma separated user IDs. The…"}},{"name":"deleted_at_range","in":"query","required":false,"description":"Limits the search results to any items deleted within a given date range. Date ranges are defined as comma separated RFC3339 timestamps.…","schema":{"type":"array","description":"Limits the search results to any items deleted within a given date range. Date ranges are defined as comma separated RFC3339 timestamps.…"}}],"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":"byok"}},"/v1/cloud:box/post-tasks":{"post":{"operationId":"cloud_box_post_tasks","summary":"Create task","description":"POST /tasks","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-tasks-id":{"get":{"operationId":"cloud_box_get_tasks_id","summary":"Get task","description":"GET /tasks/{task_id}","tags":["cloud"],"parameters":[{"name":"task_id","in":"query","required":true,"description":"The ID of the task.","schema":{"type":"string","description":"The ID of the task."},"example":"12345"}],"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":"byok"}},"/v1/cloud:box/put-tasks-id":{"post":{"operationId":"cloud_box_put_tasks_id","summary":"Update task","description":"PUT /tasks/{task_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["task_id"],"properties":{"task_id":{"type":"string","description":"The ID of the task."},"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":"byok"}},"/v1/cloud:box/delete-tasks-id":{"post":{"operationId":"cloud_box_delete_tasks_id","summary":"Remove task","description":"DELETE /tasks/{task_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["task_id"],"properties":{"task_id":{"type":"string","description":"The ID of the task."}}}}}},"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":"byok"}},"/v1/cloud:box/get-tasks-id-assignments":{"get":{"operationId":"cloud_box_get_tasks_id_assignments","summary":"List task assignments","description":"GET /tasks/{task_id}/assignments","tags":["cloud"],"parameters":[{"name":"task_id","in":"query","required":true,"description":"The ID of the task.","schema":{"type":"string","description":"The ID of the task."},"example":"12345"}],"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":"byok"}},"/v1/cloud:box/post-task-assignments":{"post":{"operationId":"cloud_box_post_task_assignments","summary":"Assign task","description":"POST /task_assignments","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-task-assignments-id":{"get":{"operationId":"cloud_box_get_task_assignments_id","summary":"Get task assignment","description":"GET /task_assignments/{task_assignment_id}","tags":["cloud"],"parameters":[{"name":"task_assignment_id","in":"query","required":true,"description":"The ID of the task assignment.","schema":{"type":"string","description":"The ID of the task assignment."},"example":"12345"}],"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":"byok"}},"/v1/cloud:box/put-task-assignments-id":{"post":{"operationId":"cloud_box_put_task_assignments_id","summary":"Update task assignment","description":"PUT /task_assignments/{task_assignment_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["task_assignment_id"],"properties":{"task_assignment_id":{"type":"string","description":"The ID of the task assignment."},"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":"byok"}},"/v1/cloud:box/delete-task-assignments-id":{"post":{"operationId":"cloud_box_delete_task_assignments_id","summary":"Unassign task","description":"DELETE /task_assignments/{task_assignment_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["task_assignment_id"],"properties":{"task_assignment_id":{"type":"string","description":"The ID of the task assignment."}}}}}},"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":"byok"}},"/v1/cloud:box/get-shared-items":{"get":{"operationId":"cloud_box_get_shared_items","summary":"Find file for shared link","description":"GET /shared_items","tags":["cloud"],"parameters":[{"name":"if-none-match","in":"query","required":false,"description":"Ensures an item is only returned if it has changed. Pass in the item's last observed `etag` value into this header and the endpoint will…","schema":{"type":"string","description":"Ensures an item is only returned if it has changed. Pass in the item's last observed `etag` value into this header and the endpoint will…"},"example":"1"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"boxapi","in":"query","required":true,"description":"A header containing the shared link and optional password for the shared link. The format for this header is as follows:…","schema":{"type":"string","description":"A header containing the shared link and optional password for the shared link. The format for this header is as follows:…"},"example":"shared_link=[link]&shared_link_password=[password]"}],"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":"byok"}},"/v1/cloud:box/get-files-id-get-shared-link":{"get":{"operationId":"cloud_box_get_files_id_get_shared_link","summary":"Get shared link for file","description":"GET /files/{file_id}","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":true,"description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…","schema":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"example":"12345"},{"name":"fields","in":"query","required":true,"description":"Explicitly request the `shared_link` fields to be returned for this item.","schema":{"type":"string","description":"Explicitly request the `shared_link` fields to be returned for this item."},"example":"shared_link"}],"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":"byok"}},"/v1/cloud:box/put-files-id-add-shared-link":{"post":{"operationId":"cloud_box_put_files_id_add_shared_link","summary":"Add shared link to file","description":"PUT /files/{file_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id","fields"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"fields":{"type":"string","description":"Explicitly request the `shared_link` fields to be returned for this item."},"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":"byok"}},"/v1/cloud:box/put-files-id-update-shared-link":{"post":{"operationId":"cloud_box_put_files_id_update_shared_link","summary":"Update shared link on file","description":"PUT /files/{file_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id","fields"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"fields":{"type":"string","description":"Explicitly request the `shared_link` fields to be returned for this item."},"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":"byok"}},"/v1/cloud:box/put-files-id-remove-shared-link":{"post":{"operationId":"cloud_box_put_files_id_remove_shared_link","summary":"Remove shared link from file","description":"PUT /files/{file_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id","fields"],"properties":{"file_id":{"type":"string","description":"The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying…"},"fields":{"type":"string","description":"Explicitly request the `shared_link` fields to be returned for this item."},"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":"byok"}},"/v1/cloud:box/get-shared-items-folders":{"get":{"operationId":"cloud_box_get_shared_items_folders","summary":"Find folder for shared link","description":"GET /shared_items","tags":["cloud"],"parameters":[{"name":"if-none-match","in":"query","required":false,"description":"Ensures an item is only returned if it has changed. Pass in the item's last observed `etag` value into this header and the endpoint will…","schema":{"type":"string","description":"Ensures an item is only returned if it has changed. Pass in the item's last observed `etag` value into this header and the endpoint will…"},"example":"1"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"boxapi","in":"query","required":true,"description":"A header containing the shared link and optional password for the shared link. The format for this header is as follows:…","schema":{"type":"string","description":"A header containing the shared link and optional password for the shared link. The format for this header is as follows:…"},"example":"shared_link=[link]&shared_link_password=[password]"}],"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":"byok"}},"/v1/cloud:box/get-folders-id-get-shared-link":{"get":{"operationId":"cloud_box_get_folders_id_get_shared_link","summary":"Get shared link for folder","description":"GET /folders/{folder_id}","tags":["cloud"],"parameters":[{"name":"folder_id","in":"query","required":true,"description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…","schema":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"example":"12345"},{"name":"fields","in":"query","required":true,"description":"Explicitly request the `shared_link` fields to be returned for this item.","schema":{"type":"string","description":"Explicitly request the `shared_link` fields to be returned for this item."},"example":"shared_link"}],"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":"byok"}},"/v1/cloud:box/put-folders-id-add-shared-link":{"post":{"operationId":"cloud_box_put_folders_id_add_shared_link","summary":"Add shared link to folder","description":"PUT /folders/{folder_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_id","fields"],"properties":{"folder_id":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"fields":{"type":"string","description":"Explicitly request the `shared_link` fields to be returned for this item."},"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":"byok"}},"/v1/cloud:box/put-folders-id-update-shared-link":{"post":{"operationId":"cloud_box_put_folders_id_update_shared_link","summary":"Update shared link on folder","description":"PUT /folders/{folder_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_id","fields"],"properties":{"folder_id":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"fields":{"type":"string","description":"Explicitly request the `shared_link` fields to be returned for this item."},"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":"byok"}},"/v1/cloud:box/put-folders-id-remove-shared-link":{"post":{"operationId":"cloud_box_put_folders_id_remove_shared_link","summary":"Remove shared link from folder","description":"PUT /folders/{folder_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folder_id","fields"],"properties":{"folder_id":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"fields":{"type":"string","description":"Explicitly request the `shared_link` fields to be returned for this item."},"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":"byok"}},"/v1/cloud:box/post-web-links":{"post":{"operationId":"cloud_box_post_web_links","summary":"Create web link","description":"POST /web_links","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-web-links-id":{"get":{"operationId":"cloud_box_get_web_links_id","summary":"Get web link","description":"GET /web_links/{web_link_id}","tags":["cloud"],"parameters":[{"name":"web_link_id","in":"query","required":true,"description":"The ID of the web link.","schema":{"type":"string","description":"The ID of the web link."},"example":"12345"},{"name":"boxapi","in":"query","required":false,"description":"The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly…","schema":{"type":"string","description":"The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly…"},"example":"shared_link=[link]&shared_link_password=[password]"}],"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":"byok"}},"/v1/cloud:box/post-web-links-id":{"post":{"operationId":"cloud_box_post_web_links_id","summary":"Restore web link","description":"POST /web_links/{web_link_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["web_link_id"],"properties":{"web_link_id":{"type":"string","description":"The ID of the web link."},"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"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":"byok"}},"/v1/cloud:box/put-web-links-id":{"post":{"operationId":"cloud_box_put_web_links_id","summary":"Update web link","description":"PUT /web_links/{web_link_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["web_link_id"],"properties":{"web_link_id":{"type":"string","description":"The ID of the web link."},"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":"byok"}},"/v1/cloud:box/delete-web-links-id":{"post":{"operationId":"cloud_box_delete_web_links_id","summary":"Remove web link","description":"DELETE /web_links/{web_link_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["web_link_id"],"properties":{"web_link_id":{"type":"string","description":"The ID of the web link."}}}}}},"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":"byok"}},"/v1/cloud:box/get-web-links-id-trash":{"get":{"operationId":"cloud_box_get_web_links_id_trash","summary":"Get trashed web link","description":"GET /web_links/{web_link_id}/trash","tags":["cloud"],"parameters":[{"name":"web_link_id","in":"query","required":true,"description":"The ID of the web link.","schema":{"type":"string","description":"The ID of the web link."},"example":"12345"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}}],"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":"byok"}},"/v1/cloud:box/delete-web-links-id-trash":{"post":{"operationId":"cloud_box_delete_web_links_id_trash","summary":"Permanently remove web link","description":"DELETE /web_links/{web_link_id}/trash","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["web_link_id"],"properties":{"web_link_id":{"type":"string","description":"The ID of the web link."}}}}}},"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":"byok"}},"/v1/cloud:box/get-shared-items-web-links":{"get":{"operationId":"cloud_box_get_shared_items_web_links","summary":"Find web link for shared link","description":"GET /shared_items","tags":["cloud"],"parameters":[{"name":"if-none-match","in":"query","required":false,"description":"Ensures an item is only returned if it has changed. Pass in the item's last observed `etag` value into this header and the endpoint will…","schema":{"type":"string","description":"Ensures an item is only returned if it has changed. Pass in the item's last observed `etag` value into this header and the endpoint will…"},"example":"1"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"boxapi","in":"query","required":true,"description":"A header containing the shared link and optional password for the shared link. The format for this header is as follows:…","schema":{"type":"string","description":"A header containing the shared link and optional password for the shared link. The format for this header is as follows:…"},"example":"shared_link=[link]&shared_link_password=[password]"}],"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":"byok"}},"/v1/cloud:box/get-web-links-id-get-shared-link":{"get":{"operationId":"cloud_box_get_web_links_id_get_shared_link","summary":"Get shared link for web link","description":"GET /web_links/{web_link_id}","tags":["cloud"],"parameters":[{"name":"web_link_id","in":"query","required":true,"description":"The ID of the web link.","schema":{"type":"string","description":"The ID of the web link."},"example":"12345"},{"name":"fields","in":"query","required":true,"description":"Explicitly request the `shared_link` fields to be returned for this item.","schema":{"type":"string","description":"Explicitly request the `shared_link` fields to be returned for this item."},"example":"shared_link"}],"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":"byok"}},"/v1/cloud:box/put-web-links-id-add-shared-link":{"post":{"operationId":"cloud_box_put_web_links_id_add_shared_link","summary":"Add shared link to web link","description":"PUT /web_links/{web_link_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["web_link_id","fields"],"properties":{"web_link_id":{"type":"string","description":"The ID of the web link."},"fields":{"type":"string","description":"Explicitly request the `shared_link` fields to be returned for this item."},"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":"byok"}},"/v1/cloud:box/put-web-links-id-update-shared-link":{"post":{"operationId":"cloud_box_put_web_links_id_update_shared_link","summary":"Update shared link on web link","description":"PUT /web_links/{web_link_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["web_link_id","fields"],"properties":{"web_link_id":{"type":"string","description":"The ID of the web link."},"fields":{"type":"string","description":"Explicitly request the `shared_link` fields to be returned for this item."},"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":"byok"}},"/v1/cloud:box/put-web-links-id-remove-shared-link":{"post":{"operationId":"cloud_box_put_web_links_id_remove_shared_link","summary":"Remove shared link from web link","description":"PUT /web_links/{web_link_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["web_link_id","fields"],"properties":{"web_link_id":{"type":"string","description":"The ID of the web link."},"fields":{"type":"string","description":"Explicitly request the `shared_link` fields to be returned for this item."},"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":"byok"}},"/v1/cloud:box/get-shared-items-app-items":{"get":{"operationId":"cloud_box_get_shared_items_app_items","summary":"Find app item for shared link","description":"GET /shared_items","tags":["cloud"],"parameters":[{"name":"boxapi","in":"query","required":true,"description":"A header containing the shared link and optional password for the shared link. The format for this header is…","schema":{"type":"string","description":"A header containing the shared link and optional password for the shared link. The format for this header is…"},"example":"shared_link=[example.com]&shared_link_password=[xyz123]"}],"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":"byok"}},"/v1/cloud:box/get-users":{"get":{"operationId":"cloud_box_get_users","summary":"List enterprise users","description":"GET /users","tags":["cloud"],"parameters":[{"name":"filter_term","in":"query","required":false,"description":"Limits the results to only users who's `name` or `login` start with the search term. For externally managed users, the search term needs…","schema":{"type":"string","description":"Limits the results to only users who's `name` or `login` start with the search term. For externally managed users, the search term needs…"},"example":"john"},{"name":"user_type","in":"query","required":false,"description":"Limits the results to the kind of user specified. * `all` returns every kind of user for whom the `login` or `name` partially matches the…","schema":{"type":"string","enum":["all","managed","external"],"description":"Limits the results to the kind of user specified. * `all` returns every kind of user for whom the `login` or `name` partially matches the…"},"example":"managed"},{"name":"external_app_user_id","in":"query","required":false,"description":"Limits the results to app users with the given `external_app_user_id` value. When creating an app user, an `external_app_user_id` value…","schema":{"type":"string","description":"Limits the results to app users with the given `external_app_user_id` value. When creating an app user, an `external_app_user_id` value…"},"example":"my-user-1234"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"offset","in":"query","required":false,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…","schema":{"type":"integer","default":0,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…"},"example":1000},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"usemarker","in":"query","required":false,"description":"Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By…","schema":{"type":"boolean","description":"Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By…"},"example":true},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"}],"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":"byok"}},"/v1/cloud:box/post-users":{"post":{"operationId":"cloud_box_post_users","summary":"Create user","description":"POST /users","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"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":"byok"}},"/v1/cloud:box/get-users-me":{"get":{"operationId":"cloud_box_get_users_me","summary":"Get current user","description":"GET /users/me","tags":["cloud"],"parameters":[{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}}],"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":"byok"}},"/v1/cloud:box/post-users-terminate-sessions":{"post":{"operationId":"cloud_box_post_users_terminate_sessions","summary":"Create jobs to terminate users session","description":"POST /users/terminate_sessions","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-users-id":{"get":{"operationId":"cloud_box_get_users_id","summary":"Get user","description":"GET /users/{user_id}","tags":["cloud"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"The ID of the user.","schema":{"type":"string","description":"The ID of the user."},"example":"12345"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}}],"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":"byok"}},"/v1/cloud:box/put-users-id":{"post":{"operationId":"cloud_box_put_users_id","summary":"Update user","description":"PUT /users/{user_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user."},"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"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":"byok"}},"/v1/cloud:box/delete-users-id":{"post":{"operationId":"cloud_box_delete_users_id","summary":"Delete user","description":"DELETE /users/{user_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user."},"notify":{"type":"boolean","description":"Whether the user will receive email notification of the deletion."},"force":{"type":"boolean","description":"Specifies whether to delete the user even if they still own files. If the user owns content and the enterprise has a retention policy,…"}}}}}},"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":"byok"}},"/v1/cloud:box/get-users-id-avatar":{"get":{"operationId":"cloud_box_get_users_id_avatar","summary":"Get user avatar","description":"GET /users/{user_id}/avatar","tags":["cloud"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"The ID of the user.","schema":{"type":"string","description":"The ID of the user."},"example":"12345"}],"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":"byok"}},"/v1/cloud:box/post-users-id-avatar":{"post":{"operationId":"cloud_box_post_users_id_avatar","summary":"Add or update user avatar","description":"POST /users/{user_id}/avatar","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user."},"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":"byok"}},"/v1/cloud:box/delete-users-id-avatar":{"post":{"operationId":"cloud_box_delete_users_id_avatar","summary":"Delete user avatar","description":"DELETE /users/{user_id}/avatar","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user."}}}}}},"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":"byok"}},"/v1/cloud:box/put-users-id-folders-0":{"post":{"operationId":"cloud_box_put_users_id_folders_0","summary":"Transfer owned folders","description":"PUT /users/{user_id}/folders/0","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user."},"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"notify":{"type":"boolean","description":"Determines if users should receive email notification for the action performed."},"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":"byok"}},"/v1/cloud:box/get-users-id-email-aliases":{"get":{"operationId":"cloud_box_get_users_id_email_aliases","summary":"List user's email aliases","description":"GET /users/{user_id}/email_aliases","tags":["cloud"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"The ID of the user.","schema":{"type":"string","description":"The ID of the user."},"example":"12345"}],"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":"byok"}},"/v1/cloud:box/post-users-id-email-aliases":{"post":{"operationId":"cloud_box_post_users_id_email_aliases","summary":"Create email alias","description":"POST /users/{user_id}/email_aliases","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user."},"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":"byok"}},"/v1/cloud:box/delete-users-id-email-aliases-id":{"post":{"operationId":"cloud_box_delete_users_id_email_aliases_id","summary":"Remove email alias","description":"DELETE /users/{user_id}/email_aliases/{email_alias_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id","email_alias_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user."},"email_alias_id":{"type":"string","description":"The ID of the email alias."}}}}}},"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":"byok"}},"/v1/cloud:box/get-users-id-memberships":{"get":{"operationId":"cloud_box_get_users_id_memberships","summary":"List user's groups","description":"GET /users/{user_id}/memberships","tags":["cloud"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"The ID of the user.","schema":{"type":"string","description":"The ID of the user."},"example":"12345"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"offset","in":"query","required":false,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…","schema":{"type":"integer","default":0,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…"},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-invites":{"post":{"operationId":"cloud_box_post_invites","summary":"Create user invite","description":"POST /invites","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"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":"byok"}},"/v1/cloud:box/get-invites-id":{"get":{"operationId":"cloud_box_get_invites_id","summary":"Get user invite status","description":"GET /invites/{invite_id}","tags":["cloud"],"parameters":[{"name":"invite_id","in":"query","required":true,"description":"The ID of an invite.","schema":{"type":"string","description":"The ID of an invite."},"example":"213723"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}}],"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":"byok"}},"/v1/cloud:box/get-groups":{"get":{"operationId":"cloud_box_get_groups","summary":"List groups for enterprise","description":"GET /groups","tags":["cloud"],"parameters":[{"name":"filter_term","in":"query","required":false,"description":"Limits the results to only groups whose `name` starts with the search term.","schema":{"type":"string","description":"Limits the results to only groups whose `name` starts with the search term."},"example":"Engineering"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"offset","in":"query","required":false,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…","schema":{"type":"integer","default":0,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…"},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-groups":{"post":{"operationId":"cloud_box_post_groups","summary":"Create group","description":"POST /groups","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"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":"byok"}},"/v1/cloud:box/post-groups-terminate-sessions":{"post":{"operationId":"cloud_box_post_groups_terminate_sessions","summary":"Create jobs to terminate user group session","description":"POST /groups/terminate_sessions","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-groups-id":{"get":{"operationId":"cloud_box_get_groups_id","summary":"Get group","description":"GET /groups/{group_id}","tags":["cloud"],"parameters":[{"name":"group_id","in":"query","required":true,"description":"The ID of the group.","schema":{"type":"string","description":"The ID of the group."},"example":"57645"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}}],"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":"byok"}},"/v1/cloud:box/put-groups-id":{"post":{"operationId":"cloud_box_put_groups_id","summary":"Update group","description":"PUT /groups/{group_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["group_id"],"properties":{"group_id":{"type":"string","description":"The ID of the group."},"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"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":"byok"}},"/v1/cloud:box/delete-groups-id":{"post":{"operationId":"cloud_box_delete_groups_id","summary":"Remove group","description":"DELETE /groups/{group_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["group_id"],"properties":{"group_id":{"type":"string","description":"The ID of the group."}}}}}},"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":"byok"}},"/v1/cloud:box/get-groups-id-memberships":{"get":{"operationId":"cloud_box_get_groups_id_memberships","summary":"List members of group","description":"GET /groups/{group_id}/memberships","tags":["cloud"],"parameters":[{"name":"group_id","in":"query","required":true,"description":"The ID of the group.","schema":{"type":"string","description":"The ID of the group."},"example":"57645"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"offset","in":"query","required":false,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…","schema":{"type":"integer","default":0,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…"},"example":1000}],"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":"byok"}},"/v1/cloud:box/get-groups-id-collaborations":{"get":{"operationId":"cloud_box_get_groups_id_collaborations","summary":"List group collaborations","description":"GET /groups/{group_id}/collaborations","tags":["cloud"],"parameters":[{"name":"group_id","in":"query","required":true,"description":"The ID of the group.","schema":{"type":"string","description":"The ID of the group."},"example":"57645"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"offset","in":"query","required":false,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…","schema":{"type":"integer","default":0,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…"},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-group-memberships":{"post":{"operationId":"cloud_box_post_group_memberships","summary":"Add user to group","description":"POST /group_memberships","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"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":"byok"}},"/v1/cloud:box/get-group-memberships-id":{"get":{"operationId":"cloud_box_get_group_memberships_id","summary":"Get group membership","description":"GET /group_memberships/{group_membership_id}","tags":["cloud"],"parameters":[{"name":"group_membership_id","in":"query","required":true,"description":"The ID of the group membership.","schema":{"type":"string","description":"The ID of the group membership."},"example":"434534"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}}],"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":"byok"}},"/v1/cloud:box/put-group-memberships-id":{"post":{"operationId":"cloud_box_put_group_memberships_id","summary":"Update group membership","description":"PUT /group_memberships/{group_membership_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["group_membership_id"],"properties":{"group_membership_id":{"type":"string","description":"The ID of the group membership."},"fields":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"},"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":"byok"}},"/v1/cloud:box/delete-group-memberships-id":{"post":{"operationId":"cloud_box_delete_group_memberships_id","summary":"Remove user from group","description":"DELETE /group_memberships/{group_membership_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["group_membership_id"],"properties":{"group_membership_id":{"type":"string","description":"The ID of the group membership."}}}}}},"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":"byok"}},"/v1/cloud:box/get-webhooks":{"get":{"operationId":"cloud_box_get_webhooks","summary":"List all webhooks","description":"GET /webhooks","tags":["cloud"],"parameters":[{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-webhooks":{"post":{"operationId":"cloud_box_post_webhooks","summary":"Create webhook","description":"POST /webhooks","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-webhooks-id":{"get":{"operationId":"cloud_box_get_webhooks_id","summary":"Get webhook","description":"GET /webhooks/{webhook_id}","tags":["cloud"],"parameters":[{"name":"webhook_id","in":"query","required":true,"description":"The ID of the webhook.","schema":{"type":"string","description":"The ID of the webhook."},"example":"3321123"}],"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":"byok"}},"/v1/cloud:box/put-webhooks-id":{"post":{"operationId":"cloud_box_put_webhooks_id","summary":"Update webhook","description":"PUT /webhooks/{webhook_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhook_id"],"properties":{"webhook_id":{"type":"string","description":"The ID of the webhook."},"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":"byok"}},"/v1/cloud:box/delete-webhooks-id":{"post":{"operationId":"cloud_box_delete_webhooks_id","summary":"Remove webhook","description":"DELETE /webhooks/{webhook_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhook_id"],"properties":{"webhook_id":{"type":"string","description":"The ID of the webhook."}}}}}},"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":"byok"}},"/v1/cloud:box/put-skill-invocations-id":{"post":{"operationId":"cloud_box_put_skill_invocations_id","summary":"Update all Box Skill cards on file","description":"PUT /skill_invocations/{skill_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["skill_id"],"properties":{"skill_id":{"type":"string","description":"The ID of the skill to apply this metadata 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":"byok"}},"/v1/cloud:box/get-events":{"get":{"operationId":"cloud_box_get_events","summary":"List user and enterprise events","description":"GET /events","tags":["cloud"],"parameters":[{"name":"stream_type","in":"query","required":false,"description":"Defines the type of events that are returned * `all` returns everything for a user and is the default * `changes` returns events that may…","schema":{"type":"string","enum":["all","changes","sync","admin_logs","admin_logs_streaming"],"default":"all","description":"Defines the type of events that are returned * `all` returns everything for a user and is the default * `changes` returns events that may…"},"example":"all"},{"name":"stream_position","in":"query","required":false,"description":"The location in the event stream to start receiving events from. * `now` will return an empty list events and the latest stream position…","schema":{"type":"string","description":"The location in the event stream to start receiving events from. * `now` will return an empty list events and the latest stream position…"},"example":"1348790499819"},{"name":"limit","in":"query","required":false,"description":"Limits the number of events returned. Note: Sometimes, the events less than the limit requested can be returned even when there may be…","schema":{"type":"integer","default":100,"description":"Limits the number of events returned. Note: Sometimes, the events less than the limit requested can be returned even when there may be…"},"example":50},{"name":"event_type","in":"query","required":false,"description":"A comma-separated list of events to filter by. This can only be used when requesting the events with a `stream_type` of `admin_logs` or…","schema":{"type":"array","description":"A comma-separated list of events to filter by. This can only be used when requesting the events with a `stream_type` of `admin_logs` or…"}},{"name":"created_after","in":"query","required":false,"description":"The lower bound date and time to return events for. This can only be used when requesting the events with a `stream_type` of `admin_logs`.…","schema":{"type":"string","description":"The lower bound date and time to return events for. This can only be used when requesting the events with a `stream_type` of `admin_logs`.…"},"example":"2012-12-12T10:53:43-08:00"},{"name":"created_before","in":"query","required":false,"description":"The upper bound date and time to return events for. This can only be used when requesting the events with a `stream_type` of `admin_logs`.…","schema":{"type":"string","description":"The upper bound date and time to return events for. This can only be used when requesting the events with a `stream_type` of `admin_logs`.…"},"example":"2013-12-12T10:53:43-08:00"}],"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":"byok"}},"/v1/cloud:box/get-collections":{"get":{"operationId":"cloud_box_get_collections","summary":"List all collections","description":"GET /collections","tags":["cloud"],"parameters":[{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"offset","in":"query","required":false,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…","schema":{"type":"integer","default":0,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…"},"example":1000},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/get-collections-id-items":{"get":{"operationId":"cloud_box_get_collections_id_items","summary":"List collection items","description":"GET /collections/{collection_id}/items","tags":["cloud"],"parameters":[{"name":"collection_id","in":"query","required":true,"description":"The ID of the collection.","schema":{"type":"string","description":"The ID of the collection."},"example":"926489"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"offset","in":"query","required":false,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…","schema":{"type":"integer","default":0,"description":"The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400…"},"example":1000},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/get-collections-id":{"get":{"operationId":"cloud_box_get_collections_id","summary":"Get collection by ID","description":"GET /collections/{collection_id}","tags":["cloud"],"parameters":[{"name":"collection_id","in":"query","required":true,"description":"The ID of the collection.","schema":{"type":"string","description":"The ID of the collection."},"example":"926489"}],"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":"byok"}},"/v1/cloud:box/get-recent-items":{"get":{"operationId":"cloud_box_get_recent_items","summary":"List recently accessed items","description":"GET /recent_items","tags":["cloud"],"parameters":[{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"}],"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":"byok"}},"/v1/cloud:box/get-retention-policies":{"get":{"operationId":"cloud_box_get_retention_policies","summary":"List retention policies","description":"GET /retention_policies","tags":["cloud"],"parameters":[{"name":"policy_name","in":"query","required":false,"description":"Filters results by a case sensitive prefix of the name of retention policies.","schema":{"type":"string","description":"Filters results by a case sensitive prefix of the name of retention policies."},"example":"Sales Policy"},{"name":"policy_type","in":"query","required":false,"description":"Filters results by the type of retention policy.","schema":{"type":"string","enum":["finite","indefinite"],"description":"Filters results by the type of retention policy."},"example":"finite"},{"name":"created_by_user_id","in":"query","required":false,"description":"Filters results by the ID of the user who created policy.","schema":{"type":"string","description":"Filters results by the ID of the user who created policy."},"example":"21312321"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination."},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"}],"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":"byok"}},"/v1/cloud:box/post-retention-policies":{"post":{"operationId":"cloud_box_post_retention_policies","summary":"Create retention policy","description":"POST /retention_policies","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-retention-policies-id":{"get":{"operationId":"cloud_box_get_retention_policies_id","summary":"Get retention policy","description":"GET /retention_policies/{retention_policy_id}","tags":["cloud"],"parameters":[{"name":"retention_policy_id","in":"query","required":true,"description":"The ID of the retention policy.","schema":{"type":"string","description":"The ID of the retention policy."},"example":"982312"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}}],"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":"byok"}},"/v1/cloud:box/put-retention-policies-id":{"post":{"operationId":"cloud_box_put_retention_policies_id","summary":"Update retention policy","description":"PUT /retention_policies/{retention_policy_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["retention_policy_id"],"properties":{"retention_policy_id":{"type":"string","description":"The ID of the retention policy."},"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":"byok"}},"/v1/cloud:box/delete-retention-policies-id":{"post":{"operationId":"cloud_box_delete_retention_policies_id","summary":"Delete retention policy","description":"DELETE /retention_policies/{retention_policy_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["retention_policy_id"],"properties":{"retention_policy_id":{"type":"string","description":"The ID of the retention policy."}}}}}},"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":"byok"}},"/v1/cloud:box/get-retention-policies-id-assignments":{"get":{"operationId":"cloud_box_get_retention_policies_id_assignments","summary":"List retention policy assignments","description":"GET /retention_policies/{retention_policy_id}/assignments","tags":["cloud"],"parameters":[{"name":"retention_policy_id","in":"query","required":true,"description":"The ID of the retention policy.","schema":{"type":"string","description":"The ID of the retention policy."},"example":"982312"},{"name":"type","in":"query","required":false,"description":"The type of the retention policy assignment to retrieve.","schema":{"type":"string","enum":["folder","enterprise","metadata_template"],"description":"The type of the retention policy assignment to retrieve."},"example":"metadata_template"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination."},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-retention-policy-assignments":{"post":{"operationId":"cloud_box_post_retention_policy_assignments","summary":"Assign retention policy","description":"POST /retention_policy_assignments","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-retention-policy-assignments-id":{"get":{"operationId":"cloud_box_get_retention_policy_assignments_id","summary":"Get retention policy assignment","description":"GET /retention_policy_assignments/{retention_policy_assignment_id}","tags":["cloud"],"parameters":[{"name":"retention_policy_assignment_id","in":"query","required":true,"description":"The ID of the retention policy assignment.","schema":{"type":"string","description":"The ID of the retention policy assignment."},"example":"1233123"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}}],"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":"byok"}},"/v1/cloud:box/delete-retention-policy-assignments-id":{"post":{"operationId":"cloud_box_delete_retention_policy_assignments_id","summary":"Remove retention policy assignment","description":"DELETE /retention_policy_assignments/{retention_policy_assignment_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["retention_policy_assignment_id"],"properties":{"retention_policy_assignment_id":{"type":"string","description":"The ID of the retention policy assignment."}}}}}},"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":"byok"}},"/v1/cloud:box/get-retention-policy-assignments-id-files-under-retention":{"get":{"operationId":"cloud_box_get_retention_policy_assignments_id_files_under_retention","summary":"Get files under retention","description":"GET /retention_policy_assignments/{retention_policy_assignment_id}/files_under_retention","tags":["cloud"],"parameters":[{"name":"retention_policy_assignment_id","in":"query","required":true,"description":"The ID of the retention policy assignment.","schema":{"type":"string","description":"The ID of the retention policy assignment."},"example":"1233123"},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/get-retention-policy-assignments-id-file-versions-under-rete":{"get":{"operationId":"cloud_box_get_retention_policy_assignments_id_file_versions_under_rete","summary":"Get file versions under retention","description":"GET /retention_policy_assignments/{retention_policy_assignment_id}/file_versions_under_retention","tags":["cloud"],"parameters":[{"name":"retention_policy_assignment_id","in":"query","required":true,"description":"The ID of the retention policy assignment.","schema":{"type":"string","description":"The ID of the retention policy assignment."},"example":"1233123"},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/get-legal-hold-policies":{"get":{"operationId":"cloud_box_get_legal_hold_policies","summary":"List all legal hold policies","description":"GET /legal_hold_policies","tags":["cloud"],"parameters":[{"name":"policy_name","in":"query","required":false,"description":"Limits results to policies for which the names start with this search term. This is a case-insensitive prefix.","schema":{"type":"string","description":"Limits results to policies for which the names start with this search term. This is a case-insensitive prefix."},"example":"Sales Policy"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-legal-hold-policies":{"post":{"operationId":"cloud_box_post_legal_hold_policies","summary":"Create legal hold policy","description":"POST /legal_hold_policies","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-legal-hold-policies-id":{"get":{"operationId":"cloud_box_get_legal_hold_policies_id","summary":"Get legal hold policy","description":"GET /legal_hold_policies/{legal_hold_policy_id}","tags":["cloud"],"parameters":[{"name":"legal_hold_policy_id","in":"query","required":true,"description":"The ID of the legal hold policy.","schema":{"type":"string","description":"The ID of the legal hold policy."},"example":"324432"}],"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":"byok"}},"/v1/cloud:box/put-legal-hold-policies-id":{"post":{"operationId":"cloud_box_put_legal_hold_policies_id","summary":"Update legal hold policy","description":"PUT /legal_hold_policies/{legal_hold_policy_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["legal_hold_policy_id"],"properties":{"legal_hold_policy_id":{"type":"string","description":"The ID of the legal hold policy."},"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":"byok"}},"/v1/cloud:box/delete-legal-hold-policies-id":{"post":{"operationId":"cloud_box_delete_legal_hold_policies_id","summary":"Remove legal hold policy","description":"DELETE /legal_hold_policies/{legal_hold_policy_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["legal_hold_policy_id"],"properties":{"legal_hold_policy_id":{"type":"string","description":"The ID of the legal hold policy."}}}}}},"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":"byok"}},"/v1/cloud:box/get-legal-hold-policy-assignments":{"get":{"operationId":"cloud_box_get_legal_hold_policy_assignments","summary":"List legal hold policy assignments","description":"GET /legal_hold_policy_assignments","tags":["cloud"],"parameters":[{"name":"policy_id","in":"query","required":true,"description":"The ID of the legal hold policy.","schema":{"type":"string","description":"The ID of the legal hold policy."},"example":"324432"},{"name":"assign_to_type","in":"query","required":false,"description":"Filters the results by the type of item the policy was applied to.","schema":{"type":"string","enum":["file","file_version","folder","user","ownership","interactions"],"description":"Filters the results by the type of item the policy was applied to."},"example":"file"},{"name":"assign_to_id","in":"query","required":false,"description":"Filters the results by the ID of item the policy was applied to.","schema":{"type":"string","description":"Filters the results by the ID of item the policy was applied to."},"example":"1234323"},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}}],"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":"byok"}},"/v1/cloud:box/post-legal-hold-policy-assignments":{"post":{"operationId":"cloud_box_post_legal_hold_policy_assignments","summary":"Assign legal hold policy","description":"POST /legal_hold_policy_assignments","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-legal-hold-policy-assignments-id":{"get":{"operationId":"cloud_box_get_legal_hold_policy_assignments_id","summary":"Get legal hold policy assignment","description":"GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}","tags":["cloud"],"parameters":[{"name":"legal_hold_policy_assignment_id","in":"query","required":true,"description":"The ID of the legal hold policy assignment.","schema":{"type":"string","description":"The ID of the legal hold policy assignment."},"example":"753465"}],"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":"byok"}},"/v1/cloud:box/delete-legal-hold-policy-assignments-id":{"post":{"operationId":"cloud_box_delete_legal_hold_policy_assignments_id","summary":"Unassign legal hold policy","description":"DELETE /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["legal_hold_policy_assignment_id"],"properties":{"legal_hold_policy_assignment_id":{"type":"string","description":"The ID of the legal hold policy assignment."}}}}}},"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":"byok"}},"/v1/cloud:box/get-legal-hold-policy-assignments-id-files-on-hold":{"get":{"operationId":"cloud_box_get_legal_hold_policy_assignments_id_files_on_hold","summary":"List files with current file versions for legal hold policy assignment","description":"GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold","tags":["cloud"],"parameters":[{"name":"legal_hold_policy_assignment_id","in":"query","required":true,"description":"The ID of the legal hold policy assignment.","schema":{"type":"string","description":"The ID of the legal hold policy assignment."},"example":"753465"},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}}],"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":"byok"}},"/v1/cloud:box/get-file-version-retentions":{"get":{"operationId":"cloud_box_get_file_version_retentions","summary":"List file version retentions","description":"GET /file_version_retentions","tags":["cloud"],"parameters":[{"name":"file_id","in":"query","required":false,"description":"Filters results by files with this ID.","schema":{"type":"string","description":"Filters results by files with this ID."},"example":"43123123"},{"name":"file_version_id","in":"query","required":false,"description":"Filters results by file versions with this ID.","schema":{"type":"string","description":"Filters results by file versions with this ID."},"example":"1"},{"name":"policy_id","in":"query","required":false,"description":"Filters results by the retention policy with this ID.","schema":{"type":"string","description":"Filters results by the retention policy with this ID."},"example":"982312"},{"name":"disposition_action","in":"query","required":false,"description":"Filters results by the retention policy with this disposition action.","schema":{"type":"string","enum":["permanently_delete","remove_retention"],"description":"Filters results by the retention policy with this disposition action."},"example":"permanently_delete"},{"name":"disposition_before","in":"query","required":false,"description":"Filters results by files that will have their disposition come into effect before this date.","schema":{"type":"string","description":"Filters results by files that will have their disposition come into effect before this date."},"example":"2012-12-12T10:53:43-08:00"},{"name":"disposition_after","in":"query","required":false,"description":"Filters results by files that will have their disposition come into effect after this date.","schema":{"type":"string","description":"Filters results by files that will have their disposition come into effect after this date."},"example":"2012-12-19T10:34:23-08:00"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"}],"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":"byok"}},"/v1/cloud:box/get-legal-hold-policy-assignments-id-file-versions-on-hold":{"get":{"operationId":"cloud_box_get_legal_hold_policy_assignments_id_file_versions_on_hold","summary":"List previous file versions for legal hold policy assignment","description":"GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/file_versions_on_hold","tags":["cloud"],"parameters":[{"name":"legal_hold_policy_assignment_id","in":"query","required":true,"description":"The ID of the legal hold policy assignment.","schema":{"type":"string","description":"The ID of the legal hold policy assignment."},"example":"753465"},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}}],"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":"byok"}},"/v1/cloud:box/get-file-version-retentions-id":{"get":{"operationId":"cloud_box_get_file_version_retentions_id","summary":"Get retention on file","description":"GET /file_version_retentions/{file_version_retention_id}","tags":["cloud"],"parameters":[{"name":"file_version_retention_id","in":"query","required":true,"description":"The ID of the file version retention.","schema":{"type":"string","description":"The ID of the file version retention."},"example":"3424234"}],"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":"byok"}},"/v1/cloud:box/get-file-version-legal-holds-id":{"get":{"operationId":"cloud_box_get_file_version_legal_holds_id","summary":"Get file version legal hold","description":"GET /file_version_legal_holds/{file_version_legal_hold_id}","tags":["cloud"],"parameters":[{"name":"file_version_legal_hold_id","in":"query","required":true,"description":"The ID of the file version legal hold.","schema":{"type":"string","description":"The ID of the file version legal hold."},"example":"2348213"}],"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":"byok"}},"/v1/cloud:box/get-file-version-legal-holds":{"get":{"operationId":"cloud_box_get_file_version_legal_holds","summary":"List file version legal holds","description":"GET /file_version_legal_holds","tags":["cloud"],"parameters":[{"name":"policy_id","in":"query","required":true,"description":"The ID of the legal hold policy to get the file version legal holds for.","schema":{"type":"string","description":"The ID of the legal hold policy to get the file version legal holds for."},"example":"133870"},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/get-shield-information-barriers-id":{"get":{"operationId":"cloud_box_get_shield_information_barriers_id","summary":"Get shield information barrier with specified ID","description":"GET /shield_information_barriers/{shield_information_barrier_id}","tags":["cloud"],"parameters":[{"name":"shield_information_barrier_id","in":"query","required":true,"description":"The ID of the shield information barrier.","schema":{"type":"string","description":"The ID of the shield information barrier."},"example":"1910967"}],"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":"byok"}},"/v1/cloud:box/post-shield-information-barriers-change-status":{"post":{"operationId":"cloud_box_post_shield_information_barriers_change_status","summary":"Add changed status of shield information barrier with specified ID","description":"POST /shield_information_barriers/change_status","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-shield-information-barriers":{"get":{"operationId":"cloud_box_get_shield_information_barriers","summary":"List shield information barriers","description":"GET /shield_information_barriers","tags":["cloud"],"parameters":[{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination."},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-shield-information-barriers":{"post":{"operationId":"cloud_box_post_shield_information_barriers","summary":"Create shield information barrier","description":"POST /shield_information_barriers","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-shield-information-barrier-reports":{"get":{"operationId":"cloud_box_get_shield_information_barrier_reports","summary":"List shield information barrier reports","description":"GET /shield_information_barrier_reports","tags":["cloud"],"parameters":[{"name":"shield_information_barrier_id","in":"query","required":true,"description":"The ID of the shield information barrier.","schema":{"type":"string","description":"The ID of the shield information barrier."},"example":"1910967"},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-shield-information-barrier-reports":{"post":{"operationId":"cloud_box_post_shield_information_barrier_reports","summary":"Create shield information barrier report","description":"POST /shield_information_barrier_reports","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-shield-information-barrier-reports-id":{"get":{"operationId":"cloud_box_get_shield_information_barrier_reports_id","summary":"Get shield information barrier report by ID","description":"GET /shield_information_barrier_reports/{shield_information_barrier_report_id}","tags":["cloud"],"parameters":[{"name":"shield_information_barrier_report_id","in":"query","required":true,"description":"The ID of the shield information barrier Report.","schema":{"type":"string","description":"The ID of the shield information barrier Report."},"example":"3423"}],"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":"byok"}},"/v1/cloud:box/get-shield-information-barrier-segments-id":{"get":{"operationId":"cloud_box_get_shield_information_barrier_segments_id","summary":"Get shield information barrier segment with specified ID","description":"GET /shield_information_barrier_segments/{shield_information_barrier_segment_id}","tags":["cloud"],"parameters":[{"name":"shield_information_barrier_segment_id","in":"query","required":true,"description":"The ID of the shield information barrier segment.","schema":{"type":"string","description":"The ID of the shield information barrier segment."},"example":"3423"}],"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":"byok"}},"/v1/cloud:box/put-shield-information-barrier-segments-id":{"post":{"operationId":"cloud_box_put_shield_information_barrier_segments_id","summary":"Update shield information barrier segment with specified ID","description":"PUT /shield_information_barrier_segments/{shield_information_barrier_segment_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shield_information_barrier_segment_id"],"properties":{"shield_information_barrier_segment_id":{"type":"string","description":"The ID of the shield information barrier segment."},"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":"byok"}},"/v1/cloud:box/delete-shield-information-barrier-segments-id":{"post":{"operationId":"cloud_box_delete_shield_information_barrier_segments_id","summary":"Delete shield information barrier segment","description":"DELETE /shield_information_barrier_segments/{shield_information_barrier_segment_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shield_information_barrier_segment_id"],"properties":{"shield_information_barrier_segment_id":{"type":"string","description":"The ID of the shield information barrier segment."}}}}}},"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":"byok"}},"/v1/cloud:box/get-shield-information-barrier-segments":{"get":{"operationId":"cloud_box_get_shield_information_barrier_segments","summary":"List shield information barrier segments","description":"GET /shield_information_barrier_segments","tags":["cloud"],"parameters":[{"name":"shield_information_barrier_id","in":"query","required":true,"description":"The ID of the shield information barrier.","schema":{"type":"string","description":"The ID of the shield information barrier."},"example":"1910967"},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-shield-information-barrier-segments":{"post":{"operationId":"cloud_box_post_shield_information_barrier_segments","summary":"Create shield information barrier segment","description":"POST /shield_information_barrier_segments","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-shield-information-barrier-segment-members-id":{"get":{"operationId":"cloud_box_get_shield_information_barrier_segment_members_id","summary":"Get shield information barrier segment member by ID","description":"GET /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}","tags":["cloud"],"parameters":[{"name":"shield_information_barrier_segment_member_id","in":"query","required":true,"description":"The ID of the shield information barrier segment Member.","schema":{"type":"string","description":"The ID of the shield information barrier segment Member."},"example":"7815"}],"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":"byok"}},"/v1/cloud:box/delete-shield-information-barrier-segment-members-id":{"post":{"operationId":"cloud_box_delete_shield_information_barrier_segment_members_id","summary":"Delete shield information barrier segment member by ID","description":"DELETE /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shield_information_barrier_segment_member_id"],"properties":{"shield_information_barrier_segment_member_id":{"type":"string","description":"The ID of the shield information barrier segment Member."}}}}}},"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":"byok"}},"/v1/cloud:box/get-shield-information-barrier-segment-members":{"get":{"operationId":"cloud_box_get_shield_information_barrier_segment_members","summary":"List shield information barrier segment members","description":"GET /shield_information_barrier_segment_members","tags":["cloud"],"parameters":[{"name":"shield_information_barrier_segment_id","in":"query","required":true,"description":"The ID of the shield information barrier segment.","schema":{"type":"string","description":"The ID of the shield information barrier segment."},"example":"3423"},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-shield-information-barrier-segment-members":{"post":{"operationId":"cloud_box_post_shield_information_barrier_segment_members","summary":"Create shield information barrier segment member","description":"POST /shield_information_barrier_segment_members","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-shield-information-barrier-segment-restrictions-id":{"get":{"operationId":"cloud_box_get_shield_information_barrier_segment_restrictions_id","summary":"Get shield information barrier segment restriction by ID","description":"GET /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}","tags":["cloud"],"parameters":[{"name":"shield_information_barrier_segment_restriction_id","in":"query","required":true,"description":"The ID of the shield information barrier segment Restriction.","schema":{"type":"string","description":"The ID of the shield information barrier segment Restriction."},"example":"4563"}],"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":"byok"}},"/v1/cloud:box/delete-shield-information-barrier-segment-restrictions-id":{"post":{"operationId":"cloud_box_delete_shield_information_barrier_segment_restrictions_id","summary":"Delete shield information barrier segment restriction by ID","description":"DELETE /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shield_information_barrier_segment_restriction_id"],"properties":{"shield_information_barrier_segment_restriction_id":{"type":"string","description":"The ID of the shield information barrier segment Restriction."}}}}}},"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":"byok"}},"/v1/cloud:box/get-shield-information-barrier-segment-restrictions":{"get":{"operationId":"cloud_box_get_shield_information_barrier_segment_restrictions","summary":"List shield information barrier segment restrictions","description":"GET /shield_information_barrier_segment_restrictions","tags":["cloud"],"parameters":[{"name":"shield_information_barrier_segment_id","in":"query","required":true,"description":"The ID of the shield information barrier segment.","schema":{"type":"string","description":"The ID of the shield information barrier segment."},"example":"3423"},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-shield-information-barrier-segment-restrictions":{"post":{"operationId":"cloud_box_post_shield_information_barrier_segment_restrictions","summary":"Create shield information barrier segment restriction","description":"POST /shield_information_barrier_segment_restrictions","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-device-pinners-id":{"get":{"operationId":"cloud_box_get_device_pinners_id","summary":"Get device pin","description":"GET /device_pinners/{device_pinner_id}","tags":["cloud"],"parameters":[{"name":"device_pinner_id","in":"query","required":true,"description":"The ID of the device pin.","schema":{"type":"string","description":"The ID of the device pin."},"example":"2324234"}],"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":"byok"}},"/v1/cloud:box/delete-device-pinners-id":{"post":{"operationId":"cloud_box_delete_device_pinners_id","summary":"Remove device pin","description":"DELETE /device_pinners/{device_pinner_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["device_pinner_id"],"properties":{"device_pinner_id":{"type":"string","description":"The ID of the device pin."}}}}}},"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":"byok"}},"/v1/cloud:box/get-enterprises-id-device-pinners":{"get":{"operationId":"cloud_box_get_enterprises_id_device_pinners","summary":"List enterprise device pins","description":"GET /enterprises/{enterprise_id}/device_pinners","tags":["cloud"],"parameters":[{"name":"enterprise_id","in":"query","required":true,"description":"The ID of the enterprise.","schema":{"type":"string","description":"The ID of the enterprise."},"example":"3442311"},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"direction","in":"query","required":false,"description":"The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order.","schema":{"type":"string","enum":["ASC","DESC"],"description":"The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order."},"example":"ASC"}],"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":"byok"}},"/v1/cloud:box/get-terms-of-services":{"get":{"operationId":"cloud_box_get_terms_of_services","summary":"List terms of services","description":"GET /terms_of_services","tags":["cloud"],"parameters":[{"name":"tos_type","in":"query","required":false,"description":"Limits the results to the terms of service of the given type.","schema":{"type":"string","enum":["external","managed"],"description":"Limits the results to the terms of service of the given type."},"example":"managed"}],"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":"byok"}},"/v1/cloud:box/post-terms-of-services":{"post":{"operationId":"cloud_box_post_terms_of_services","summary":"Create terms of service","description":"POST /terms_of_services","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-terms-of-services-id":{"get":{"operationId":"cloud_box_get_terms_of_services_id","summary":"Get terms of service","description":"GET /terms_of_services/{terms_of_service_id}","tags":["cloud"],"parameters":[{"name":"terms_of_service_id","in":"query","required":true,"description":"The ID of the terms of service.","schema":{"type":"string","description":"The ID of the terms of service."},"example":"324234"}],"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":"byok"}},"/v1/cloud:box/put-terms-of-services-id":{"post":{"operationId":"cloud_box_put_terms_of_services_id","summary":"Update terms of service","description":"PUT /terms_of_services/{terms_of_service_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["terms_of_service_id"],"properties":{"terms_of_service_id":{"type":"string","description":"The ID of the terms of service."},"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":"byok"}},"/v1/cloud:box/get-terms-of-service-user-statuses":{"get":{"operationId":"cloud_box_get_terms_of_service_user_statuses","summary":"List terms of service user statuses","description":"GET /terms_of_service_user_statuses","tags":["cloud"],"parameters":[{"name":"tos_id","in":"query","required":true,"description":"The ID of the terms of service.","schema":{"type":"string","description":"The ID of the terms of service."},"example":"324234"},{"name":"user_id","in":"query","required":false,"description":"Limits results to the given user ID.","schema":{"type":"string","description":"Limits results to the given user ID."},"example":"123334"}],"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":"byok"}},"/v1/cloud:box/post-terms-of-service-user-statuses":{"post":{"operationId":"cloud_box_post_terms_of_service_user_statuses","summary":"Create terms of service status for new user","description":"POST /terms_of_service_user_statuses","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/put-terms-of-service-user-statuses-id":{"post":{"operationId":"cloud_box_put_terms_of_service_user_statuses_id","summary":"Update terms of service status for existing user","description":"PUT /terms_of_service_user_statuses/{terms_of_service_user_status_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["terms_of_service_user_status_id"],"properties":{"terms_of_service_user_status_id":{"type":"string","description":"The ID of the terms of service status."},"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":"byok"}},"/v1/cloud:box/get-collaboration-whitelist-entries":{"get":{"operationId":"cloud_box_get_collaboration_whitelist_entries","summary":"List allowed collaboration domains","description":"GET /collaboration_whitelist_entries","tags":["cloud"],"parameters":[{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-collaboration-whitelist-entries":{"post":{"operationId":"cloud_box_post_collaboration_whitelist_entries","summary":"Add domain to list of allowed collaboration domains","description":"POST /collaboration_whitelist_entries","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-collaboration-whitelist-entries-id":{"get":{"operationId":"cloud_box_get_collaboration_whitelist_entries_id","summary":"Get allowed collaboration domain","description":"GET /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}","tags":["cloud"],"parameters":[{"name":"collaboration_whitelist_entry_id","in":"query","required":true,"description":"The ID of the entry in the list.","schema":{"type":"string","description":"The ID of the entry in the list."},"example":"213123"}],"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":"byok"}},"/v1/cloud:box/delete-collaboration-whitelist-entries-id":{"post":{"operationId":"cloud_box_delete_collaboration_whitelist_entries_id","summary":"Remove domain from list of allowed collaboration domains","description":"DELETE /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["collaboration_whitelist_entry_id"],"properties":{"collaboration_whitelist_entry_id":{"type":"string","description":"The ID of the entry in 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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:box/get-collaboration-whitelist-exempt-targets":{"get":{"operationId":"cloud_box_get_collaboration_whitelist_exempt_targets","summary":"List users exempt from collaboration domain restrictions","description":"GET /collaboration_whitelist_exempt_targets","tags":["cloud"],"parameters":[{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-collaboration-whitelist-exempt-targets":{"post":{"operationId":"cloud_box_post_collaboration_whitelist_exempt_targets","summary":"Create user exemption from collaboration domain restrictions","description":"POST /collaboration_whitelist_exempt_targets","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-collaboration-whitelist-exempt-targets-id":{"get":{"operationId":"cloud_box_get_collaboration_whitelist_exempt_targets_id","summary":"Get user exempt from collaboration domain restrictions","description":"GET /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}","tags":["cloud"],"parameters":[{"name":"collaboration_whitelist_exempt_target_id","in":"query","required":true,"description":"The ID of the exemption to the list.","schema":{"type":"string","description":"The ID of the exemption to the list."},"example":"984923"}],"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":"byok"}},"/v1/cloud:box/delete-collaboration-whitelist-exempt-targets-id":{"post":{"operationId":"cloud_box_delete_collaboration_whitelist_exempt_targets_id","summary":"Remove user from list of users exempt from domain restrictions","description":"DELETE /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["collaboration_whitelist_exempt_target_id"],"properties":{"collaboration_whitelist_exempt_target_id":{"type":"string","description":"The ID of the exemption to 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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:box/get-storage-policies":{"get":{"operationId":"cloud_box_get_storage_policies","summary":"List storage policies","description":"GET /storage_policies","tags":["cloud"],"parameters":[{"name":"fields","in":"query","required":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…","schema":{"type":"array","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a…"}},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/get-storage-policies-id":{"get":{"operationId":"cloud_box_get_storage_policies_id","summary":"Get storage policy","description":"GET /storage_policies/{storage_policy_id}","tags":["cloud"],"parameters":[{"name":"storage_policy_id","in":"query","required":true,"description":"The ID of the storage policy.","schema":{"type":"string","description":"The ID of the storage policy."},"example":"34342"}],"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":"byok"}},"/v1/cloud:box/get-storage-policy-assignments":{"get":{"operationId":"cloud_box_get_storage_policy_assignments","summary":"List storage policy assignments","description":"GET /storage_policy_assignments","tags":["cloud"],"parameters":[{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"resolved_for_type","in":"query","required":true,"description":"The target type to return assignments for.","schema":{"type":"string","enum":["user","enterprise"],"description":"The target type to return assignments for."},"example":"user"},{"name":"resolved_for_id","in":"query","required":true,"description":"The ID of the user or enterprise to return assignments for.","schema":{"type":"string","description":"The ID of the user or enterprise to return assignments for."},"example":"984322"}],"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":"byok"}},"/v1/cloud:box/post-storage-policy-assignments":{"post":{"operationId":"cloud_box_post_storage_policy_assignments","summary":"Assign storage policy","description":"POST /storage_policy_assignments","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-storage-policy-assignments-id":{"get":{"operationId":"cloud_box_get_storage_policy_assignments_id","summary":"Get storage policy assignment","description":"GET /storage_policy_assignments/{storage_policy_assignment_id}","tags":["cloud"],"parameters":[{"name":"storage_policy_assignment_id","in":"query","required":true,"description":"The ID of the storage policy assignment.","schema":{"type":"string","description":"The ID of the storage policy assignment."},"example":"932483"}],"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":"byok"}},"/v1/cloud:box/put-storage-policy-assignments-id":{"post":{"operationId":"cloud_box_put_storage_policy_assignments_id","summary":"Update storage policy assignment","description":"PUT /storage_policy_assignments/{storage_policy_assignment_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["storage_policy_assignment_id"],"properties":{"storage_policy_assignment_id":{"type":"string","description":"The ID of the storage policy assignment."},"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":"byok"}},"/v1/cloud:box/delete-storage-policy-assignments-id":{"post":{"operationId":"cloud_box_delete_storage_policy_assignments_id","summary":"Unassign storage policy","description":"DELETE /storage_policy_assignments/{storage_policy_assignment_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["storage_policy_assignment_id"],"properties":{"storage_policy_assignment_id":{"type":"string","description":"The ID of the storage policy assignment."}}}}}},"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":"byok"}},"/v1/cloud:box/post-zip-downloads":{"post":{"operationId":"cloud_box_post_zip_downloads","summary":"Create zip download","description":"POST /zip_downloads","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-zip-downloads-id-content":{"get":{"operationId":"cloud_box_get_zip_downloads_id_content","summary":"Download zip archive","description":"GET /zip_downloads/{zip_download_id}/content","tags":["cloud"],"parameters":[{"name":"zip_download_id","in":"query","required":true,"description":"The unique identifier that represent this `zip` archive.","schema":{"type":"string","description":"The unique identifier that represent this `zip` archive."},"example":"Lu6fA9Ob-jyysp3AAvMF4AkLEwZwAYbL=tgj2zIC=eK9RvJnJbjJl9rNh2qBgHDpyOCAOhpM=vajg2mKq8Mdd"}],"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":"byok"}},"/v1/cloud:box/get-zip-downloads-id-status":{"get":{"operationId":"cloud_box_get_zip_downloads_id_status","summary":"Get zip download status","description":"GET /zip_downloads/{zip_download_id}/status","tags":["cloud"],"parameters":[{"name":"zip_download_id","in":"query","required":true,"description":"The unique identifier that represent this `zip` archive.","schema":{"type":"string","description":"The unique identifier that represent this `zip` archive."},"example":"Lu6fA9Ob-jyysp3AAvMF4AkLEwZwAYbL=tgj2zIC=eK9RvJnJbjJl9rNh2qBgHDpyOCAOhpM=vajg2mKq8Mdd"}],"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":"byok"}},"/v1/cloud:box/post-sign-requests-id-cancel":{"post":{"operationId":"cloud_box_post_sign_requests_id_cancel","summary":"Cancel Box Sign request","description":"POST /sign_requests/{sign_request_id}/cancel","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sign_request_id"],"properties":{"sign_request_id":{"type":"string","description":"The ID of the signature request."},"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":"byok"}},"/v1/cloud:box/post-sign-requests-id-resend":{"post":{"operationId":"cloud_box_post_sign_requests_id_resend","summary":"Resend Box Sign request","description":"POST /sign_requests/{sign_request_id}/resend","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sign_request_id"],"properties":{"sign_request_id":{"type":"string","description":"The ID of the signature request."}}}}}},"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":"byok"}},"/v1/cloud:box/get-sign-requests-id":{"get":{"operationId":"cloud_box_get_sign_requests_id","summary":"Get Box Sign request by ID","description":"GET /sign_requests/{sign_request_id}","tags":["cloud"],"parameters":[{"name":"sign_request_id","in":"query","required":true,"description":"The ID of the signature request.","schema":{"type":"string","description":"The ID of the signature request."},"example":"33243242"}],"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":"byok"}},"/v1/cloud:box/get-sign-requests":{"get":{"operationId":"cloud_box_get_sign_requests","summary":"List Box Sign requests","description":"GET /sign_requests","tags":["cloud"],"parameters":[{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"senders","in":"query","required":false,"description":"A list of sender emails to filter the signature requests by sender. If provided, `shared_requests` must be set to `true`.","schema":{"type":"array","description":"A list of sender emails to filter the signature requests by sender. If provided, `shared_requests` must be set to `true`."}},{"name":"shared_requests","in":"query","required":false,"description":"If set to `true`, only includes requests that user is not an owner, but user is a collaborator. Collaborator access is determined by the…","schema":{"type":"boolean","default":false,"description":"If set to `true`, only includes requests that user is not an owner, but user is a collaborator. Collaborator access is determined by the…"},"example":true}],"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":"byok"}},"/v1/cloud:box/post-sign-requests":{"post":{"operationId":"cloud_box_post_sign_requests","summary":"Create Box Sign request","description":"POST /sign_requests","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-workflows":{"get":{"operationId":"cloud_box_get_workflows","summary":"List workflows","description":"GET /workflows","tags":["cloud"],"parameters":[{"name":"folder_id","in":"query","required":true,"description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…","schema":{"type":"string","description":"The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and…"},"example":"12345"},{"name":"trigger_type","in":"query","required":false,"description":"Type of trigger to search for.","schema":{"type":"string","description":"Type of trigger to search for."},"example":"WORKFLOW_MANUAL_START"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"}],"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":"byok"}},"/v1/cloud:box/post-workflows-id-start":{"post":{"operationId":"cloud_box_post_workflows_id_start","summary":"Starts workflow based on request body","description":"POST /workflows/{workflow_id}/start","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workflow_id"],"properties":{"workflow_id":{"type":"string","description":"The ID of the workflow."},"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":"byok"}},"/v1/cloud:box/get-sign-templates":{"get":{"operationId":"cloud_box_get_sign_templates","summary":"List Box Sign templates","description":"GET /sign_templates","tags":["cloud"],"parameters":[{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/get-sign-templates-id":{"get":{"operationId":"cloud_box_get_sign_templates_id","summary":"Get Box Sign template by ID","description":"GET /sign_templates/{template_id}","tags":["cloud"],"parameters":[{"name":"template_id","in":"query","required":true,"description":"The ID of a Box Sign template.","schema":{"type":"string","description":"The ID of a Box Sign template."},"example":"123075213-7d117509-8f05-42e4-a5ef-5190a319d41d"}],"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":"byok"}},"/v1/cloud:box/get-integration-mappings-slack":{"get":{"operationId":"cloud_box_get_integration_mappings_slack","summary":"List Slack integration mappings","description":"GET /integration_mappings/slack","tags":["cloud"],"parameters":[{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000},{"name":"partner_item_type","in":"query","required":false,"description":"Mapped item type, for which the mapping should be returned.","schema":{"type":"string","enum":["channel"],"description":"Mapped item type, for which the mapping should be returned."},"example":"channel"},{"name":"partner_item_id","in":"query","required":false,"description":"ID of the mapped item, for which the mapping should be returned.","schema":{"type":"string","description":"ID of the mapped item, for which the mapping should be returned."},"example":"12345"},{"name":"box_item_id","in":"query","required":false,"description":"Box item ID, for which the mappings should be returned.","schema":{"type":"string","description":"Box item ID, for which the mappings should be returned."},"example":"12345"},{"name":"box_item_type","in":"query","required":false,"description":"Box item type, for which the mappings should be returned.","schema":{"type":"string","enum":["folder"],"description":"Box item type, for which the mappings should be returned."},"example":"folder"},{"name":"is_manually_created","in":"query","required":false,"description":"Whether the mapping has been manually created.","schema":{"type":"boolean","description":"Whether the mapping has been manually created."},"example":true}],"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":"byok"}},"/v1/cloud:box/post-integration-mappings-slack":{"post":{"operationId":"cloud_box_post_integration_mappings_slack","summary":"Create Slack integration mapping","description":"POST /integration_mappings/slack","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/put-integration-mappings-slack-id":{"post":{"operationId":"cloud_box_put_integration_mappings_slack_id","summary":"Update Slack integration mapping","description":"PUT /integration_mappings/slack/{integration_mapping_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["integration_mapping_id"],"properties":{"integration_mapping_id":{"type":"string","description":"An ID of an integration mapping."},"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":"byok"}},"/v1/cloud:box/delete-integration-mappings-slack-id":{"post":{"operationId":"cloud_box_delete_integration_mappings_slack_id","summary":"Delete Slack integration mapping","description":"DELETE /integration_mappings/slack/{integration_mapping_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["integration_mapping_id"],"properties":{"integration_mapping_id":{"type":"string","description":"An ID of an integration mapping."}}}}}},"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":"byok"}},"/v1/cloud:box/get-integration-mappings-teams":{"get":{"operationId":"cloud_box_get_integration_mappings_teams","summary":"List Teams integration mappings","description":"GET /integration_mappings/teams","tags":["cloud"],"parameters":[{"name":"partner_item_type","in":"query","required":false,"description":"Mapped item type, for which the mapping should be returned.","schema":{"type":"string","enum":["channel","team"],"description":"Mapped item type, for which the mapping should be returned."},"example":"channel"},{"name":"partner_item_id","in":"query","required":false,"description":"ID of the mapped item, for which the mapping should be returned.","schema":{"type":"string","description":"ID of the mapped item, for which the mapping should be returned."},"example":"12345"},{"name":"box_item_id","in":"query","required":false,"description":"Box item ID, for which the mappings should be returned.","schema":{"type":"string","description":"Box item ID, for which the mappings should be returned."},"example":"12345"},{"name":"box_item_type","in":"query","required":false,"description":"Box item type, for which the mappings should be returned.","schema":{"type":"string","enum":["folder"],"description":"Box item type, for which the mappings should be returned."},"example":"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":"byok"}},"/v1/cloud:box/post-integration-mappings-teams":{"post":{"operationId":"cloud_box_post_integration_mappings_teams","summary":"Create Teams integration mapping","description":"POST /integration_mappings/teams","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/put-integration-mappings-teams-id":{"post":{"operationId":"cloud_box_put_integration_mappings_teams_id","summary":"Update Teams integration mapping","description":"PUT /integration_mappings/teams/{integration_mapping_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["integration_mapping_id"],"properties":{"integration_mapping_id":{"type":"string","description":"An ID of an integration mapping."},"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":"byok"}},"/v1/cloud:box/delete-integration-mappings-teams-id":{"post":{"operationId":"cloud_box_delete_integration_mappings_teams_id","summary":"Delete Teams integration mapping","description":"DELETE /integration_mappings/teams/{integration_mapping_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["integration_mapping_id"],"properties":{"integration_mapping_id":{"type":"string","description":"An ID of an integration mapping."}}}}}},"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":"byok"}},"/v1/cloud:box/post-ai-ask":{"post":{"operationId":"cloud_box_post_ai_ask","summary":"Ask question","description":"POST /ai/ask","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/post-ai-text-gen":{"post":{"operationId":"cloud_box_post_ai_text_gen","summary":"Generate text","description":"POST /ai/text_gen","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-ai-agent-default":{"get":{"operationId":"cloud_box_get_ai_agent_default","summary":"Get AI agent default configuration","description":"GET /ai_agent_default","tags":["cloud"],"parameters":[{"name":"mode","in":"query","required":true,"description":"The mode to filter the agent config to return.","schema":{"type":"string","enum":["ask","text_gen","extract","extract_structured"],"description":"The mode to filter the agent config to return."},"example":"ask"},{"name":"language","in":"query","required":false,"description":"The ISO language code to return the agent config for. If the language is not supported the default agent config is returned.","schema":{"type":"string","description":"The ISO language code to return the agent config for. If the language is not supported the default agent config is returned."},"example":"ja"},{"name":"model","in":"query","required":false,"description":"The model to return the default agent config for.","schema":{"type":"string","description":"The model to return the default agent config for."},"example":"azure__openai__gpt_4o_mini"}],"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":"byok"}},"/v1/cloud:box/post-ai-extract":{"post":{"operationId":"cloud_box_post_ai_extract","summary":"Extract metadata (freeform)","description":"POST /ai/extract","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/post-ai-extract-structured":{"post":{"operationId":"cloud_box_post_ai_extract_structured","summary":"Extract metadata (structured)","description":"POST /ai/extract_structured","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-ai-agents":{"get":{"operationId":"cloud_box_get_ai_agents","summary":"List AI agents","description":"GET /ai_agents","tags":["cloud"],"parameters":[{"name":"mode","in":"query","required":false,"description":"The mode to filter the agent config to return. Possible values are: `ask`, `text_gen`, and `extract`.","schema":{"type":"array","description":"The mode to filter the agent config to return. Possible values are: `ask`, `text_gen`, and `extract`."}},{"name":"fields","in":"query","required":false,"description":"The fields to return in the response.","schema":{"type":"array","description":"The fields to return in the response."}},{"name":"agent_state","in":"query","required":false,"description":"The state of the agents to return. Possible values are: `enabled`, `disabled` and `enabled_for_selected_users`.","schema":{"type":"array","description":"The state of the agents to return. Possible values are: `enabled`, `disabled` and `enabled_for_selected_users`."}},{"name":"include_box_default","in":"query","required":false,"description":"Whether to include the Box default agents in the response.","schema":{"type":"boolean","default":false,"description":"Whether to include the Box default agents in the response."},"example":true},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results.","schema":{"type":"string","description":"Defines the position marker at which to begin returning results."},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-ai-agents":{"post":{"operationId":"cloud_box_post_ai_agents","summary":"Create AI agent","description":"POST /ai_agents","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-ai-agents-id":{"get":{"operationId":"cloud_box_get_ai_agents_id","summary":"Get AI agent by agent ID","description":"GET /ai_agents/{agent_id}","tags":["cloud"],"parameters":[{"name":"agent_id","in":"query","required":true,"description":"The agent id to get.","schema":{"type":"string","description":"The agent id to get."},"example":"1234"},{"name":"fields","in":"query","required":false,"description":"The fields to return in the response.","schema":{"type":"array","description":"The fields to return in the response."}}],"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":"byok"}},"/v1/cloud:box/put-ai-agents-id":{"post":{"operationId":"cloud_box_put_ai_agents_id","summary":"Update AI agent","description":"PUT /ai_agents/{agent_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["agent_id"],"properties":{"agent_id":{"type":"string","description":"The ID of the agent 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":"byok"}},"/v1/cloud:box/delete-ai-agents-id":{"post":{"operationId":"cloud_box_delete_ai_agents_id","summary":"Delete AI agent","description":"DELETE /ai_agents/{agent_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["agent_id"],"properties":{"agent_id":{"type":"string","description":"The ID of the agent 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":"byok"}},"/v1/cloud:box/post-metadata-taxonomies":{"post":{"operationId":"cloud_box_post_metadata_taxonomies","summary":"Create metadata taxonomy","description":"POST /metadata_taxonomies","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"byok"}},"/v1/cloud:box/get-metadata-taxonomies-id":{"get":{"operationId":"cloud_box_get_metadata_taxonomies_id","summary":"Get metadata taxonomies for namespace","description":"GET /metadata_taxonomies/{namespace}","tags":["cloud"],"parameters":[{"name":"namespace","in":"query","required":true,"description":"The namespace of the metadata taxonomy.","schema":{"type":"string","description":"The namespace of the metadata taxonomy."},"example":"enterprise_123456"},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/get-metadata-taxonomies-id-id":{"get":{"operationId":"cloud_box_get_metadata_taxonomies_id_id","summary":"Get metadata taxonomy by taxonomy key","description":"GET /metadata_taxonomies/{namespace}/{taxonomy_key}","tags":["cloud"],"parameters":[{"name":"namespace","in":"query","required":true,"description":"The namespace of the metadata taxonomy.","schema":{"type":"string","description":"The namespace of the metadata taxonomy."},"example":"enterprise_123456"},{"name":"taxonomy_key","in":"query","required":true,"description":"The key of the metadata taxonomy.","schema":{"type":"string","description":"The key of the metadata taxonomy."},"example":"geography"}],"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":"byok"}},"/v1/cloud:box/patch-metadata-taxonomies-id-id":{"post":{"operationId":"cloud_box_patch_metadata_taxonomies_id_id","summary":"Update metadata taxonomy","description":"PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["namespace","taxonomy_key"],"properties":{"namespace":{"type":"string","description":"The namespace of the metadata taxonomy."},"taxonomy_key":{"type":"string","description":"The key of the metadata taxonomy."},"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":"byok"}},"/v1/cloud:box/delete-metadata-taxonomies-id-id":{"post":{"operationId":"cloud_box_delete_metadata_taxonomies_id_id","summary":"Remove metadata taxonomy","description":"DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["namespace","taxonomy_key"],"properties":{"namespace":{"type":"string","description":"The namespace of the metadata taxonomy."},"taxonomy_key":{"type":"string","description":"The key of the metadata taxonomy."}}}}}},"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":"byok"}},"/v1/cloud:box/post-metadata-taxonomies-id-id-levels":{"post":{"operationId":"cloud_box_post_metadata_taxonomies_id_id_levels","summary":"Create metadata taxonomy levels","description":"POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["namespace","taxonomy_key"],"properties":{"namespace":{"type":"string","description":"The namespace of the metadata taxonomy."},"taxonomy_key":{"type":"string","description":"The key of the metadata taxonomy."},"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":"byok"}},"/v1/cloud:box/patch-metadata-taxonomies-id-id-levels-id":{"post":{"operationId":"cloud_box_patch_metadata_taxonomies_id_id_levels_id","summary":"Update metadata taxonomy level","description":"PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/levels/{level_index}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["namespace","taxonomy_key","level_index"],"properties":{"namespace":{"type":"string","description":"The namespace of the metadata taxonomy."},"taxonomy_key":{"type":"string","description":"The key of the metadata taxonomy."},"level_index":{"type":"integer","description":"The index of the metadata taxonomy level."},"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":"byok"}},"/v1/cloud:box/post-metadata-taxonomies-id-id-levels-append":{"post":{"operationId":"cloud_box_post_metadata_taxonomies_id_id_levels_append","summary":"Add metadata taxonomy level","description":"POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:append","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["namespace","taxonomy_key"],"properties":{"namespace":{"type":"string","description":"The namespace of the metadata taxonomy."},"taxonomy_key":{"type":"string","description":"The key of the metadata taxonomy."},"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":"byok"}},"/v1/cloud:box/post-metadata-taxonomies-id-id-levels-trim":{"post":{"operationId":"cloud_box_post_metadata_taxonomies_id_id_levels_trim","summary":"Delete metadata taxonomy level","description":"POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:trim","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["namespace","taxonomy_key"],"properties":{"namespace":{"type":"string","description":"The namespace of the metadata taxonomy."},"taxonomy_key":{"type":"string","description":"The key of the metadata taxonomy."}}}}}},"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":"byok"}},"/v1/cloud:box/get-metadata-taxonomies-id-id-nodes":{"get":{"operationId":"cloud_box_get_metadata_taxonomies_id_id_nodes","summary":"List metadata taxonomy nodes","description":"GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes","tags":["cloud"],"parameters":[{"name":"namespace","in":"query","required":true,"description":"The namespace of the metadata taxonomy.","schema":{"type":"string","description":"The namespace of the metadata taxonomy."},"example":"enterprise_123456"},{"name":"taxonomy_key","in":"query","required":true,"description":"The key of the metadata taxonomy.","schema":{"type":"string","description":"The key of the metadata taxonomy."},"example":"geography"},{"name":"level","in":"query","required":false,"description":"Filters results by taxonomy level. Multiple values can be provided. Results include nodes that match any of the specified values.","schema":{"type":"array","description":"Filters results by taxonomy level. Multiple values can be provided. Results include nodes that match any of the specified values."}},{"name":"parent","in":"query","required":false,"description":"Node identifier of a direct parent node. Multiple values can be provided. Results include nodes that match any of the specified values.","schema":{"type":"array","description":"Node identifier of a direct parent node. Multiple values can be provided. Results include nodes that match any of the specified values."}},{"name":"ancestor","in":"query","required":false,"description":"Node identifier of any ancestor node. Multiple values can be provided. Results include nodes that match any of the specified values.","schema":{"type":"array","description":"Node identifier of any ancestor node. Multiple values can be provided. Results include nodes that match any of the specified values."}},{"name":"query","in":"query","required":false,"description":"Query text to search for the taxonomy nodes.","schema":{"type":"string","description":"Query text to search for the taxonomy nodes."},"example":"France"},{"name":"include-total-result-count","in":"query","required":false,"description":"When set to `true` this provides the total number of nodes that matched the query. The response will compute counts of up to 10,000…","schema":{"type":"boolean","description":"When set to `true` this provides the total number of nodes that matched the query. The response will compute counts of up to 10,000…"},"example":true},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}},"/v1/cloud:box/post-metadata-taxonomies-id-id-nodes":{"post":{"operationId":"cloud_box_post_metadata_taxonomies_id_id_nodes","summary":"Create metadata taxonomy node","description":"POST /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["namespace","taxonomy_key"],"properties":{"namespace":{"type":"string","description":"The namespace of the metadata taxonomy."},"taxonomy_key":{"type":"string","description":"The key of the metadata taxonomy."},"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":"byok"}},"/v1/cloud:box/get-metadata-taxonomies-id-id-nodes-id":{"get":{"operationId":"cloud_box_get_metadata_taxonomies_id_id_nodes_id","summary":"Get metadata taxonomy node by ID","description":"GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}","tags":["cloud"],"parameters":[{"name":"namespace","in":"query","required":true,"description":"The namespace of the metadata taxonomy.","schema":{"type":"string","description":"The namespace of the metadata taxonomy."},"example":"enterprise_123456"},{"name":"taxonomy_key","in":"query","required":true,"description":"The key of the metadata taxonomy.","schema":{"type":"string","description":"The key of the metadata taxonomy."},"example":"geography"},{"name":"node_id","in":"query","required":true,"description":"The identifier of the metadata taxonomy node.","schema":{"type":"string","description":"The identifier of the metadata taxonomy node."},"example":"14d3d433-c77f-49c5-b146-9dea370f6e32"}],"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":"byok"}},"/v1/cloud:box/patch-metadata-taxonomies-id-id-nodes-id":{"post":{"operationId":"cloud_box_patch_metadata_taxonomies_id_id_nodes_id","summary":"Update metadata taxonomy node","description":"PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["namespace","taxonomy_key","node_id"],"properties":{"namespace":{"type":"string","description":"The namespace of the metadata taxonomy."},"taxonomy_key":{"type":"string","description":"The key of the metadata taxonomy."},"node_id":{"type":"string","description":"The identifier of the metadata taxonomy node."},"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":"byok"}},"/v1/cloud:box/delete-metadata-taxonomies-id-id-nodes-id":{"post":{"operationId":"cloud_box_delete_metadata_taxonomies_id_id_nodes_id","summary":"Remove metadata taxonomy node","description":"DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["namespace","taxonomy_key","node_id"],"properties":{"namespace":{"type":"string","description":"The namespace of the metadata taxonomy."},"taxonomy_key":{"type":"string","description":"The key of the metadata taxonomy."},"node_id":{"type":"string","description":"The identifier of the metadata taxonomy node."}}}}}},"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":"byok"}},"/v1/cloud:box/get-metadata-templates-id-id-fields-id-options":{"get":{"operationId":"cloud_box_get_metadata_templates_id_id_fields_id_options","summary":"List metadata template's options for taxonomy field","description":"GET /metadata_templates/{namespace}/{template_key}/fields/{field_key}/options","tags":["cloud"],"parameters":[{"name":"namespace","in":"query","required":true,"description":"The namespace of the metadata taxonomy.","schema":{"type":"string","description":"The namespace of the metadata taxonomy."},"example":"enterprise_123456"},{"name":"template_key","in":"query","required":true,"description":"The name of the metadata template.","schema":{"type":"string","description":"The name of the metadata template."},"example":"properties"},{"name":"field_key","in":"query","required":true,"description":"The key of the metadata taxonomy field in the template.","schema":{"type":"string","description":"The key of the metadata taxonomy field in the template."},"example":"geography"},{"name":"level","in":"query","required":false,"description":"Filters results by taxonomy level. Multiple values can be provided. Results include nodes that match any of the specified values.","schema":{"type":"array","description":"Filters results by taxonomy level. Multiple values can be provided. Results include nodes that match any of the specified values."}},{"name":"parent","in":"query","required":false,"description":"Node identifier of a direct parent node. Multiple values can be provided. Results include nodes that match any of the specified values.","schema":{"type":"array","description":"Node identifier of a direct parent node. Multiple values can be provided. Results include nodes that match any of the specified values."}},{"name":"ancestor","in":"query","required":false,"description":"Node identifier of any ancestor node. Multiple values can be provided. Results include nodes that match any of the specified values.","schema":{"type":"array","description":"Node identifier of any ancestor node. Multiple values can be provided. Results include nodes that match any of the specified values."}},{"name":"query","in":"query","required":false,"description":"Query text to search for the taxonomy nodes.","schema":{"type":"string","description":"Query text to search for the taxonomy nodes."},"example":"France"},{"name":"include-total-result-count","in":"query","required":false,"description":"When set to `true` this provides the total number of nodes that matched the query. The response will compute counts of up to 10,000…","schema":{"type":"boolean","description":"When set to `true` this provides the total number of nodes that matched the query. The response will compute counts of up to 10,000…"},"example":true},{"name":"only-selectable-options","in":"query","required":false,"description":"When set to `true`, this only returns valid selectable options for this template taxonomy field. Otherwise, it returns all taxonomy nodes,…","schema":{"type":"boolean","description":"When set to `true`, this only returns valid selectable options for this template taxonomy field. Otherwise, it returns all taxonomy nodes,…"},"example":true},{"name":"marker","in":"query","required":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…","schema":{"type":"string","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires…"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return per page.","schema":{"type":"integer","description":"The maximum number of items to return per page."},"example":1000}],"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":"byok"}}},"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"}}}}}}}