Retrieve applications

08/29/2024 Contributors

GET /application/applications

Introduced In: 9.6

Retrieves applications.

Expensive properties

There is an added computational cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

<template> the property corresponding to the template.name of the application

Query examples

Numerous queries are available for classifying and sorting applications:

Return a list of applications sorted by name.

  GET /application/applications?order_by=name

Return a list of applications for a specific SVM.

  GET /application/applications?svm.name=<name>

Return a list of all SQL applications.

  GET /application/applications?template.name=sql*

Return a list of all applications that can be accessed via SAN.
```
  GET /application/applications?template.protocol=san
```

Return the top five applications consuming the most IOPS.

  GET /application/applications?order_by=statistics.iops.total desc&max_records=5

The above examples are not comprehensive. There are many more properties available for queries. Also, multiple queries can be mixed and matched with other query parameters for a large variety of requests. See the per-property documentation below for the full list of supported query parameters.

Learn more

DOC /application

Parameters

Name	Type	In	Required	Description
uuid	string	query	False	Filter by UUID
name	string	query	False	Filter by name
svm.name	string	query	False	Filter by svm.name
svm.uuid	string	query	False	Filter by svm.uuid
template.name	string	query	False	Filter by template.name
template.version	string	query	False	Filter by template.version
template.protocol	string	query	False	Filter by template.protocol
generation	string	query	False	Filter by generation
state	string	query	False	Filter by state
protection_granularity	string	query	False	Filter by protection granularity
rpo.is_supported	string	query	False	Filter by rpo.is_supported
rpo.local.name	string	query	False	Filter by rpo.local.name
rpo.local.description	string	query	False	Filter by rpo.local.description
rpo.remote.name	string	query	False	Filter by rpo.remote.name
rpo.remote.description	string	query	False	Filter by rpo.remote.description
rpo.components.name	string	query	False	Filter by rpo.components.name
rpo.components.uuid	string	query	False	Filter by rpo.components.uuid
rpo.components.rpo.local.name	string	query	False	Filter by rpo.components.rpo.local.name Introduced in: 9.7
rpo.components.rpo.local.description	string	query	False	Filter by rpo.components.rpo.local.description
rpo.components.rpo.remote.name	string	query	False	Filter by rpo.components.rpo.remote.name
rpo.components.rpo.remote.description	string	query	False	Filter by rpo.components.rpo.remote.description
statistics.space.provisioned	string	query	False	Filter by statistics.space.provisioned
statistics.space.used	string	query	False	Filter by statistics.space.used
statistics.space.used_percent	string	query	False	Filter by statistics.space.used_percent
statistics.space.used_excluding_reserves	string	query	False	Filter by statistics.space.used_excluding_reserves
statistics.space.logical_used	string	query	False	Filter by statistics.space.logical_used
statistics.space.reserved_unused	string	query	False	Filter by statistics.space.reserved_unused
statistics.space.available	string	query	False	Filter by statistics.space.available
statistics.space.savings	string	query	False	Filter by statistics.space.savings
statistics.iops.total	string	query	False	Filter by statistics.iops.total
statistics.iops.per_tb	string	query	False	Filter by statistics.iops.per_tb
statistics.snapshot.reserve	string	query	False	Filter by statistics.snapshot.reserve
statistics.snapshot.used	string	query	False	Filter by statistics.snapshot.used
statistics.latency.raw	string	query	False	Filter by statistics.latency.raw
statistics.latency.average	string	query	False	Filter by statistics.latency.average
statistics.statistics_incomplete	string	query	False	Filter by statistics.statistics_incomplete
statistics.shared_storage_pool	string	query	False	Filter by statistics.shared_storage_pool
statistics.components.name	string	query	False	Filter by statistics.components.name
statistics.components.uuid	string	query	False	Filter by statistics.components.uuid
statistics.components.storage_service.name	string	query	False	Filter by statistics.components.storage_service.name
statistics.components.space.provisioned	string	query	False	Filter by statistics.components.space.provisioned
statistics.components.space.used	string	query	False	Filter by statistics.components.space.used
statistics.components.space.used_percent	string	query	False	Filter by statistics.components.space.used_percent
statistics.components.space.used_excluding_reserves	string	query	False	Filter by statistics.components.space.used_excluding_reserves
statistics.components.space.logical_used	string	query	False	Filter by statistics.components.space.logical_used
statistics.components.space.reserved_unused	string	query	False	Filter by statistics.components.space.reserved_unused
statistics.components.space.available	string	query	False	Filter by statistics.components.space.available
statistics.components.space.savings	string	query	False	Filter by statistics.components.space.savings
statistics.components.iops.total	string	query	False	Filter by statistics.components.iops.total
statistics.components.iops.per_tb	string	query	False	Filter by statistics.components.iops.per_tb
statistics.components.snapshot.reserve	string	query	False	Filter by statistics.components.snapshot.reserve
statistics.components.snapshot.used	string	query	False	Filter by statistics.components.snapshot.used
statistics.components.latency.raw	string	query	False	Filter by statistics.components.latency.raw
statistics.components.latency.average	string	query	False	Filter by statistics.components.latency.average
statistics.components.statistics_incomplete	string	query	False	Filter by statistics.components.statistics_incomplete
statistics.components.shared_storage_pool	string	query	False	Filter by statistics.components.shared_storage_pool
smart_container	string	query	False	Filter by smart_container Introduced in: 9.7
fields	array[string]	query	False	Specify the fields to return.
max_records	integer	query	False	Limit the number of records returned.
return_timeout	integer	query	False	The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached. Default value: 1 Max value: 120 Min value: 0
return_records	boolean	query	False	The default is true for GET calls. When set to false, only the number of records is returned. Default value: 1
order_by	array[string]	query	False	Order results by specified fields and optional [asc

Name

Type

Required

Description

uuid

string

query

False

Filter by UUID

name

string

query

False

Filter by name

svm.name

string

query

False

Filter by svm.name

svm.uuid

string

query

False

Filter by svm.uuid

template.name

string

query

False

Filter by template.name

template.version

string

query

False

Filter by template.version

template.protocol

string

query

False

Filter by template.protocol

generation

string

query

False

Filter by generation

state

string

query

False

Filter by state

protection_granularity

string

query

False

Filter by protection granularity

rpo.is_supported

string

query

False

Filter by rpo.is_supported

rpo.local.name

string

query

False

Filter by rpo.local.name

rpo.local.description

string

query

False

Filter by rpo.local.description

rpo.remote.name

string

query

False

Filter by rpo.remote.name

rpo.remote.description

string

query

False

Filter by rpo.remote.description

rpo.components.name

string

query

False

Filter by rpo.components.name

rpo.components.uuid

string

query

False

Filter by rpo.components.uuid

rpo.components.rpo.local.name

string

query

False

Filter by rpo.components.rpo.local.name

Introduced in: 9.7

rpo.components.rpo.local.description

string

query

False

Filter by rpo.components.rpo.local.description

rpo.components.rpo.remote.name

string

query

False

Filter by rpo.components.rpo.remote.name

rpo.components.rpo.remote.description

string

query

False

Filter by rpo.components.rpo.remote.description

statistics.space.provisioned

string

query

False

Filter by statistics.space.provisioned

statistics.space.used

string

query

False

Filter by statistics.space.used

statistics.space.used_percent

string

query

False

Filter by statistics.space.used_percent

statistics.space.used_excluding_reserves

string

query

False

Filter by statistics.space.used_excluding_reserves

statistics.space.logical_used

string

query

False

Filter by statistics.space.logical_used

statistics.space.reserved_unused

string

query

False

Filter by statistics.space.reserved_unused

statistics.space.available

string

query

False

Filter by statistics.space.available

statistics.space.savings

string

query

False

Filter by statistics.space.savings

statistics.iops.total

string

query

False

Filter by statistics.iops.total

statistics.iops.per_tb

string

query

False

Filter by statistics.iops.per_tb

statistics.snapshot.reserve

string

query

False

Filter by statistics.snapshot.reserve

statistics.snapshot.used

string

query

False

Filter by statistics.snapshot.used

statistics.latency.raw

string

query

False

Filter by statistics.latency.raw

statistics.latency.average

string

query

False

Filter by statistics.latency.average

statistics.statistics_incomplete

string

query

False

Filter by statistics.statistics_incomplete

statistics.shared_storage_pool

string

query

False

Filter by statistics.shared_storage_pool

statistics.components.name

string

query

False

Filter by statistics.components.name

statistics.components.uuid

string

query

False

Filter by statistics.components.uuid

statistics.components.storage_service.name

string

query

False

Filter by statistics.components.storage_service.name

statistics.components.space.provisioned

string

query

False

Filter by statistics.components.space.provisioned

statistics.components.space.used

string

query

False

Filter by statistics.components.space.used

statistics.components.space.used_percent

string

query

False

Filter by statistics.components.space.used_percent

statistics.components.space.used_excluding_reserves

string

query

False

Filter by statistics.components.space.used_excluding_reserves

statistics.components.space.logical_used

string

query

False

Filter by statistics.components.space.logical_used

statistics.components.space.reserved_unused

string

query

False

Filter by statistics.components.space.reserved_unused

statistics.components.space.available

string

query

False

Filter by statistics.components.space.available

statistics.components.space.savings

string

query

False

Filter by statistics.components.space.savings

statistics.components.iops.total

string

query

False

Filter by statistics.components.iops.total

statistics.components.iops.per_tb

string

query

False

Filter by statistics.components.iops.per_tb

statistics.components.snapshot.reserve

string

query

False

Filter by statistics.components.snapshot.reserve

statistics.components.snapshot.used

string

query

False

Filter by statistics.components.snapshot.used

statistics.components.latency.raw

string

query

False

Filter by statistics.components.latency.raw

statistics.components.latency.average

string

query

False

Filter by statistics.components.latency.average

statistics.components.statistics_incomplete

string

query

False

Filter by statistics.components.statistics_incomplete

statistics.components.shared_storage_pool

string

query

False

Filter by statistics.components.shared_storage_pool

smart_container

string

query

False

Filter by smart_container

Introduced in: 9.7

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

Default value: 1
Max value: 120
Min value: 0

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

Default value: 1

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok

Name	Type	Description
_links	_links
num_records	integer	Number of records
records	array[application]

Name

Type

Description

_links

num_records

integer

Number of records

records

array[application]

Example response

{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        },
        "snapshots": {
          "href": "/api/resourcelink"
        }
      },
      "creation_timestamp": "string",
      "generation": 0,
      "name": "string",
      "nas": {
        "application_components": [
          {
          }
        ],
        "cifs_access": [
          {
            "access": "string",
            "user_or_group": "string"
          }
        ],
        "cifs_share_name": "string",
        "exclude_aggregates": [
          {
            "name": "string",
            "uuid": "string"
          }
        ],
        "nfs_access": [
          {
            "access": "string",
            "host": "string"
          }
        ],
        "protection_type": {
          "local_policy": "string",
          "local_rpo": "string",
          "remote_rpo": "string"
        }
      },
      "nvme": {
        "components": [
          {
            "name": "string",
            "os_type": "string",
            "performance": {
              "storage_service": {
                "name": "string"
              }
            },
            "qos": {
              "policy": {
                "name": "string",
                "uuid": "string"
              }
            },
            "subsystem": {
              "hosts": [
                {
                  "nqn": "string"
                }
              ],
              "name": "string",
              "os_type": "string",
              "uuid": "string"
            },
            "tiering": {
              "control": "string",
              "object_stores": [
                {
                  "name": "string"
                }
              ],
              "policy": "string"
            }
          }
        ],
        "os_type": "string",
        "rpo": {
          "local": {
            "name": "string",
            "policy": "string"
          }
        }
      },
      "protection_granularity": "string",
      "rpo": {
        "components": [
          {
            "name": "string",
            "rpo": {
              "local": {
                "description": "string",
                "name": "string"
              },
              "remote": {
                "description": "string",
                "name": "string"
              }
            },
            "uuid": "string"
          }
        ],
        "local": {
          "description": "string",
          "name": "string"
        },
        "remote": {
          "description": "string",
          "name": "string"
        }
      },
      "s3_bucket": {
        "application_components": [
          {
            "access_policies": [
              {
                "actions": [
                  "string"
                ],
                "conditions": [
                  {
                    "delimiters": [
                      "string"
                    ],
                    "max_keys": [
                      "integer"
                    ],
                    "operator": "string",
                    "prefixes": [
                      "string"
                    ],
                    "source_ips": [
                      "string"
                    ],
                    "usernames": [
                      "string"
                    ]
                  }
                ],
                "effect": "string",
                "principals": [
                  "string"
                ],
                "resources": [
                  "string"
                ],
                "sid": "string"
              }
            ],
            "bucket_endpoint_type": "string",
            "comment": "string",
            "exclude_aggregates": [
              {
                "name": "string",
                "uuid": "string"
              }
            ],
            "name": "string",
            "nas_path": "string",
            "qos": {
              "policy": {
                "name": "string",
                "uuid": "string"
              }
            },
            "storage_service": {
              "name": "string"
            },
            "uuid": "string",
            "versioning_state": "string"
          }
        ]
      },
      "san": {
        "application_components": [
          {
            "igroup_name": "string",
            "name": "string",
            "os_type": "string",
            "qos": {
              "policy": {
                "name": "string",
                "uuid": "string"
              }
            },
            "storage_service": {
              "name": "string"
            },
            "tiering": {
              "control": "string",
              "object_stores": [
                {
                  "name": "string"
                }
              ],
              "policy": "string"
            }
          }
        ],
        "exclude_aggregates": [
          {
            "name": "string",
            "uuid": "string"
          }
        ],
        "new_igroups": [
          {
            "comment": "string",
            "igroups": [
              {
                "name": "string",
                "uuid": "string"
              }
            ],
            "initiator_objects": [
              {
                "comment": "string",
                "name": "string"
              }
            ],
            "initiators": [
              "string"
            ],
            "name": "string",
            "os_type": "string",
            "protocol": "string"
          }
        ],
        "os_type": "string",
        "protection_type": {
          "local_policy": "string",
          "local_rpo": "string",
          "remote_rpo": "string"
        }
      },
      "state": "string",
      "statistics": {
        "components": [
          {
            "iops": {
              "per_tb": 0,
              "total": 0
            },
            "latency": {
              "average": 0,
              "raw": 0
            },
            "name": "string",
            "snapshot": {
              "reserve": 0,
              "used": 0
            },
            "space": {
              "available": 0,
              "logical_used": 0,
              "provisioned": 0,
              "reserved_unused": 0,
              "savings": 0,
              "used": 0,
              "used_excluding_reserves": 0,
              "used_percent": 0
            },
            "storage_service": {
              "name": "string",
              "uuid": "string"
            },
            "uuid": "string"
          }
        ],
        "iops": {
          "per_tb": 0,
          "total": 0
        },
        "latency": {
          "average": 0,
          "raw": 0
        },
        "snapshot": {
          "reserve": 0,
          "used": 0
        },
        "space": {
          "available": 0,
          "logical_used": 0,
          "provisioned": 0,
          "reserved_unused": 0,
          "savings": 0,
          "used": 0,
          "used_excluding_reserves": 0,
          "used_percent": 0
        }
      },
      "svm": {
        "name": "string",
        "uuid": "string"
      },
      "template": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "string",
        "protocol": "string",
        "version": 0
      },
      "uuid": "string"
    }
  ]
}

