Box

Authorize a user by sending them through the [Box](https://box.com) website and request their permission to act on their behalf. This is the first step when authenticating a user using OAuth 2.0. To request a user's authorization to use the Box APIs on their behalf you will need to send a user to the URL with this format.

Revoke an active Access Token, effectively logging a user out that has been previously authenticated.

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "$ref": "#/components/schemas/PostOAuth2Revoke"
      }
    }
  }
}

Request an Access Token using either a client-side obtained OAuth 2.0 authorization code or a server-side JWT assertion. An Access Token is a string that enables Box to verify that a request belongs to an authorized session. In the normal order of operations you will begin by requesting authentication from the [authorize](https://raw.githubusercontent.com) endpoint and Box will send you an authorization code. You will then send this code to this endpoint to exchange it for an Access Token. The returned Access Token can then be used to to make Box API calls.

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "$ref": "#/components/schemas/PostOAuth2Token"
      }
    }
  }
}

Refresh an Access Token using its client ID, secret, and refresh token.

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "$ref": "#/components/schemas/PostOAuth2Token--RefreshAccessToken"
      }
    }
  }
}

Retrieves the classification metadata template and lists all the classifications available to this enterprise. This API can also be called by including the enterprise ID in the URL explicitly, for example `/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`.

Adds one or more new classifications to the list of classifications available to the enterprise. This API can also be called by including the enterprise ID in the URL explicitly, for example `/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ClassificationsAddNewClassificationsRequest"
      }
    }
  }
}

Updates the labels and descriptions of one or more classifications available to the enterprise. This API can also be called by including the enterprise ID in the URL explicitly, for example `/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`.

{
  "content": {
    "application/json-patch+json": {
      "schema": {
        "$ref": "#/components/schemas/ClassificationsUpdateLabelsDescriptionsRequest"
      }
    }
  }
}

When an enterprise does not yet have any classifications, this API call initializes the classification template with an initial set of classifications. If an enterprise already has a classification, the template will already exist and instead an API call should be made to add additional classifications.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ClassificationsInitializeTemplateRequest"
      }
    }
  }
}

Removes any classifications from a file. This API can also be called by including the enterprise ID in the URL explicitly, for example `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

Retrieves the classification metadata instance that has been applied to a file. This API can also be called by including the enterprise ID in the URL explicitly, for example `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

Adds a classification to a file by specifying the label of the classification to add. This API can also be called by including the enterprise ID in the URL explicitly, for example `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ClassificationsOnFilesAddClassificationRequest"
      }
    }
  }
}

Updates a classification on a file. The classification can only be updated if a classification has already been applied to the file before. When editing classifications, only values are defined for the enterprise will be accepted.

{
  "content": {
    "application/json-patch+json": {
      "schema": {
        "$ref": "#/components/schemas/ClassificationsOnFilesUpdateClassificationMetadataInstanceRequest"
      }
    }
  }
}

Removes any classifications from a folder. This API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

Retrieves the classification metadata instance that has been applied to a folder. This API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

Adds a classification to a folder by specifying the label of the classification to add. This API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ClassificationsOnFoldersAddClassificationToFolderRequest"
      }
    }
  }
}

Updates a classification on a folder. The classification can only be updated if a classification has already been applied to the folder before. When editing classifications, only values are defined for the enterprise will be accepted.

{
  "content": {
    "application/json-patch+json": {
      "schema": {
        "$ref": "#/components/schemas/ClassificationsOnFoldersUpdateClassificationRequest"
      }
    }
  }
}

Adds a collaboration for a single user or a single group to a file or folder. Collaborations can be created using email address, user IDs, or a group IDs. If a collaboration is being created with a group, access to this endpoint is dependent on the group's ability to be invited. If collaboration is in `pending` status, the following fields are redacted: - `login` and `name` are hidden if a collaboration was created using `user_id`, - `name` is hidden if a collaboration was created using `login`.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PostCollaborationsRequest"
      }
    }
  }
}

Deletes a single collaboration.

Retrieves a single collaboration.

Updates a collaboration. Can be used to change the owner of an item, or to accept collaboration invites.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/CollaborationsUpdateCollaborationRequest"
      }
    }
  }
}

