Sign in

v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB
Legal hold policies

Get legal hold policy

Retrieve a legal hold policy.

get/legal_hold_policies/{legal_hold_policy_id}

Path parameters

legal_hold_policy_idstring required

The ID of the legal hold policy.

Response

Returns a legal hold policy object.

idstring required

The unique identifier for this legal hold policy.

type'legal_hold_policy' required

The value will always be legal_hold_policy.

policy_namestring

Name of the legal hold policy.

descriptionstring

Description of the legal hold policy. Optional property with a 500 character limit.

status'active' | 'applying' | 'releasing' | 'released'

Possible values:

  • 'active' - the policy is not in a transition state.
  • 'applying' - that the policy is in the process of being applied.
  • 'releasing' - that the process is in the process of being released.
  • 'released' - the policy is no longer active.
created_atstring date-time

When the legal hold policy object was created.

modified_atstring date-time

When the legal hold policy object was modified. Does not update when assignments are added or removed.

deleted_atstring date-time

When the policy release request was sent. (Because it can take time for a policy to fully delete, this isn't quite the same time that the policy is fully deleted).

If null, the policy was not deleted.

filter_started_atstring date-time

User-specified, optional date filter applies to Custodian assignments only.

filter_ended_atstring date-time

User-specified, optional date filter applies to Custodian assignments only.

release_notesstring

Optional notes about why the policy was created.

Example response

{
  "id": "11446498",
  "type": "legal_hold_policy",
  "policy_name": "Policy 4",
  "description": "Postman created policy",
  "status": "active",
  "assignment_counts": {
    "user": 1,
    "folder": 2,
    "file": 3,
    "file_version": 4,
    "ownership": 5,
    "interactions": 6
  },
  "created_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "deleted_at": "2012-12-12T10:53:43-08:00",
  "filter_started_at": "2012-12-12T10:53:43-08:00",
  "filter_ended_at": "2012-12-12T10:53:43-08:00",
  "release_notes": "Example"
}