Error

Status: Default, Error

Name	Type	Description
error	error

Name

Type

Description

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

Name

Type

Description

href

string

_links

Name	Type	Description
next	href
self	href

Name

Type

Description

href

self

href

_links

Name	Type	Description
self	href
snapshots	href

Name

Type

Description

self

href

snapshots

href

storage_service

Name	Type	Description
name	string	The storage service of the database.

Name

Type

Description

name

string

The storage service of the database.

dataset

Name	Type	Description
element_count	integer	The number of storage elements (LUNs for SAN) of the database to maintain. Must be an even number between 2 and 16. Odd numbers will be rounded up to the next even number within range.
replication_factor	integer	The number of data bearing members of the replicaset, including 1 primary and at least 1 secondary.
size	integer	The size of the database. Usage: {<integer>[KB\|MB\|GB\|TB\|PB]}
storage_service	storage_service

Name

Type

Description

element_count

integer

The number of storage elements (LUNs for SAN) of the database to maintain. Must be an even number between 2 and 16. Odd numbers will be rounded up to the next even number within range.

replication_factor

integer

The number of data bearing members of the replicaset, including 1 primary and at least 1 secondary.

size

integer

The size of the database. Usage: {<integer>[KB|MB|GB|TB|PB]}

storage_service

igroups