Retrieves all pending collaboration invites for this user.

Retrieves a list of pending and active collaborations for a file. This returns all the users that have access to the file or have been invited to the file.

Retrieves a list of pending and active collaborations for a folder. This returns all the users that have access to the folder or have been invited to the folder.

Retrieves all the collaborations for a group. The user must have admin permissions to inspect enterprise's groups. Each collaboration object has details on which files or folders the group has access to and with what role.

Retrieves all collections for a given user. Currently, only the `favorites` collection is supported.

Retrieves the files and/or folders contained within this collection.

Adds a comment by the user to a specific file, or as a reply to an other comment.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PostCommentsRequest"
      }
    }
  }
}

Permanently deletes a comment.

Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment.

Update the message of a comment.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/CommentsUpdateMessageRequest"
      }
    }
  }
}

Retrieves a list of comments for a file.

Deletes an individual device pin.

Retrieves information about an individual device pin.

Retrieves all the device pins within an enterprise. The user must have admin privileges, and the application needs the "manage enterprise" scope to make this call.

Returns a list of users who have been exempt from the collaboration domain restrictions.

Exempts a user from the restrictions set out by the allowed list of domains for collaborations.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DomainRestrictionsUserExemptionsCreateUserExemptionFromCollaborationDomainRestrictionsRequest"
      }
    }
  }
}

Removes a user's exemption from the restrictions set out by the allowed list of domains for collaborations.

Returns a users who has been exempt from the collaboration domain restrictions.

Returns the list domains that have been deemed safe to create collaborations for within the current enterprise.

Creates a new entry in the list of allowed domains to allow collaboration for.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DomainRestrictionsForCollaborationsAddAllowedDomainEntryRequest"
      }
    }
  }
}

Removes a domain from the list of domains that have been deemed safe to create collaborations for within the current enterprise.

Returns a domain that has been deemed safe to create collaborations for within the current enterprise.

Returns the contents of a file in binary format.

Retrieves all email aliases for a user. The collection does not include the primary login for the user.

Adds a new email alias to a user account..

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/EmailAliasesCreateNewAliasRequest"
      }
    }
  }
}

Removes an email alias from a user.

Returns up to a year of past events for a given user or for the entire enterprise. By default this returns events for the authenticated user. To retrieve events for the entire enterprise, set the `stream_type` to `admin_logs_streaming` for live monitoring of new events, or `admin_logs` for querying across historical events. The user making the API call will need to have admin privileges, and the application will need to have the scope `manage enterprise properties` checked.

Returns a list of real-time servers that can be used for long-polling updates to the [event stream](https://raw.githubusercontent.com). Long polling is the concept where a HTTP request is kept open until the server sends a response, then repeating the process over and over to receive updated responses. Long polling the event stream can only be used for user events, not for enterprise events. To use long polling, first use this endpoint to retrieve a list of long poll URLs. Next, make a long poll request to any of the provided URLs. When an event occurs in monitored account a response with the value `new_change` will be sent. The response contains no other details as it only serves as a prompt to take further action such as sending a request to the [events endpoint](https://raw.githubusercontent.com) with the last known `stream_position`. After the server sends this response it closes the connection. You must now repeat the long poll process to begin listening for events again. If no events occur for a while and the connection times out you will receive a response with the value `reconnect`. When you receive this response you’ll make another call to this endpoint to restart the process. If you receive no events in `retry_timeout` seconds then you will need to make another request to the real-time server (one of the URLs in the response for this endpoint). This might be necessary due to network errors. Finally, if you receive a `max_retries` error when making a request to the real-time server, you should start over by making a call to this endpoint first.

Deletes a file request permanently.

Retrieves the information about a file request.

Updates a file request. This can be used to activate or deactivate a file request.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FileRequestUpdateRequest"
      }
    }
  }
}

Copies an existing file request that is already present on one folder, and applies it to another folder.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FileRequestCopyRequest"
      }
    }
  }
}

