Skip to main content
REST API reference
A newer release of this product is available.

Start a legal-hold operation

PDFs

POST /storage/snaplock/litigations

Starts a Legal-Hold.

Required properties

  • path - Path of the file.

  • name - Litigation name.

  • volume.name or volume.uuid - Name or UUID of the volume.

  • snaplock legal-hold begin

Example

POST "/api/storage/snaplock/litigations" '{"volume.name":"SLC1","name":"l3","path":"/b.txt"}'

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

Request Body

Name Type Description

_links

_links

id

string

Specifies the litigation ID.

name

string

Specifies the legal-hold litigation name.

operations

array[snaplock_legal_hold_operation]

path

string

Specifies the path on which legal-hold operation has to be applied.

svm

svm

volume

volume
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "id": "string",
  "name": "lit1",
  "operations": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "id": 16842759,
      "num_files_failed": 0,
      "num_files_processed": 30,
      "num_files_skipped": 10,
      "num_inodes_ignored": 10,
      "path": "/dir1",
      "state": "completed"
    }
  ],
  "path": "/dir1",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "volume": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "volume1",
    "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 201, Created
Name Type Description

_links

_links

id

string

Specifies the litigation ID.

name

string

Specifies the legal-hold litigation name.

operations

array[snaplock_legal_hold_operation]

path

string

Specifies the path on which legal-hold operation has to be applied.

svm

svm

volume

volume
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "id": "string",
  "name": "lit1",
  "operations": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "id": 16842759,
      "num_files_failed": 0,
      "num_files_processed": 30,
      "num_files_skipped": 10,
      "num_inodes_ignored": 10,
      "path": "/dir1",
      "state": "completed"
    }
  ],
  "path": "/dir1",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "volume": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "volume1",
    "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
  }
}

Error

Status: Default

ONTAP Error Response codes

Error code Description

14090346

Internal Error. Wait a few minutes, then try the command again

14090340

{field} is a required field

14090343

Invalid Field

14090641

The specified volume.name and volume.uuid refer to different volumes
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href
Name Type Description

_links

_links

id

integer

Operation ID.

num_files_failed

string

Specifies the number of files on which legal-hold operation failed.

num_files_processed

string

Specifies the number of files on which legal-hold operation was successful.

num_files_skipped

string

Specifies the number of files on which legal-hold begin operation was skipped. The legal-hold begin operation is skipped on a file if it is already under hold for a given litigation.

num_inodes_ignored

string

Specifies the number of inodes on which the legal-hold operation was not attempted because they were not regular files.

path

string

Specifies the path on which legal-hold operation is applied.

state

string

Specifies the status of legal-hold operation.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

volume

Name Type Description

_links

_links

name

string

The name of the volume.

uuid

string

Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.

  • example: 028baa66-41bd-11e9-81d5-00a0986138f7

snaplock_litigation

Name Type Description

_links

_links

id

string

Specifies the litigation ID.

name

string

Specifies the legal-hold litigation name.

operations

array[snaplock_legal_hold_operation]

path

string

Specifies the path on which legal-hold operation has to be applied.

svm

svm

volume

volume

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.