Name	Type	Description
name	string	The name of an igroup to nest within a parent igroup. Mutually exclusive with initiators and initiator_objects.
uuid	string	The UUID of an igroup to nest within a parent igroup Usage: <UUID>

Name

Type

Description

name

string

The name of an igroup to nest within a parent igroup. Mutually exclusive with initiators and initiator_objects.

uuid

string

The UUID of an igroup to nest within a parent igroup Usage: <UUID>

initiator_objects

Name	Type	Description
comment	string	A comment available for use by the administrator.
name	string	The WWPN, IQN, or Alias of the initiator. Mutually exclusive with nested igroups and the initiators array.

Name

Type

Description

comment

string

A comment available for use by the administrator.

name

string

The WWPN, IQN, or Alias of the initiator. Mutually exclusive with nested igroups and the initiators array.

mongo_db_on_san_new_igroups

The list of initiator groups to create.

Name	Type	Description
comment	string	A comment available for use by the administrator.
igroups	array[igroups]
initiator_objects	array[initiator_objects]
initiators	array[string]
name	string	The name of the new initiator group.
os_type	string	The name of the host OS accessing the application. The default value is the host OS that is running the application.
protocol	string	The protocol of the new initiator group.

Name

Type

Description

comment

string

A comment available for use by the administrator.