Get a list of file versions on legal hold for a legal hold assignment. Due to ongoing re-architecture efforts this API might not return all file versions for this policy ID. Instead, this API will only return file versions held in the legacy architecture. Two new endpoints will available to request any file versions held in the new architecture. For file versions held in the new architecture, the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold` API can be used to return all past file versions available for this policy assignment, and the `GET /legal_hold_policy_assignments/:id/files_on_hold` API can be used to return any current (latest) versions of a file under legal hold. The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to find a list of policy assignments for a given policy ID. Once the re-architecture is completed this API will be deprecated.

Retrieves information about the legal hold policies assigned to a file version.

Retrieves all file version retentions for the given enterprise.

Returns information about a file version retention.

Retrieve a list of the past versions for a file. Versions are only tracked by Box users with premium accounts. To fetch the ID of the current version of a file, use the `GET /file/:id` API.

Promote a specific version of a file. If previous versions exist, this method can be used to promote one of the older versions to the top of the version history. This creates a new copy of the old version and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the the same hash digest, `etag`, and name as the original. Other properties such as comments do not get updated to their former values. Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FileVersionsPromoteFileVersionRequest"
      }
    }
  }
}

Move a file version to the trash. Versions are only tracked for Box users with premium accounts.

Retrieve a specific version of a file. Versions are only tracked for Box users with premium accounts.

Restores a specific version of a file after it was deleted. Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FileVersionsRestoreVersionRequest"
      }
    }
  }
}

Performs a check to verify that a file will be accepted by Box before you upload the entire file.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FilesPreflightCheckBeforeUploadRequest"
      }
    }
  }
}

Deletes a file, either permanently or by moving it to the trash. The the enterprise settings determine whether the item will be permanently deleted from Box or moved to the trash.

Retrieves the details about a file.

Updates a file. This can be used to rename or move a file, create a shared link, or lock a file.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FilesUpdateFileRequest"
      }
    }
  }
}

Creates a copy of a file.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FilesCreateCopyRequest"
      }
    }
  }
}

Retrieves a thumbnail, or smaller image representation, of a file. Sizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in the `.png` format and sizes of `32x32`, `160x160`, and `320x320` can be returned in the `.jpg` format. Thumbnails can be generated for the image and video file formats listed [found on our community site][1]. [1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327

Retrieves folder lock details for a given folder. You must be authenticated as the owner or co-owner of the folder to use this endpoint.

Creates a folder lock on a folder, preventing it from being moved and/or deleted. You must be authenticated as the owner or co-owner of the folder to use this endpoint.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FolderLocksCreateRequest"
      }
    }
  }
}

Deletes a folder lock on a given folder. You must be authenticated as the owner or co-owner of the folder to use this endpoint.

Creates a new empty folder within the specified parent folder.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PostFoldersRequest"
      }
    }
  }
}

Deletes a folder, either permanently or by moving it to the trash.

Retrieves details for a folder, including the first 100 entries in the folder. Passing `sort`, `direction`, `offset`, and `limit` parameters in query allows you to manage the list of returned [folder items](r://folder--full#param-item-collection). To fetch more items within the folder, use the [Get items in a folder](e://get-folders-id-items) endpoint.

Updates a folder. This can be also be used to move the folder, create shared links, update collaborations, and more.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FoldersUpdateFolderRequest"
      }
    }
  }
}

Creates a copy of a folder within a destination folder. The original folder will not be changed.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FoldersCreateCopyRequest"
      }
    }
  }
}

Retrieves a page of items in a folder. These items can be files, folders, and web links. To request more information about the folder itself, like its size, use the [Get a folder](https://raw.githubusercontent.com) endpoint instead.

Creates a group membership. Only users with admin-level permissions will be able to use this API.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GroupMembershipsCreateMembershipRequest"
      }
    }
  }
}

Deletes a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Retrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Updates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GroupMembershipsUpdateMembershipRequest"
      }
    }
  }
}

Retrieves all the members for a group. Only members of this group or users with admin-level permissions will be able to use this API.

Retrieves all the groups for a user. Only members of this group or users with admin-level permissions will be able to use this API.

Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise's groups.

Creates a new group of users in an enterprise. Only users with admin permissions can create new groups.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PostGroupsRequest"
      }
    }
  }
}

Permanently deletes a group. Only users with admin-level permissions will be able to use this API.

Retrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API.

Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GroupsUpdateGroupRequest"
      }
    }
  }
}

Lists [Slack integration mappings](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) in a users' enterprise. You need Admin or Co-Admin role to use this endpoint.

Creates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) by mapping a Slack channel to a Box item. You need Admin or Co-Admin role to use this endpoint.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/IntegrationMappingSlackCreateRequest"
      }
    }
  }
}

Deletes a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack). You need Admin or Co-Admin role to use this endpoint.

Updates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack). Supports updating the Box folder ID and options. You need Admin or Co-Admin role to use this endpoint.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/IntegrationMappingsUpdateSlackMappingRequest"
      }
    }
  },
  "description": "At least one of `box_item` and `options` must be provided."
}

Invites an existing external user to join an enterprise. The existing user can not be part of another enterprise and must already have a Box account. Once invited, the user will receive an email and are prompted to accept the invitation within the Box web application. This method requires the "Manage An Enterprise" scope enabled for the application, which can be enabled within the developer console.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PostInvitesRequest"
      }
    }
  }
}

Returns the status of a user invite.

Retrieves a list of legal hold policies that belong to an enterprise.

Create a new legal hold policy.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/LegalHoldPoliciesCreateNewPolicyRequest"
      }
    }
  }
}

Delete an existing legal hold policy. This is an asynchronous process. The policy will not be fully deleted yet when the response returns.

Retrieve a legal hold policy.

Update legal hold policy.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/LegalHoldPoliciesUpdatePolicyRequest"
      }
    }
  }
}

Retrieves a list of items a legal hold policy has been assigned to.

Assign a legal hold to a file, file version, folder, or user.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/LegalHoldPolicyAssignmentsAssignFileLegalHoldRequest"
      }
    }
  }
}

Remove a legal hold from an item. This is an asynchronous process. The policy will not be fully removed yet when the response returns.

Retrieve a legal hold policy assignment.

Get a list of previous file versions for a legal hold assignment. In some cases you may only need the latest file versions instead. In these cases, use the `GET /legal_hold_policy_assignments/:id/files_on_hold` API instead to return any current (latest) versions of a file for this legal hold policy assignment. Due to ongoing re-architecture efforts this API might not return all files held for this policy ID. Instead, this API will only return past file versions held in the newly developed architecture. The `GET /file_version_legal_holds` API can be used to fetch current and past versions of files held within the legacy architecture. The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to find a list of policy assignments for a given policy ID.

Get a list of current file versions for a legal hold assignment. In some cases you may want to get previous file versions instead. In these cases, use the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold` API instead to return any previous versions of a file for this legal hold policy assignment. Due to ongoing re-architecture efforts this API might not return all file versions held for this policy ID. Instead, this API will only return the latest file version held in the newly developed architecture. The `GET /file_version_legal_holds` API can be used to fetch current and past versions of files held within the legacy architecture. The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to find a list of policy assignments for a given policy ID.