igroups

array[igroups]

initiator_objects

array[initiator_objects]

initiators

array[string]

name

string

The name of the new initiator group.

os_type

string

The name of the host OS accessing the application. The default value is the host OS that is running the application.

protocol

string

The protocol of the new initiator group.

protection_type

Name	Type	Description
local_rpo	string	The local RPO of the application.
remote_rpo	string	The remote RPO of the application.

Name

Type

Description

local_rpo

string

The local RPO of the application.

remote_rpo

string

The remote RPO of the application.

secondary_igroups

Name	Type	Description
name	string	The name of the initiator group for each secondary.

Name

Type

Description

name

string

The name of the initiator group for each secondary.

mongo_db_on_san

MongoDB using SAN.

Name	Type	Description
dataset	dataset
new_igroups	array[mongo_db_on_san_new_igroups]	The list of initiator groups to create.
os_type	string	The name of the host OS running the application.
primary_igroup_name	string	The initiator group for the primary.
protection_type	protection_type
secondary_igroups	array[secondary_igroups]

Name

Type

Description

dataset

new_igroups

array[mongo_db_on_san_new_igroups]

The list of initiator groups to create.

os_type

string

The name of the host OS running the application.

primary_igroup_name

string

The initiator group for the primary.

protection_type

secondary_igroups

array[secondary_igroups]

export_policy

Name	Type	Description
id	integer	The ID of an existing NFS export policy.
name	string	The name of an existing NFS export policy.

Name

Type

Description

integer

The ID of an existing NFS export policy.

name

string

The name of an existing NFS export policy.

component

Name	Type	Description
name	string	Name of the source component.

Name

Type

Description

name

string

Name of the source component.

svm

Name	Type	Description
name	string	Name of the source SVM.

Name

Type

Description

name

string

Name of the source SVM.

origin

Name	Type	Description
component	component
svm	svm

Name

Type

Description

component

svm

flexcache

Name	Type	Description
dr_cache	boolean	Dr-cache is a FlexCache volume create time option that has the same flexgroup-msid as that of the origin of a FlexCache volume. By default, dr-cache is disabled. The flexgroup-msid of the FlexCache volume does not need to be same as that of the origin of a FlexCache volume.
origin	origin

Name

Type

Description

dr_cache

boolean

Dr-cache is a FlexCache volume create time option that has the same flexgroup-msid as that of the origin of a FlexCache volume. By default, dr-cache is disabled. The flexgroup-msid of the FlexCache volume does not need to be same as that of the origin of a FlexCache volume.

origin

policy

Name	Type	Description
name	string	The name of an existing QoS policy.
uuid	string	The UUID of an existing QoS policy. Usage: <UUID>

Name

Type

Description

name

string

The name of an existing QoS policy.

uuid

string

The UUID of an existing QoS policy. Usage: <UUID>

qos

Name	Type	Description
policy	policy

Name

Type

Description

policy

retention