Retrieves a list of all the metadata cascade policies that are applied to a given folder. This can not be used on the root folder with ID `0`.

Creates a new metadata cascade policy that applies a given metadata template to a given folder and automatically cascades it down to any files within that folder. In order for the policy to be applied a metadata instance must first be applied to the folder the policy is to be applied to.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/MetadataCascadePoliciesCreatePolicyRequest"
      }
    }
  }
}

Deletes a metadata cascade policy.

Retrieve a specific metadata cascade policy assigned to a folder.

Force the metadata on a folder with a metadata cascade policy to be applied to all of its children. This can be used after creating a new cascade policy to enforce the metadata to be cascaded down to all existing files within that folder.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/MetadataCascadePoliciesApplyToChildrenRequest"
      }
    }
  }
}

Retrieves all metadata for a given file.

Deletes a piece of file metadata.

Retrieves the instance of a metadata template that has been applied to a file.

Applies an instance of a metadata template to a file. In most cases only values that are present in the metadata template will be accepted, except for the `global.properties` template which accepts any key-value pair.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/MetadataInstancesFilesApplyTemplateRequest"
      }
    }
  }
}

Updates a piece of metadata on a file. The metadata instance can only be updated if the template has already been applied to the file before. When editing metadata, only values that match the metadata template schema will be accepted. The update is applied atomically. If any errors occur during the application of the operations, the metadata instance will not be changed.

{
  "content": {
    "application/json-patch+json": {
      "schema": {
        "$ref": "#/components/schemas/MetadataInstancesFilesUpdateInstanceOnFileRequest"
      }
    }
  }
}

Retrieves all metadata for a given folder. This can not be used on the root folder with ID `0`.

Deletes a piece of folder metadata.

Retrieves the instance of a metadata template that has been applied to a folder. This can not be used on the root folder with ID `0`.

Applies an instance of a metadata template to a folder. In most cases only values that are present in the metadata template will be accepted, except for the `global.properties` template which accepts any key-value pair. To display the metadata template in the Box web app the enterprise needs to be configured to enable **Cascading Folder Level Metadata** for the user in the admin console.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/MetadataInstancesFoldersApplyTemplateRequest"
      }
    }
  }
}

Updates a piece of metadata on a folder. The metadata instance can only be updated if the template has already been applied to the folder before. When editing metadata, only values that match the metadata template schema will be accepted. The update is applied atomically. If any errors occur during the application of the operations, the metadata instance will not be changed.

{
  "content": {
    "application/json-patch+json": {
      "schema": {
        "$ref": "#/components/schemas/MetadataInstancesFoldersUpdateInstanceOnFolderRequest"
      }
    }
  }
}

Finds a metadata template by searching for the ID of an instance of the template.

Used to retrieve all metadata templates created to be used specifically within the user's enterprise

Used to retrieve all generic, global metadata templates available to all enterprises using Box.

Creates a new metadata template that can be applied to files and folders.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/MetadataTemplatesCreateNewTemplateRequest"
      }
    }
  }
}

Delete a metadata template and its instances. This deletion is permanent and can not be reversed.

Retrieves a metadata template by its `scope` and `templateKey` values. To find the `scope` and `templateKey` for a template, list all templates for an enterprise or globally, or list all templates applied to a file or folder.

Updates a metadata template. The metadata template can only be updated if the template already exists. The update is applied atomically. If any errors occur during the application of the operations, the metadata template will not be changed.

{
  "content": {
    "application/json-patch+json": {
      "schema": {
        "$ref": "#/components/schemas/MetadataTemplatesUpdateSchemaRequest"
      }
    }
  }
}

Retrieves a metadata template by its ID.

Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed.

Retrieves all of the retention policies for an enterprise.

Creates a retention policy.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/RetentionPoliciesCreatePolicyRequest"
      }
    }
  }
}

Permanently deletes a retention policy.

Retrieves a retention policy.

Updates a retention policy.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/RetentionPoliciesUpdatePolicyRequest"
      }
    }
  }
}

Returns a list of all retention policy assignments associated with a specified retention policy.

Assigns a retention policy to an item.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/RetentionPolicyAssignmentsCreateRetentionAssignmentRequest"
      }
    }
  }
}

Removes a retention policy assignment applied to content.

Retrieves a retention policy assignment

Returns a list of file versions under retention for a retention policy assignment.

Returns a list of files under retention for a retention policy assignment.

Create a search using SQL-like syntax to return items that match specific metadata. By default, this endpoint returns only the most basic info about the items for which the query matches. To get additional fields for each item, including any of the metadata, use the `fields` attribute in the query.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/MetadataQuery"
      }
    }
  }
}

Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.

Validates the roles and permissions of the group, and creates asynchronous jobs to terminate the group's sessions. Returns the status for the POST request.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SessionTerminationCreateTerminationJobsRequest"
      }
    }
  }
}

Validates the roles and permissions of the user, and creates asynchronous jobs to terminate the user's sessions. Returns the status for the POST request.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SessionTerminationCreateSessionTerminationJobsRequest"
      }
    }
  }
}

Adds a shared link to a file.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SharedLinksFilesAddSharedLinkToFileRequest"
      }
    }
  }
}

Gets the information for a shared link on a file.

Removes a shared link from a file.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SharedLinksFilesRemoveSharedLinkRequest"
      }
    }
  }
}