Name	Type	Description
default	string	Specifies the default retention period that is applied to files while committing them to the WORM state without an associated retention period. The retention value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, days, hours, and minutes. A duration specified for years, months, and days is represented in the ISO-8601 format as quot;Plt;num>Y", "P<num>M", "P<num>D" respectively, for example "P10Y" represents a duration of 10 years. A duration in hours and minutes is represented by "PT<num>H" and "PT<num>M" respectively. The retention string must contain only a single time element that is, either years, months, days, hours, or minutes. A duration which combines different periods is not supported, for example "P1Y10M" is not supported. Apart from the duration specified in the ISO-8601 format, the duration field also accepts the string "infinite" to set an infinite retention period and the string "unspecified" to set an unspecified retention period.
maximum	string	Specifies the maximum allowed retention period for files committed to the WORM state on the volume. The retention value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, days, hours, and minutes. A duration specified for years, months, and days is represented in the ISO-8601 format as "P<num>Y", "P<num>M", "P<num>D" respectively, for example "P10Y" represents a duration of 10 years. A duration in hours and minutes is represented by "PT<num>H" and "PT<num>M" respectively. The retention string must contain only a single time element that is, either years, months, days, hours, or minutes. A duration which combines different periods is not supported, for example "P1Y10M" is not supported. Apart from the duration specified in the ISO-8601 format, the duration field also accepts the string "infinite" to set an infinite retention period.
minimum	string	Specifies the minimum allowed retention period for files committed to the WORM state on the volume. The retention value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, days, hours, and minutes. A duration specified for years, month,s and days is represented in the ISO-8601 format as "P<num>Y", "P<num>M", "P<num>D" respectively, for example "P10Y" represents a duration of 10 years. A duration in hours and minutes is represented by "PT<num>H" and "PT<num>M" respectively. The retention string must contain only a single time element that is, either years, months, days, hours, or minutes. A duration which combines different periods is not supported, for example "P1Y10M" is not supported. Apart from the duration specified in the ISO-8601 format, the duration field also accepts the string "infinite" to set an infinite retention period.

Name

Type

Description

default

string

Specifies the default retention period that is applied to files while committing them to the WORM state without an associated retention period. The retention value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, days, hours, and minutes. A duration specified for years, months, and days is represented in the ISO-8601 format as quot;Plt;num>Y", "P<num>M", "P<num>D" respectively, for example "P10Y" represents a duration of 10 years. A duration in hours and minutes is represented by "PT<num>H" and "PT<num>M" respectively. The retention string must contain only a single time element that is, either years, months, days, hours, or minutes. A duration which combines different periods is not supported, for example "P1Y10M" is not supported. Apart from the duration specified in the ISO-8601 format, the duration field also accepts the string "infinite" to set an infinite retention period and the string "unspecified" to set an unspecified retention period.

maximum

string

Specifies the maximum allowed retention period for files committed to the WORM state on the volume. The retention value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, days, hours, and minutes. A duration specified for years, months, and days is represented in the ISO-8601 format as "P<num>Y", "P<num>M", "P<num>D" respectively, for example "P10Y" represents a duration of 10 years. A duration in hours and minutes is represented by "PT<num>H" and "PT<num>M" respectively. The retention string must contain only a single time element that is, either years, months, days, hours, or minutes. A duration which combines different periods is not supported, for example "P1Y10M" is not supported. Apart from the duration specified in the ISO-8601 format, the duration field also accepts the string "infinite" to set an infinite retention period.

minimum

string

Specifies the minimum allowed retention period for files committed to the WORM state on the volume. The retention value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, days, hours, and minutes. A duration specified for years, month,s and days is represented in the ISO-8601 format as "P<num>Y", "P<num>M", "P<num>D" respectively, for example "P10Y" represents a duration of 10 years. A duration in hours and minutes is represented by "PT<num>H" and "PT<num>M" respectively. The retention string must contain only a single time element that is, either years, months, days, hours, or minutes. A duration which combines different periods is not supported, for example "P1Y10M" is not supported. Apart from the duration specified in the ISO-8601 format, the duration field also accepts the string "infinite" to set an infinite retention period.

snaplock

Name	Type	Description
append_mode_enabled	boolean	Specifies if the volume append mode is enabled or disabled. When it is enabled, all the files created with write permissions on the volume are, by default, WORM appendable files. The user can append the data to a WORM appendable file but cannot modify the existing contents of the file nor delete the file until it expires.

Name

Type

Description

append_mode_enabled

boolean

Specifies if the volume append mode is enabled or disabled. When it is enabled, all the files created with write permissions on the volume are, by default, WORM appendable files. The user can append the data to a WORM appendable file but cannot modify the existing contents of the file nor delete the file until it expires.

Retrieve applications

Creating your file...

Expensive properties

Query examples

Learn more

Parameters

Response

Error

Definitions