From 077611239804017414ad3f375271fa0fea6325de Mon Sep 17 00:00:00 2001 From: Jakub Tischler Date: Wed, 21 May 2025 17:36:11 +0200 Subject: [PATCH 1/4] Testing of generating of index.html --- FlashArray.html | 7 ++ FlashBlade.html | 7 ++ Pure1.html | 7 ++ _includes/fa_links.html | 41 ++++++ _includes/fa_select.html | 43 +++++++ _includes/fb_links.html | 18 +++ _includes/fb_select.html | 20 +++ _includes/files_fa.html | 41 ++++++ _includes/files_fb.html | 18 +++ _includes/files_pure1.html | 6 + _includes/nav.html | 4 + _includes/pure1_links.html | 6 + _includes/pure1_select.html | 8 ++ _includes/table_with_links.html | 154 +++++++++++++++++++++++ _layouts/default.html | 56 +++++++++ _templates/links.mustache | 3 + _templates/select.mustache | 5 + _templates/table.mustache | 14 +++ assets/css/style.scss | 5 + index.html | 9 ++ scripts/apply_templates.py | 94 ++++++++++++++ scripts/requirements_apply_templates.txt | 1 + 22 files changed, 567 insertions(+) create mode 100644 FlashArray.html create mode 100644 FlashBlade.html create mode 100644 Pure1.html create mode 100644 _includes/fa_links.html create mode 100644 _includes/fa_select.html create mode 100644 _includes/fb_links.html create mode 100644 _includes/fb_select.html create mode 100644 _includes/files_fa.html create mode 100644 _includes/files_fb.html create mode 100644 _includes/files_pure1.html create mode 100644 _includes/nav.html create mode 100644 _includes/pure1_links.html create mode 100644 _includes/pure1_select.html create mode 100644 _includes/table_with_links.html create mode 100644 _layouts/default.html create mode 100644 _templates/links.mustache create mode 100644 _templates/select.mustache create mode 100644 _templates/table.mustache create mode 100644 assets/css/style.scss create mode 100644 index.html create mode 100755 scripts/apply_templates.py create mode 100644 scripts/requirements_apply_templates.txt diff --git a/FlashArray.html b/FlashArray.html new file mode 100644 index 0000000..9e3a8ce --- /dev/null +++ b/FlashArray.html @@ -0,0 +1,7 @@ +--- +layout: default +title: Swagger +description: A list of redoc specifications for released versions of Flash Array, Flash Blade and Pure1. +--- +
FlashArray
+{% include fa_select.html %} diff --git a/FlashBlade.html b/FlashBlade.html new file mode 100644 index 0000000..5b3b650 --- /dev/null +++ b/FlashBlade.html @@ -0,0 +1,7 @@ +--- +layout: default +title: Swagger +description: A list of redoc specifications for released versions of Flash Array, Flash Blade and Pure1. +--- +
FlashBlade
+{% include fb_select.html %} diff --git a/Pure1.html b/Pure1.html new file mode 100644 index 0000000..67c78dd --- /dev/null +++ b/Pure1.html @@ -0,0 +1,7 @@ +--- +layout: default +title: Swagger +description: A list of redoc specifications for released versions of Flash Array, Flash Blade and Pure1. +--- +
Pure1
+{% include pure1_select.html %} diff --git a/_includes/fa_links.html b/_includes/fa_links.html new file mode 100644 index 0000000..966b257 --- /dev/null +++ b/_includes/fa_links.html @@ -0,0 +1,41 @@ +FlashArray REST API (2.0) +FlashArray REST API (2.1) +FlashArray REST API (2.2) +FlashArray REST API (2.3) +FlashArray REST API (2.4) +FlashArray REST API (2.5) +FlashArray REST API (2.6) +FlashArray REST API (2.7) +FlashArray REST API (2.8) +FlashArray REST API (2.9) +FlashArray REST API (2.10) +FlashArray REST API (2.11) +FlashArray REST API (2.13) +FlashArray REST API (2.14) +FlashArray REST API (2.15) +FlashArray REST API (2.16) +FlashArray REST API (2.17) +FlashArray REST API (2.19) +FlashArray REST API (2.20) +FlashArray REST API (2.21) +FlashArray REST API (2.22) +FlashArray REST API (2.23) +FlashArray REST API (2.24) +FlashArray REST API (2.25) +FlashArray REST API (2.26) +FlashArray REST API (2.27) +FlashArray REST API (2.28) +FlashArray REST API (2.29) +FlashArray REST API (2.30) +FlashArray REST API (2.31) +FlashArray REST API (2.32) +FlashArray REST API (2.33) +FlashArray REST API (2.34) +FlashArray REST API (2.35) +FlashArray REST API (2.36) +FlashArray REST API (2.37) +FlashArray REST API (2.38) +FlashArray REST API (2.39) +FlashArray REST API (2.40) +FlashArray REST API (2.41) +FlashArray REST API (2.42) diff --git a/_includes/fa_select.html b/_includes/fa_select.html new file mode 100644 index 0000000..b7ac36b --- /dev/null +++ b/_includes/fa_select.html @@ -0,0 +1,43 @@ + diff --git a/_includes/fb_links.html b/_includes/fb_links.html new file mode 100644 index 0000000..b54d8a5 --- /dev/null +++ b/_includes/fb_links.html @@ -0,0 +1,18 @@ +FlashBlade REST API (2.0) +FlashBlade REST API (2.1) +FlashBlade REST API (2.2) +FlashBlade REST API (2.3) +FlashBlade REST API (2.4) +FlashBlade REST API (2.5) +FlashBlade REST API (2.6) +FlashBlade REST API (2.7) +FlashBlade REST API (2.8) +FlashBlade REST API (2.9) +FlashBlade REST API (2.10) +FlashBlade REST API (2.11) +FlashBlade REST API (2.12) +FlashBlade REST API (2.13) +FlashBlade REST API (2.14) +FlashBlade REST API (2.15) +FlashBlade REST API (2.16) +FlashBlade REST API (2.17) diff --git a/_includes/fb_select.html b/_includes/fb_select.html new file mode 100644 index 0000000..3092446 --- /dev/null +++ b/_includes/fb_select.html @@ -0,0 +1,20 @@ + diff --git a/_includes/files_fa.html b/_includes/files_fa.html new file mode 100644 index 0000000..7a1b6ff --- /dev/null +++ b/_includes/files_fa.html @@ -0,0 +1,41 @@ +fa2.0-api-reference.html +fa2.1-api-reference.html +fa2.2-api-reference.html +fa2.3-api-reference.html +fa2.4-api-reference.html +fa2.5-api-reference.html +fa2.6-api-reference.html +fa2.7-api-reference.html +fa2.8-api-reference.html +fa2.9-api-reference.html +fa2.10-api-reference.html +fa2.11-api-reference.html +fa2.13-api-reference.html +fa2.14-api-reference.html +fa2.15-api-reference.html +fa2.16-api-reference.html +fa2.17-api-reference.html +fa2.19-api-reference.html +fa2.20-api-reference.html +fa2.21-api-reference.html +fa2.22-api-reference.html +fa2.23-api-reference.html +fa2.24-api-reference.html +fa2.25-api-reference.html +fa2.26-api-reference.html +fa2.27-api-reference.html +fa2.28-api-reference.html +fa2.29-api-reference.html +fa2.30-api-reference.html +fa2.31-api-reference.html +fa2.32-api-reference.html +fa2.33-api-reference.html +fa2.34-api-reference.html +fa2.35-api-reference.html +fa2.36-api-reference.html +fa2.37-api-reference.html +fa2.38-api-reference.html +fa2.39-api-reference.html +fa2.40-api-reference.html +fa2.41-api-reference.html +fa2.42-api-reference.html diff --git a/_includes/files_fb.html b/_includes/files_fb.html new file mode 100644 index 0000000..a8e5c05 --- /dev/null +++ b/_includes/files_fb.html @@ -0,0 +1,18 @@ +fb2.0-api-reference.html +fb2.1-api-reference.html +fb2.2-api-reference.html +fb2.3-api-reference.html +fb2.4-api-reference.html +fb2.5-api-reference.html +fb2.6-api-reference.html +fb2.7-api-reference.html +fb2.8-api-reference.html +fb2.9-api-reference.html +fb2.10-api-reference.html +fb2.11-api-reference.html +fb2.12-api-reference.html +fb2.13-api-reference.html +fb2.14-api-reference.html +fb2.15-api-reference.html +fb2.16-api-reference.html +fb2.17-api-reference.html diff --git a/_includes/files_pure1.html b/_includes/files_pure1.html new file mode 100644 index 0000000..84427f9 --- /dev/null +++ b/_includes/files_pure1.html @@ -0,0 +1,6 @@ +pure1-1.0-api-reference.html +pure1-1.1-api-reference.html +pure1-1.2-api-reference.html +pure1-1.3-api-reference.html +pure1-1.4-api-reference.html +pure1-1.5-api-reference.html diff --git a/_includes/nav.html b/_includes/nav.html new file mode 100644 index 0000000..5722f8e --- /dev/null +++ b/_includes/nav.html @@ -0,0 +1,4 @@ +
  • All
    • +
  • FlashArray
    • +
  • FlashBlade
    • +
  • Pure1
    • diff --git a/_includes/pure1_links.html b/_includes/pure1_links.html new file mode 100644 index 0000000..8549e42 --- /dev/null +++ b/_includes/pure1_links.html @@ -0,0 +1,6 @@ +Pure1 REST API (1.0) +Pure1 REST API (1.1) +Pure1 REST API (1.2) +Pure1 REST API (1.3) +Pure1 REST API (1.4) +Pure1 REST API (1.5) diff --git a/_includes/pure1_select.html b/_includes/pure1_select.html new file mode 100644 index 0000000..7bec35e --- /dev/null +++ b/_includes/pure1_select.html @@ -0,0 +1,8 @@ + diff --git a/_includes/table_with_links.html b/_includes/table_with_links.html new file mode 100644 index 0000000..8eff310 --- /dev/null +++ b/_includes/table_with_links.html @@ -0,0 +1,154 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Flash ArrayFlash BladePure1
    FlashArray REST API (2.0)FlashBlade REST API (2.0)Pure1 REST API (1.0)
    FlashArray REST API (2.1)FlashBlade REST API (2.1)Pure1 REST API (1.1)
    FlashArray REST API (2.2)FlashBlade REST API (2.2)Pure1 REST API (1.2)
    FlashArray REST API (2.3)FlashBlade REST API (2.3)Pure1 REST API (1.3)
    FlashArray REST API (2.4)FlashBlade REST API (2.4)Pure1 REST API (1.4)
    FlashArray REST API (2.5)FlashBlade REST API (2.5)Pure1 REST API (1.5)
    FlashArray REST API (2.6)FlashBlade REST API (2.6)
    FlashArray REST API (2.7)FlashBlade REST API (2.7)
    FlashArray REST API (2.8)FlashBlade REST API (2.8)
    FlashArray REST API (2.9)FlashBlade REST API (2.9)
    FlashArray REST API (2.10)FlashBlade REST API (2.10)
    FlashArray REST API (2.11)FlashBlade REST API (2.11)
    FlashArray REST API (2.13)FlashBlade REST API (2.12)
    FlashArray REST API (2.14)FlashBlade REST API (2.13)
    FlashArray REST API (2.15)FlashBlade REST API (2.14)
    FlashArray REST API (2.16)FlashBlade REST API (2.15)
    FlashArray REST API (2.17)FlashBlade REST API (2.16)
    FlashArray REST API (2.19)FlashBlade REST API (2.17)
    FlashArray REST API (2.20)
    FlashArray REST API (2.21)
    FlashArray REST API (2.22)
    FlashArray REST API (2.23)
    FlashArray REST API (2.24)
    FlashArray REST API (2.25)
    FlashArray REST API (2.26)
    FlashArray REST API (2.27)
    FlashArray REST API (2.28)
    FlashArray REST API (2.29)
    FlashArray REST API (2.30)
    FlashArray REST API (2.31)
    FlashArray REST API (2.32)
    FlashArray REST API (2.33)
    FlashArray REST API (2.34)
    FlashArray REST API (2.35)
    FlashArray REST API (2.36)
    FlashArray REST API (2.37)
    FlashArray REST API (2.38)
    FlashArray REST API (2.39)
    FlashArray REST API (2.40)
    FlashArray REST API (2.41)
    FlashArray REST API (2.42)
    diff --git a/_layouts/default.html b/_layouts/default.html new file mode 100644 index 0000000..2710ed5 --- /dev/null +++ b/_layouts/default.html @@ -0,0 +1,56 @@ + + + + + + +{% seo %} + + + + + + + {% include head-custom.html %} + + + +
    +

    {{ page.title | default: site.title | default: site.github.repository_name }}

    +

    {{ page.description | default: site.description | default: site.github.project_tagline }}

    +
    + + + +
    + +
    + {{ content }} + +
    + +
    + + diff --git a/_templates/links.mustache b/_templates/links.mustache new file mode 100644 index 0000000..5205364 --- /dev/null +++ b/_templates/links.mustache @@ -0,0 +1,3 @@ +{{#links}} +{{ bu_pretty }} REST API ({{ version }}) +{{/links}} diff --git a/_templates/select.mustache b/_templates/select.mustache new file mode 100644 index 0000000..460d38e --- /dev/null +++ b/_templates/select.mustache @@ -0,0 +1,5 @@ + diff --git a/_templates/table.mustache b/_templates/table.mustache new file mode 100644 index 0000000..b329b53 --- /dev/null +++ b/_templates/table.mustache @@ -0,0 +1,14 @@ + + + + + + +{{# lines }} + + {{# rows }} + + {{/rows}} + +{{/lines}} +
    Flash ArrayFlash BladePure1
    {{ bu_pretty }} REST API ({{ version }})
    diff --git a/assets/css/style.scss b/assets/css/style.scss new file mode 100644 index 0000000..2912dac --- /dev/null +++ b/assets/css/style.scss @@ -0,0 +1,5 @@ +--- +--- + +@import "{{ site.theme }}"; +.h1 {font-size: 2EM; font-weight: bold; margin-bottom: 1EM;} diff --git a/index.html b/index.html new file mode 100644 index 0000000..95c6e41 --- /dev/null +++ b/index.html @@ -0,0 +1,9 @@ +--- +layout: default +title: Swagger +description: A list of redoc specifications for released versions of Flash Array, Flash Blade and Pure1. +nav.content: nav.html +--- +
    All
    +{% include table_with_links.html %} + diff --git a/scripts/apply_templates.py b/scripts/apply_templates.py new file mode 100755 index 0000000..4b5e119 --- /dev/null +++ b/scripts/apply_templates.py @@ -0,0 +1,94 @@ +import chevron +import os +import re +from functools import total_ordering + + +@total_ordering +class Version: + def __init__(self, bu, version, filename): + self.bu = bu + self.version = version + self.filename = filename + self.bu_pretty = self.get_pretty_bu(bu) + + def get_pretty_bu(self, bu): + if (bu == 'fa'): + return 'FlashArray' + elif (bu == 'fb'): + return 'FlashBlade' + else: + return 'Pure1' + + def __eq__(self, other): + return self.version == other.version + + def __lt__(self, other): + this = self.version.split('.') + that = other.version.split('.') + if this[0] == that[0]: + # Same major version + return True if int(this[1]) < int(that[1]) else False + else: + return True if int(this[0]) < int(that[0]) else False + +def parse_versions(bu): + SPECS_DIR = './redoc' + specs_found = [] + spec_regex = re.compile(f'{bu}[-]?(?P.*)-api-reference.html') + for spec in os.listdir(SPECS_DIR): + match = spec_regex.match(spec) + if match: + specs_found.append(Version(bu, match.groupdict()['version'], spec)) + return sorted(specs_found) + +def generate(template_path, output_path, data): + with open(template_path) as template: + with open(output_path, 'w') as output: + output.write(chevron.render(template, data)) + +class VersionTriplets: + def __init__(self, fa, fb, pure1): + self.lines = [] + for i in range(0, len(fa)): + rows = [] + rows.append(fa[i]) + if len(fb) > i: + rows.append(fb[i]) + if len(pure1) > i: + rows.append(pure1[i]) + self.lines.append({'rows': rows}) + +if __name__ == '__main__': + fa = parse_versions('fa') + fb = parse_versions('fb') + pure1 = parse_versions('pure1') + + # Generate content for BU-specific pages + def generate_for_bu(bu, versions): + for file_type in ['links', 'select']: + template_path = os.path.join('_templates', f'{file_type}.mustache') + output_path = os.path.join('_includes', f'{bu}_{file_type}.html') + generate(template_path, output_path, {'links': versions}) + generate_for_bu('fa', fa) + generate_for_bu('fb', fb) + generate_for_bu('pure1', pure1) + + # Generate the joint table for index.html + version_triplets = VersionTriplets(fa, fb, pure1) + template_path = os.path.join('_templates', 'table.mustache') + output_path = os.path.join('_includes', 'table_with_links.html') + generate(template_path, output_path, {'lines': version_triplets.lines}) + + + + + + + + + + + + + diff --git a/scripts/requirements_apply_templates.txt b/scripts/requirements_apply_templates.txt new file mode 100644 index 0000000..647f4de --- /dev/null +++ b/scripts/requirements_apply_templates.txt @@ -0,0 +1 @@ +chevron == 0.14.0 From c31adab9834e110bfdbcd68264176da53336e001 Mon Sep 17 00:00:00 2001 From: Jakub Tischler Date: Thu, 22 May 2025 11:23:06 +0200 Subject: [PATCH 2/4] prune files that are no longer generate --- _includes/files_fa.html | 41 -------------------------------------- _includes/files_fb.html | 18 ----------------- _includes/files_pure1.html | 6 ------ _templates/links.mustache | 3 --- _templates/select.mustache | 5 ----- _templates/table.mustache | 14 ------------- 6 files changed, 87 deletions(-) delete mode 100644 _includes/files_fa.html delete mode 100644 _includes/files_fb.html delete mode 100644 _includes/files_pure1.html delete mode 100644 _templates/links.mustache delete mode 100644 _templates/select.mustache delete mode 100644 _templates/table.mustache diff --git a/_includes/files_fa.html b/_includes/files_fa.html deleted file mode 100644 index 7a1b6ff..0000000 --- a/_includes/files_fa.html +++ /dev/null @@ -1,41 +0,0 @@ -fa2.0-api-reference.html -fa2.1-api-reference.html -fa2.2-api-reference.html -fa2.3-api-reference.html -fa2.4-api-reference.html -fa2.5-api-reference.html -fa2.6-api-reference.html -fa2.7-api-reference.html -fa2.8-api-reference.html -fa2.9-api-reference.html -fa2.10-api-reference.html -fa2.11-api-reference.html -fa2.13-api-reference.html -fa2.14-api-reference.html -fa2.15-api-reference.html -fa2.16-api-reference.html -fa2.17-api-reference.html -fa2.19-api-reference.html -fa2.20-api-reference.html -fa2.21-api-reference.html -fa2.22-api-reference.html -fa2.23-api-reference.html -fa2.24-api-reference.html -fa2.25-api-reference.html -fa2.26-api-reference.html -fa2.27-api-reference.html -fa2.28-api-reference.html -fa2.29-api-reference.html -fa2.30-api-reference.html -fa2.31-api-reference.html -fa2.32-api-reference.html -fa2.33-api-reference.html -fa2.34-api-reference.html -fa2.35-api-reference.html -fa2.36-api-reference.html -fa2.37-api-reference.html -fa2.38-api-reference.html -fa2.39-api-reference.html -fa2.40-api-reference.html -fa2.41-api-reference.html -fa2.42-api-reference.html diff --git a/_includes/files_fb.html b/_includes/files_fb.html deleted file mode 100644 index a8e5c05..0000000 --- a/_includes/files_fb.html +++ /dev/null @@ -1,18 +0,0 @@ -fb2.0-api-reference.html -fb2.1-api-reference.html -fb2.2-api-reference.html -fb2.3-api-reference.html -fb2.4-api-reference.html -fb2.5-api-reference.html -fb2.6-api-reference.html -fb2.7-api-reference.html -fb2.8-api-reference.html -fb2.9-api-reference.html -fb2.10-api-reference.html -fb2.11-api-reference.html -fb2.12-api-reference.html -fb2.13-api-reference.html -fb2.14-api-reference.html -fb2.15-api-reference.html -fb2.16-api-reference.html -fb2.17-api-reference.html diff --git a/_includes/files_pure1.html b/_includes/files_pure1.html deleted file mode 100644 index 84427f9..0000000 --- a/_includes/files_pure1.html +++ /dev/null @@ -1,6 +0,0 @@ -pure1-1.0-api-reference.html -pure1-1.1-api-reference.html -pure1-1.2-api-reference.html -pure1-1.3-api-reference.html -pure1-1.4-api-reference.html -pure1-1.5-api-reference.html diff --git a/_templates/links.mustache b/_templates/links.mustache deleted file mode 100644 index 5205364..0000000 --- a/_templates/links.mustache +++ /dev/null @@ -1,3 +0,0 @@ -{{#links}} -{{ bu_pretty }} REST API ({{ version }}) -{{/links}} diff --git a/_templates/select.mustache b/_templates/select.mustache deleted file mode 100644 index 460d38e..0000000 --- a/_templates/select.mustache +++ /dev/null @@ -1,5 +0,0 @@ - diff --git a/_templates/table.mustache b/_templates/table.mustache deleted file mode 100644 index b329b53..0000000 --- a/_templates/table.mustache +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - -{{# lines }} - - {{# rows }} - - {{/rows}} - -{{/lines}} -
    Flash ArrayFlash BladePure1
    {{ bu_pretty }} REST API ({{ version }})
    From e8e213e4586a7486f7e5261c867c6c21336ef836 Mon Sep 17 00:00:00 2001 From: Jakub Tischler Date: Thu, 22 May 2025 11:29:48 +0200 Subject: [PATCH 3/4] removing scripts --- scripts/apply_templates.py | 94 ------------------------ scripts/requirements_apply_templates.txt | 1 - 2 files changed, 95 deletions(-) delete mode 100755 scripts/apply_templates.py delete mode 100644 scripts/requirements_apply_templates.txt diff --git a/scripts/apply_templates.py b/scripts/apply_templates.py deleted file mode 100755 index 4b5e119..0000000 --- a/scripts/apply_templates.py +++ /dev/null @@ -1,94 +0,0 @@ -import chevron -import os -import re -from functools import total_ordering - - -@total_ordering -class Version: - def __init__(self, bu, version, filename): - self.bu = bu - self.version = version - self.filename = filename - self.bu_pretty = self.get_pretty_bu(bu) - - def get_pretty_bu(self, bu): - if (bu == 'fa'): - return 'FlashArray' - elif (bu == 'fb'): - return 'FlashBlade' - else: - return 'Pure1' - - def __eq__(self, other): - return self.version == other.version - - def __lt__(self, other): - this = self.version.split('.') - that = other.version.split('.') - if this[0] == that[0]: - # Same major version - return True if int(this[1]) < int(that[1]) else False - else: - return True if int(this[0]) < int(that[0]) else False - -def parse_versions(bu): - SPECS_DIR = './redoc' - specs_found = [] - spec_regex = re.compile(f'{bu}[-]?(?P.*)-api-reference.html') - for spec in os.listdir(SPECS_DIR): - match = spec_regex.match(spec) - if match: - specs_found.append(Version(bu, match.groupdict()['version'], spec)) - return sorted(specs_found) - -def generate(template_path, output_path, data): - with open(template_path) as template: - with open(output_path, 'w') as output: - output.write(chevron.render(template, data)) - -class VersionTriplets: - def __init__(self, fa, fb, pure1): - self.lines = [] - for i in range(0, len(fa)): - rows = [] - rows.append(fa[i]) - if len(fb) > i: - rows.append(fb[i]) - if len(pure1) > i: - rows.append(pure1[i]) - self.lines.append({'rows': rows}) - -if __name__ == '__main__': - fa = parse_versions('fa') - fb = parse_versions('fb') - pure1 = parse_versions('pure1') - - # Generate content for BU-specific pages - def generate_for_bu(bu, versions): - for file_type in ['links', 'select']: - template_path = os.path.join('_templates', f'{file_type}.mustache') - output_path = os.path.join('_includes', f'{bu}_{file_type}.html') - generate(template_path, output_path, {'links': versions}) - generate_for_bu('fa', fa) - generate_for_bu('fb', fb) - generate_for_bu('pure1', pure1) - - # Generate the joint table for index.html - version_triplets = VersionTriplets(fa, fb, pure1) - template_path = os.path.join('_templates', 'table.mustache') - output_path = os.path.join('_includes', 'table_with_links.html') - generate(template_path, output_path, {'lines': version_triplets.lines}) - - - - - - - - - - - - - diff --git a/scripts/requirements_apply_templates.txt b/scripts/requirements_apply_templates.txt deleted file mode 100644 index 647f4de..0000000 --- a/scripts/requirements_apply_templates.txt +++ /dev/null @@ -1 +0,0 @@ -chevron == 0.14.0 From 0fcf18b12bbf5f08bce63e835219218b9e8131b1 Mon Sep 17 00:00:00 2001 From: fa-ui-bot Date: Thu, 22 May 2025 13:43:59 +0000 Subject: [PATCH 4/4] Adding FA2.42 --- redoc/FA2.42-api-reference.html | 20308 ++++++++++++++++++++++++++++++ 1 file changed, 20308 insertions(+) create mode 100644 redoc/FA2.42-api-reference.html diff --git a/redoc/FA2.42-api-reference.html b/redoc/FA2.42-api-reference.html new file mode 100644 index 0000000..a3f8956 --- /dev/null +++ b/redoc/FA2.42-api-reference.html @@ -0,0 +1,20308 @@ + + + + + + FlashArray API 2.42 Reference + + + + + + + + + + +
    Documentation Powered by ReDoc

    FlashArray REST API (2.42)

    Download OpenAPI specification:Download

    Authorization

    Pure Storage uses the OAuth 2.0 Token Exchange authorization grant and JSON Web Tokens (JWTs) +to authenticate to the Pure Storage REST API. +Before you can exchange the ID token for an access token, create and enable the API client +to generate the key_id, id, and issuer values. +These values will be used as JWT claims for the subject_token parameter.

    +

    Get access token

    Exchanges an ID Token for an OAuth 2.0 access token.

    +
    header Parameters
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/x-www-form-urlencoded
    grant_type
    required
    string (OauthGrantType)
    Default: "urn:ietf:params:oauth:grant-type:token-exchange"

    The method by which the access token will be obtained. +The Pure Storage REST API supports the OAuth 2.0 "token exchange" grant type, +which indicates that a token exchange is being performed. +Set grant_type to urn:ietf:params:oauth:grant-type:token-exchange.

    +
    subject_token
    required
    string (OauthSubjectToken)

    An encoded security ID Token representing the identity of the party on behalf of +whom the request is being made. The token must be issued by a trusted +identity provider which must be either a registered application in Pure1 +or an enabled API client on the array. The token must be a JSON Web Token +and must contain the following claims:

    +
    +

    | JWT claim | Location | API Client Field | Description | Required By |

    +
    +
    +

    |-|-|-|-|-|

    +
    +
    +

    | kid | Header | key_id | Key ID of the API client that issues the identity token. | FlashArray +and FlashBlade only. |

    +
    +
    +

    | aud | Payload | id | Client ID of the API client that issues the identity token. | FlashArray +and FlashBlade only. |

    +
    +
    +

    | sub | Payload | | Login name of the array user for whom the token should be issued. +This must be a valid user in the system. | FlashArray and FlashBlade only. |

    +
    +
    +

    | iss | Payload | issuer | Application ID for the Pure1 or API client's trusted identity +issuer on the array. | All products. |

    +
    +
    +

    | iat | Payload | | Timestamp of when the identity token was issued. +Measured in milliseconds since the UNIX epoch. | All products. |

    +
    +
    +

    | exp | Payload | | Timestamp of when the identity token will expire. +Measured in milliseconds since the UNIX epoch. | All products. |

    +
    +

    Each token must also be signed with the private key that is paired with the +API client's public key.

    +
    subject_token_type
    required
    string (OauthSubjectTokenType)
    Default: "urn:ietf:params:oauth:token-type:jwt"

    An identifier that indicates the type of security token specifed in the subject_token parameter. +The Pure Storage REST API supports the JSON Web Token (JWT) +as the means for requesting the access token. +Set subject_token_type to urn:ietf:params:oauth:token-type:jwt.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "access_token": "eyJraWQiOiJqTlBzL1Ria2c4U2Vua3F3ZmkvbnI4bWxxQ3NPIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhdWQiOiI5NDcyMTkwOC1mNzkyLTcxMmUtYTYzOS0wODM5ZmE4MzA5MjIiLCJzdWIiOiJqb2UiLCJyb2xlIjoic3RvcmFnZV9hZG1pbiIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6OTAwMCIsImlhdCI6MTU0NDAzNjA1MiwiZXhwIjoxNTQ0MDcyMDUyLCJqdGkiOiJjOTg0MjgyNS1mNGM3LTRiNGUtODdkNy03OWFiZmIxYTUzNDgifQ.pnuYAx0CkmkIG0LDrMAQGRr5Ci4-t5yMto3A7BkmyKnAVHBXG5ZIWwvNkWDLhqbA4YjmG7LZmWHrCVehLy2zy2vRLahFURsd3GTnOaWSyWFIyrwpoO81jQRtOQATtseweuMT_-C8o3oa4MgBNBsuKrhwKQS3oDDpeRPaCRTGev1_xRDxh_K6CWJBTAeOP2pcR4LW6zIJkCLzzkMuyL4aTJWWUjSbl04mcFbyw8r8W1GURrmaDVOvvpT634Hk9-GGh9OMIRlS6OOq7cJKc-RRWn18IK2Gs53V_KYshXTBbnRr990Y_qOX8MaTWOJTqgzsojY02MSVuJ9XDJWoIU3TQytr4K1vM2EvwDZDgl7LuUYUn7vWhbKktFzpeZyyhOjq3eX-ViugYKpIjBcG2f_-fcTPceEWGV82rd6TyVNB5A-v9u2kxCdW198t_kesgVQfuupDeS02cZe0ABLCzEHPiVF17JfiVr6sjkciioxN7Wj_j18ga4U0mdSukauT8yhbgCW1ijTVTFu1VwWebW0s8z3BWMtXdTtZ3BhcZVAdKRF8bOq7nfEbUQGhTn9g7dK-yF050winjtp-VTL2oUtkF5j1v_N8vPNiN9ZdkGJZr7VVZ-qeOJZcjdaRbxL6YB__yT1wkTcKPh8RHz6GUq7Jbyw8VIlcBE2nvJ63d0tH9C4",
    • "expires_in": 35999,
    • "issued_token_type": "urn:ietf:params:oauth:token-type:access_token",
    • "token_type": "Bearer"
    }

    List available API versions

    Returns a list of available API versions. No authentication is required to access this endpoint.

    +
    header Parameters
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "version": [
      ]
    }

    POST login (placeholder)

    Exchange an API token for a session token.

    +
    header Parameters
    api-token
    string
    Example: 0f2e2884-9486-c6c2-438c-f50418f2aac3

    API token for a user.

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    POST logout (placeholder)

    Invalidate a session token.

    +
    header Parameters
    x-auth-token
    string
    Example: 3be3d489-55c6-4643-90ac-a476dbc98812

    Session token for a user.

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Active Directory

    Active Directory configuration authenticates users for NFS using Kerberos or SMB using Kerberos +or New Technology LAN Manager (NTLM). Active Directory is also used to authorize users by +mapping identities across the NFS and SMB protocols by using LDAP queries.

    +

    List Active Directory accounts

    Displays configured Active Directory accounts.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create Active Directory account

    Creates one or more Active Directory accounts. +The user and password provided are used +to join the array to the specified domain.

    +
    query Parameters
    join_existing_account
    boolean

    If specified as true, the domain is searched for a pre-existing computer account to join to, +and no new account will be created within the domain. +The user specified when joining a pre-existing account must have permissions to +'read all properties from' and 'reset the password of' the pre-existing account. +join_ou will be read from the pre-existing account and cannot be specified +when joining to an existing account. If not specified, defaults to false.

    +
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    computer_name
    string

    The name of the computer account to be created in the Active Directory +domain. +If not specified, defaults to the name of the Active Directory +configuration.

    +
    directory_servers
    Array of strings

    A list of directory servers used for lookups related to user authorization. +Servers must be specified in FQDN format. +All specified servers must be registered to the domain appropriately in the configured DNS +of the array and are only communicated with over the secure LDAP (LDAPS) protocol. +If not specified, servers are resolved for the domain in DNS.

    +
    domain
    string

    The Active Directory domain to join.

    +
    join_ou
    string

    The distinguished name of the organizational unit in which the +computer account should be created when joining the domain. +The DC=... components of the distinguished name can be optionally omitted. +If not specified, defaults to CN=Computers.

    +
    kerberos_servers
    Array of strings

    A list of key distribution servers to use for Kerberos protocol. +Servers must be specified in FQDN format. +All specified servers must be registered to the domain appropriately in the configured DNS +of the array. +If not specified, servers are resolved for the domain in DNS.

    +
    password
    string

    The login password of the user with privileges to create the computer account +in the domain. +This is not persisted on the array.

    +
    tls
    string

    TLS mode for communication with domain controllers. +Valid values are required and optional. +required forces TLS communication with a domain controller. +optional allows the use of non-TLS communication, +TLS will still be preferred, if available. +If not specified, defaults to required.

    +
    user
    string

    The login name of the user with privileges to create the computer account in +the domain. +This is not persisted on the array.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "computer_name": "FLASHARRAY01",
    • "directory_servers": [
      ],
    • "domain": "my-corporation.com",
    • "join_ou": "OU=Dev,OU=Sweden,DC=purestorage,DC=com",
    • "kerberos_servers": [
      ],
    • "password": "password",
    • "tls": "required",
    • "user": "Administrator"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete Active Directory account

    Deletes one or more specified Active Directory accounts.

    +
    query Parameters
    local_only
    boolean

    If specified as true, only delete the Active Directory +configuration on the local array, without deleting the +computer account created in the Active Directory domain. +If not specified, defaults to false.

    +
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify Active Directory account

    Modifies specified Active Directory account.

    +
    query Parameters
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    tls
    string

    TLS mode for communication with domain controllers. +Valid values are required and optional. +required forces TLS communication with domain controller. +optional allows the use of non-TLS communication, +TLS will still be preferred, if available. +If not specified, defaults to required.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "tls": "required"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Administrators

    The FlashArray has a single default administrative account named pureuser. The administrator can +add, delete, and modify administrators on the array. Administrators are assigned management +access policies to give different levels of permissions.

    +

    List administrators

    Displays a list of administrators.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    expose_api_token
    boolean

    If true, exposes the API token of the current user.

    +
    expose_public_key
    boolean

    If true, exposes the public key of the current user.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create an administrator

    Creates an administrator.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_referenceWithType)

    List of management access policies to associate with the administrator. +Policies can be specified by the name or ID parameter, but they cannot be set together.

    +
    password
    string

    Password associated with the account.

    +
    object (_adminRole)

    This field has been deprecated. Predecessor to management access policies.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "management_access_policies": [
      ],
    • "password": "string",
    • "role": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete an administrator

    Deletes the specified administrator.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify an administrator

    Modifies properties for the specified administrator.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (_apiToken)

    API token

    +
    locked
    boolean

    Returns a value of true if the user is currently locked out. otherwise false. +Change to false to unlock a user. This field is only visible to array_admin roles. +For all other users, the value is always null.

    +
    password
    string

    Password associated with the account.

    +
    public_key
    string

    Public key for SSH access. +Multiple public keys can be specified, separated by newlines.

    +
    object (_adminRole)

    This field has been deprecated. Predecessor to management access policies.

    +
    old_password
    string

    The current password.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "api_token": { },
    • "locked": false,
    • "password": "string",
    • "public_key": "string",
    • "role": {
      },
    • "old_password": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List management access policies attached to administrators

    Displays a list of management access policies that are attached to administrators.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a membership between an administrator with one or more management access policies.

    Creates a membership between an administrator with one or more management access policies. +One of member_ids or member_names parameter is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (PolicyAssignmentPostPolicy)

    A list of policies to apply to the resource. +One of id or name is required in each policy.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "policies": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a membership between an administrator and one or more management access policies

    Deletes a membership between an administrator with one or more management access policies. +One of policy_ids or policy_names is required, and one of member_ids or member_names +is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List API tokens

    Displays API tokens for the specified administrators.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    expose_api_token
    boolean

    If true, exposes the API token of the current user.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create API tokens

    Creates API tokens for the specified administrators.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    timeout
    integer <int64>

    The duration of API token validity, in milliseconds.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete API tokens

    Deletes the API tokens of the specified administrators.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List administrator cache entries

    Displays entries in the administrator cache.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Update or refresh entries in the administrator cache

    Updates entries in the cache for administrators who currently do not have a cache entry, +otherwise refreshes the existing entry.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete cache entries

    Deletes all entries from the administrator cache.

    +
    query Parameters
    remove_all_entries
    required
    boolean

    If set to true, removes all entries from the administrator cache.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List administrator settings

    Displays the global administrator settings for the array.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ],
    • "more_items_remaining": false,
    • "total_item_count": 0
    }

    Modify administrator settings

    Modifies the global administrator settings for the array.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    lockout_duration
    integer <int64> [ 1000 .. 7776000000 ]

    The lockout duration, in milliseconds, if a user is locked out after reaching the maximum +number of login attempts. Ranges from 1 second to 90 days.

    +
    max_login_attempts
    integer <int32> [ 1 .. 20 ]

    Maximum number of failed login attempts allowed before the user is locked out.

    +
    min_password_length
    integer <int32>

    Minimum password length. If not specified, defaults to 1.

    +
    object (_adminSettingsRequiredAuthenticationMethods)

    Authentication methods that are required for the array on specific user +interfaces.

    +
    single_sign_on_enabled
    boolean

    If true, then single sign-on is enabled for the array.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "lockout_duration": 3600000,
    • "max_login_attempts": 10,
    • "min_password_length": 1,
    • "required_authentication_methods": {
      },
    • "single_sign_on_enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Alerts

    Alerts indicate significant events that occur on an array, including whenever a component +degrades or the capacity threshold of the component is reached.

    +

    List alerts

    Displays a list of alerts.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    flagged
    boolean

    If set to true, lists only flagged messages. +If set to false, lists only unflagged messages. +if not specified, lists all messages.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Modify flagged state

    Modifies one or more alerts and display updated information about these alerts.

    +
    query Parameters
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    flagged
    boolean

    If set to true, the message is flagged. +Important messages can can be flagged and listed separately.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "flagged": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List alert events

    Displays a list of alert events.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    flagged
    boolean

    If set to true, lists only flagged messages. +If set to false, lists only unflagged messages. +if not specified, lists all messages.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    List custom alert rules

    Displays a list of custom alert rules.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    code
    integer <int32>

    The alert code to display.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a custom alert rule

    Creates an alert rule with a custom value.

    +
    query Parameters
    code
    required
    integer <int32>

    The alert code that the rule applies to. Available alert codes +for customization can be found in the alert rules catalog.

    +
    parameter
    required
    string

    The parameter of the custom alert rule to modify. Values include info and warning. +Available parameter values can be found in the alert rules catalog.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    value
    string

    The value to use for the custom alert rule. Valid values for +an alert code and parameter combination can be found in the alert rules catalog.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "value": "85"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a custom alert rule

    Deletes a custom alert rule.

    +
    query Parameters
    code
    required
    integer <int32>

    The alert code that the rule applies to. Available alert codes +for customization can be found in the alert rules catalog.

    +
    parameter
    required
    string

    The parameter of the custom alert rule to modify. Values include info and warning. +Available parameter values can be found in the alert rules catalog.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a custom alert rule

    Modifies a custom alert rule to a new value.

    +
    query Parameters
    code
    required
    integer <int32>

    The alert code that the rule applies to. Available alert codes +for customization can be found in the alert rules catalog.

    +
    parameter
    required
    string

    The parameter of the custom alert rule to modify. Values include info and warning. +Available parameter values can be found in the alert rules catalog.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    value
    string

    The value to use for the custom alert rule. Valid values for +an alert code and parameter combination can be found in the alert rules catalog.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "value": "85"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List available customizable alert codes

    Displays a list of available customizable alert codes.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    code
    integer <int32>

    The alert code to display.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Alert Watchers

    Alert watchers receive email notifications when alerts occur on an array.

    +

    List alert watchers

    Displays alert watcher email addressess and indicates whether they are enabled.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create alert watcher

    Creates one or more alert watcher email addresses, adding them to the list of alert watchers.

    +
    query Parameters
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    enabled
    boolean

    If set to true, email notifications will be sent to this watcher for alerts. +If set to false, email notifications are disabled. +If not specified, defaults to true.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete alert watcher

    Delete alert watcher email address from the list of alert watchers.

    +
    query Parameters
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify alert watcher

    Modify alert watcher email address by enabling or disabling it.

    +
    query Parameters
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    enabled
    boolean

    If set to true, email notifications will be sent to this watcher for alerts. +If set to false, email notifications are disabled.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List alert watcher test

    Displays alert watcher email test results.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ]
    }

    API Clients

    An API client represents an identity type. API clients are created on the array. +To create an API client, register and then enable it on the array. +After the API client has been created, the user name (sub) and identity tokens (kid and +aud tokens) that are issued by the API client are used as claims for the JSON Web Token +that you create to authenticate into the REST API.

    +

    List API clients

    Displays a list of API clients.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create an API client

    Creates an API client. Newly created API clients are disabled by default. +Enable an API client through the PATCH method. +The names, issuer, and public_key parameters are required. +The access_policies or max_role parameter is required, but they cannot be set together.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_referenceWithType)

    The access policies allowed for ID Tokens issued by this API client. +The bearer of an access token will be authorized to perform actions +within the intersection of these policies and those of the array +user specified as the JWT sub (subject) claim.

    +
    access_token_ttl_in_ms
    integer <int64>

    The TTL (Time To Live) length of time for the exchanged access token. +Measured in milliseconds. If not specified, defaults to 86400000.

    +
    issuer
    string

    The name of the identity provider that will be issuing ID Tokens for this API client. +The iss claim in the JWT issued must match this string. +If not specified, defaults to the API client name.

    +
    max_role
    string

    Deprecated. The maximum Admin Access Policy (previously 'role') allowed for ID +Tokens issued by this API client. The bearer of an access token will be +authorized to perform actions within the intersection of this policy and +that of the array user specified as the JWT sub (subject) claim. +max_role is deprecated in favor of access_policies, but remains for backwards +compatibility. If max_role is the name of a valid legacy role, it will be +interpreted as the corresponding access policy of the same name. +Otherwise, it's invalid.

    +
    public_key
    string

    The API client's PEM formatted (Base64 encoded) RSA public key. +Include the -----BEGIN PUBLIC KEY----- and -----END PUBLIC KEY----- lines.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "access_policies": [
      ],
    • "access_token_ttl_in_ms": 15000,
    • "issuer": "https://purestorage.idp.okta.com",
    • "max_role": "storage_admin",
    • "public_key": "-----BEGIN PUBLIC KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0\neKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR\ngJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O\nnLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum\n2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q\nsNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr\n1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1\n64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R\n1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6\nSEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+\nD6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd\nFVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ==\n-----END PUBLIC KEY-----\n"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete an API client

    Deletes an API client. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Manage an API client

    Enables or disables an API client. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    enabled
    boolean

    Returns a value of true if the API client is permitted to exchange ID +tokens for access tokens. +API clients are disabled by default.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Apps

    Apps that extend array functionality can be integrated into the Purity//FA operating system.

    +

    List apps

    Displays a list of installed apps.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Modify app

    Modifies an installed app or modifies Virtual Network Computing (VNC) access for apps that are +being patched.

    +
    query Parameters
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    enabled
    boolean

    If set to true, the app is enabled. By default, apps are disabled.

    +
    vnc_enabled
    boolean

    If set to true, VNC access is enabled. By default, VNC access is disabled.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "enabled": true,
    • "vnc_enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List app nodes

    Displays a list of installed apps and their nodes.

    +
    query Parameters
    app_names
    Array of strings

    The name of the installed app. +Enter multiple names in comma-separated format.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Arrays

    Array features provide the ability to configure settings that affect the operation +of the array as a whole and monitor array I/O performance.

    +

    List arrays

    Displays general array properties including the array name, login banner, +idle timeout for management sessions, and NTP servers.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Delete an array

    Deletes an array. For physical appliances, deleting an array restores the hardware to factory +settings. This entails deleting all data, metadata, configuration, and logs. The array returns +to the state it was in prior to any configuration changes being made. If the hardware is reused, +it must be as a different array with a new ID. +For virtual appliances, deleting an array puts it into an unusable state. +Virtual resources (e.g., virtual machines) can later be freed, which deletes any remaining data, +metadata, configuration, and logs. Prior to factory reset, an array must be manually prepared +(e.g., all volumes and snapshots must be eradicated) and a factory reset token must be created.

    +
    query Parameters
    eradicate_all_data
    boolean

    Set to true to perform a factory reset.

    +
    factory_reset_token
    integer <int64>

    A token required to perform a factory reset.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify an array

    Modifies general array properties such as the array name, login banner, idle timeout for +management sessions, and NTP servers.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    A user-specified name. +The name must be locally unique and can be changed.

    +
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    banner
    string
    console_lock_enabled
    boolean

    If true, console lock is enabled for the array. +If the user does not have sufficient access, this field will return null.

    +
    object (ArrayEncryption)

    If the user does not have sufficient access, all fields will return null.

    +
    object (Eradication_config)

    The configuration of eradication feature.

    +
    idle_timeout
    integer <int32>

    The idle timeout in milliseconds. Valid values include 0 and any multiple of 60000 in +the range of 300000 and 10800000. Any other values are rounded down to the nearest +multiple of 60000.

    +
    ntp_servers
    Array of strings

    NTP Servers. +If the user does not have sufficient access, this field will return null.

    +
    ntp_symmetric_key
    string

    The text of ntp symmetric authentication key. Supported formats include a hex-encoded +string no longer than 64 characters, or an ASCII string no longer than 20 characters, +excluding "#". Any configured key will be masked as "****" on return. +If the user does not have sufficient access, this field will return null.

    +
    scsi_timeout
    integer <int32>

    The SCSI timeout. If not specified, defaults to 60s. +If the user does not have sufficient access, this field will return null.

    +
    object (Space)

    If the user does not have sufficient access, all fields will return null.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "context": { },
    • "banner": "Restricted area. Authorized personnel only.",
    • "console_lock_enabled": false,
    • "encryption": {
      },
    • "eradication_config": {
      },
    • "idle_timeout": 300000,
    • "ntp_servers": [
      ],
    • "ntp_symmetric_key": "string",
    • "scsi_timeout": 60000,
    • "space": { }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List CBS array configuration status

    Displays the configuration status of the CBS array, including the progress of the +configuration upgrade. Requests for non-CBS arrays will receive an error response.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Modify CBS array configuration

    Modifies the configuration of the CBS array. This should trigger a backend +process that will upgrade the CBS array configuration. The array can be +upgraded only to models defined by the supported configurations endpoint. When an +existing array upgrade request is in progress, any new request to upgrade +the array will receive an error response. For non-CBS arrays, this +feature is not supported and requests will receive an error response.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    The requested configuration of the CBS array hardware.

    +
    object (CloudConfigModelPatch)

    The requested model configuration of the CBS array.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "model": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List CBS array supported upgrade target configs

    Displays the list of supported configurations to which the CBS array can be upgraded. +Requests for non-CBS arrays will receive an error response.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    List CBS array capacity status

    Displays the capacity status of the CBS array including the progress of the +capacity update. Requests for non-CBS arrays will receive an error response.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Modify CBS array capacity

    Modifies the raw capacity of the CBS array. This should trigger a backend +process that will update the CBS array capacity. The array capacity can be +updated only to values defined by the capacity steps endpoint. +When an existing capacity update request is in progress, any new request to update +of the capacity will receive an error response. +For non-CBS arrays, this feature is not supported and requests will receive an error response.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    The requested capacity of the CBS array.

    +
    requested_capacity
    integer <int64>

    The requested raw capacity of the CBS array in bytes. When the capacity +update process finishes, it should be the same as current_capacity.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "requested_capacity": 10995116277760
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List CBS array capacity steps

    Displays the list of supported raw capacity sizes in bytes the CBS array can be +upgraded to. Requests for non-CBS arrays will receive an error response.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    List user tags on the cloud.

    Displays the list of user tags on deployed cloud resources of a CBS array.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Delete user tags from the cloud.

    Deletes user tags from deployed cloud resources of a CBS array.

    +
    query Parameters
    keys
    Array of strings

    A comma-separated list of tag keys.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Update user tags on the cloud.

    Updates users tags to deployed cloud resources of a CBS array.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    A list of tags to be created or, if already existing, updated.

    +
    Array ()
    key
    string

    Key of the tag. Supports UTF-8 Unicode characters. +Please refer to the offical document from cloud providers for limitations.

    +
    value
    string

    Value of the tag. Supports UTF-8 Unicode characters. +Please refer to the offical document from cloud providers for limitations.

    +

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List factory reset details

    Displays a list of factory reset processes.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create a process for factory reset

    Creates the initiation of the factory reset process

    +
    query Parameters
    eradicate_all_data
    required
    boolean

    Set to true to perform a factory reset.

    +
    preserve_configuration_data
    required
    Array of strings

    A comma-separated list of configuration data types to preserve. +A value of all will preserve all configuration +data types. Valid values include all.

    +
    skip_phonehome_check
    boolean

    A flag to skip phonehome connectivity check. If skip_phonehome_check is not set, +the factory reset will fail if phonehome connectivity check fails. +Arrays that intentionally disable phonehome or do not permit connectivity +to Pure Storage's cloud servers must set this flag to true in order to start factory reset.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete factory reset

    Deletes the factory reset process when it is failed.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Update factory reset

    Modifies the factory reset process to finalize.

    +
    query Parameters
    delete_sanitization_certificate
    required
    boolean

    Set to true to finalize factory reset and acknowledge the deletion of sanitization certificate.

    +
    eradicate_all_data
    required
    boolean

    Set to true to perform a factory reset.

    +
    finalize
    required
    boolean

    Must be true to finalize factory reset.

    +
    reinstall_image
    required
    boolean

    Set to true to reinstall image, or false to skip reinstalling image.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    image_source
    string

    Source of the ISO image to download. Valid values include auto and URLs. +auto means download the image from Pure1 cloud, +and a URL means download the image from the specified URL. +Default value is auto.

    +
    image_version
    string

    Version of the image to download. image_version is optional, +and the default value is the current running Purity version. +If image_source is auto, the image with the specified version +will be downloaded from Pure1 cloud. +If image_source is a URL, image_version will be used to compare +to the downloaded image version for the purpose of validation.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "image_source": "auto",
    • "image_version": "6.6.6"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List End User Agreement and signature

    Displays the End User Agreement and signature.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Modify signature on the End User Agreement

    Modifies the signature on the End User Agreement.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (_eula_signature)

    Responses

    Request samples

    Content type
    application/json
    {
    • "signature": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List factory reset tokens

    Displays a list of tokens used to perform a factory reset on the array.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create a factory reset token

    Creates a token that can be used to perform a factory reset on the array. +Factory reset tokens can only be created after the array has been prepared +for reset (e.g., all volumes and snapshots must first be eradicated). +After a token has been created, operations that would take the array out of +the prepared state are disabled (e.g., creating volumes) until all +tokens have been deleted.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a factory reset token

    Deletes an existing token that could be used to perform a factory reset on the array.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List NTP test results

    Displays test results for configured NTP servers.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    List array front-end performance data

    Displays real-time and historical front-end performance data at the array +level including latency, bandwidth, IOPS, average I/O size, and queue depth.

    +
    query Parameters
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    protocol
    string

    Protocol type. Valid values are nfs, smb, and all.

    +
    protocol_group
    string

    Protocol group type. Valid values are block, file, and all.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    List array front-end IO performance data by link

    Displays real-time and historical front-end performance data at the array +level including latency, bandwidth, IOPS, average I/O size, and queue depth. +Group output is shown by link. A link represents a set of arrays that an I/O operation +depends on. +For local-only I/Os, this is a local array. For mirrored I/Os, this is a set of synchronous +replication peer arrays.

    +
    query Parameters
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    List array space information

    Displays real-time and historical array space information including unique +volume and snapshot space, shared space, data reduction, provisioned +capacity, usable capacity, and parity.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ]
    }

    List tags

    Displays the list of tags on array objects.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Delete tags

    Deletes specified tags on array objects.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    keys
    Array of strings

    A comma-separated list of tag keys.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Update tags

    Updates tags.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    A list of tags to be created or, if they already exist, updated.

    +
    Array ()
    key
    string

    Key of the tag. Supports up to 64 Unicode characters.

    +
    namespace
    string

    Optional namespace of the tag. +Namespace identifies the category of the tag. Omitting the namespace +defaults to the namespace default. The pure&#42; namespaces are +reserved for plugins and integration partners. It is recommended +that customers avoid using reserved namespaces.

    +
    object (_fixedReference)
    value
    string

    Value of the tag. Supports up to 256 Unicode characters.

    +

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Array Connections

    Manages connections between arrays.

    +

    List the connected arrays

    Displays a list of connected arrays.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    remote_ids
    Array of strings

    A comma-separated list of remote array IDs. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_names query parameter.

    +
    remote_names
    Array of strings

    A comma-separated list of remote array names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_ids query parameter.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create an array connection

    Creates a connection between this array and the specified array.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    connection_key
    string

    The connection key of the target array.

    +
    encryption
    string

    If encrypted, all traffic over this array connection will be encrypted. +If unencrypted, all traffic over this array connection will be unencrypted. +Defaults to unencrypted.

    +
    management_address
    string

    Management IP address of the target array.

    +
    replication_addresses
    Array of strings

    IP addresses and FQDNs of the target arrays. Configurable only when +replication_transport is set to ip. If not configured, will be set +to all the replication addresses available on the target array +at the time of the POST.

    +
    replication_transport
    string

    The protocol used to transport data between the local array and +the remote array. +Valid values are ip and fc. The default is ip.

    +
    type
    string

    The type of replication. +Valid values are async-replication and sync-replication.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "connection_key": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
    • "encryption": "encrypted",
    • "management_address": "10.202.101.78",
    • "replication_addresses": [
      ],
    • "replication_transport": "ip",
    • "type": "async-replication"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete an array connection

    Deletes the connection between this array and the specified array.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify an array connection

    Modifies attributes for an array connection.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    refresh
    boolean

    If set to true, the array will attempt to communicate with +the connection peer in order to update +the connection attributes on both arrays with any changes that have occurred. +If set to true, other array connection attributes may not be modified in requests. +Default value is false.

    +
    renew_encryption_key
    boolean

    If set to true, update array connection with a new encryption key. +If set to true, other array connection attributes may not be modified in requests. +Defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    default_limit
    integer <int64>

    Deprecated. Default maximum bandwidth threshold for outbound traffic in bytes. Once +exceeded, bandwidth throttling occurs.

    +
    object (TimeWindow)

    Deprecated. The time during which the window_limit threshold is in effect.

    +
    window_limit
    integer <int64>

    Deprecated. Maximum bandwidth threshold for outbound traffic during the specified +window_limit time range in bytes. Once exceeded, bandwidth throttling +occurs.

    +
    connection_key
    string

    The connection key of the target array. +It is only required when encryption is changed from unencrypted to encrypted, +or when type is changed from async-replication to sync-replication.

    +
    encryption
    string

    If encrypted, encryption will be enabled for all traffic over this array connection. +connection_key must be specified when encrypted is set to true. +If unencrypted, encryption will be disabled for all traffic over this array connection. +If not specified, the current encryption option for the array connection will remain +unchanged.

    +
    management_address
    string

    Management IP address of the target array.

    +
    replication_addresses
    Array of strings

    IP addresses and FQDNs of the target arrays. Configurable only when +replication_transport is set to ip.

    +
    object (_throttle)

    The bandwidth throttling for an array connection. Configurable on PATCH only.

    +
    type
    string

    The type of replication. +Valid values are async-replication and sync-replication.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "default_limit": 1073741824,
    • "window": {
      },
    • "window_limit": 2097152,
    • "connection_key": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
    • "encryption": "encrypted",
    • "management_address": "10.202.101.78",
    • "replication_addresses": [
      ],
    • "throttle": {
      },
    • "type": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List connection key

    Displays the connection key for the array.

    +
    query Parameters
    encrypted
    boolean

    If true, the returned array connection key will encode an encryption key +used to establish trust and secure replication traffic. +If false, the returned array connection key will not encode an encryption key. +If not specified, defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    List connection path

    Displays the connection path from the array to which the connection was made.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    remote_ids
    Array of strings

    A comma-separated list of remote array IDs. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_names query parameter.

    +
    remote_names
    Array of strings

    A comma-separated list of remote array names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_ids query parameter.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Audits

    Audit trail records describe administrative actions performed by a user to modify the +configuration of an array.

    +

    List audits

    Displays a list of audits.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Certificates

    Purity//FA creates a self-signed certificate and private key when you start the system for the +first time. You can use the default certificate, change the certificate attributes, create a new +self-signed certificate, or import an SSL certificate signed by a certificate authority.

    +

    List certificate attributes

    Displays certificate attributes.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create certificate

    Creates a certificate object and specifies the valid time period and organization +details of the certificate. A certificate can be imported or manually configured.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    certificate
    string

    The text of the certificate.

    +
    common_name
    string

    The common name field listed in the certificate.

    +
    country
    string

    Two-letter country (ISO) code listed in the certificate.

    +
    email
    string

    The email field listed in the certificate.

    +
    intermediate_certificate
    string

    The text of the intermediate certificate chains.

    +
    key_algorithm
    string

    The key algorithm used to generate the certificate. +This field can only be specified when creating a new self-signed certificate. +Defaults to rsa if not specified. Valid values when creating a new self-signed +certificate only include rsa, ec, ed448 and ed25519.

    +
    key_size
    integer <int32>

    The size (in bits) of the private key for the certificate. Default is 2048 bits +for rsa key_algorithm, 256 for ec and ed25519. The ed448 default key +size is 456. This field can only be specified when creating a new self-signed +certificate.

    +
    locality
    string

    The locality field listed in the certificate.

    +
    organization
    string

    The organization field listed in the certificate.

    +
    organizational_unit
    string

    The organizational unit field listed in the certificate.

    +
    state
    string

    The state/province field listed in the certificate.

    +
    subject_alternative_names
    Array of strings

    The alternative names that are secured by this certificate. +Alternative names may be IP addresses, DNS names, or URIs.

    +
    days
    integer <int32>

    The number of days that the self-signed certificate is valid. Defaults to 3650. +This field can only be specified when creating a new self-signed certificate.

    +
    key
    string

    The text of the private key. +This field can only be specified when importing a certificate and key pair.

    +
    passphrase
    string

    The passphrase used to encrypt key. +This field can only be specified when importing a certificate and key pair.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "certificate": "string",
    • "common_name": "Pure Storage Inc.",
    • "country": "CA",
    • "email": "tcrisp@veridiandynamics.com",
    • "intermediate_certificate": "string",
    • "key_algorithm": "rsa",
    • "key_size": 2048,
    • "locality": "Toronto",
    • "organization": "Veridian Dynamics",
    • "organizational_unit": "Research & Development",
    • "state": "Ontario",
    • "subject_alternative_names": [
      ],
    • "days": 3650,
    • "key": "string",
    • "passphrase": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete certificate

    Deletes a specific certificate object.

    +
    query Parameters
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify certificates

    Modifies certificate attributes. Modifying self-signed certificate attributes +replaces the existing certificate with a new one, generated by Purity//FA, +using the specified attributes.

    +
    query Parameters
    generate_new_key
    boolean

    If set to true, a new private key is generated when generating a new certificate with the +specified attributes. This may not be set to true when importing a certificate and private key, +and may not be set to false when generating a new self-signed certificate to replace a +certificate that was imported. Default setting is false.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    certificate
    string

    The text of the certificate.

    +
    common_name
    string

    The common name field listed in the certificate.

    +
    country
    string

    Two-letter country (ISO) code listed in the certificate.

    +
    email
    string

    The email field listed in the certificate.

    +
    intermediate_certificate
    string

    The text of the intermediate certificate chains.

    +
    key_algorithm
    string

    The key algorithm used to generate the certificate. +This field can only be specified when creating a new self-signed certificate. +Defaults to rsa if not specified. Valid values when creating a new self-signed +certificate only include rsa, ec, ed448 and ed25519.

    +
    key_size
    integer <int32>

    The size (in bits) of the private key for the certificate. Default is 2048 bits +for rsa key_algorithm, 256 for ec and ed25519. The ed448 default key +size is 456. This field can only be specified when creating a new self-signed +certificate.

    +
    locality
    string

    The locality field listed in the certificate.

    +
    organization
    string

    The organization field listed in the certificate.

    +
    organizational_unit
    string

    The organizational unit field listed in the certificate.

    +
    state
    string

    The state/province field listed in the certificate.

    +
    subject_alternative_names
    Array of strings

    The alternative names that are secured by this certificate. +Alternative names may be IP addresses, DNS names, or URIs.

    +
    days
    integer <int32>

    The number of days that the self-signed certificate is valid. Defaults to 3650. +This field can only be specified when creating a new self-signed certificate.

    +
    key
    string

    The text of the private key. +This field can only be specified when importing a certificate and key pair.

    +
    passphrase
    string

    The passphrase used to encrypt key. +This field can only be specified when importing a certificate and key pair.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "certificate": "string",
    • "common_name": "Pure Storage Inc.",
    • "country": "CA",
    • "email": "tcrisp@veridiandynamics.com",
    • "intermediate_certificate": "string",
    • "key_algorithm": "rsa",
    • "key_size": 2048,
    • "locality": "Toronto",
    • "organization": "Veridian Dynamics",
    • "organizational_unit": "Research & Development",
    • "state": "Ontario",
    • "subject_alternative_names": [
      ],
    • "days": 3650,
    • "key": "string",
    • "passphrase": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List certificates and certificate-groups

    Lists membership associations between groups and certificates.

    +
    query Parameters
    certificate_group_ids
    Array of strings

    A comma-separated list of certificate group ids. +If there is not at least one resource that matches each of the +elements of certificate_group_ids, then an error is returned. +This cannot be provided in conjunction with the certificate_group_names parameter.

    +
    certificate_group_names
    Array of strings

    A comma-separated list of certificate group names. +If no resource matches each of the elements of certificate_group_names, +then an error is returned. +This cannot be provided in conjunction with the certificate_group_ids parameter.

    +
    certificate_ids
    Array of strings

    A comma-separated list of certificate ids. +If there is not at least one resource that matches each of the +elements of certificate_ids, then an error is returned. +This cannot be provided in conjunction with the certificate_names +parameter.

    +
    certificate_names
    Array of strings

    The names of one or more certificates. +Enter multiple names in comma-separated format. +For example, cert01,cert02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create certificates orcertificate-groups

    Creates one or more certificates to one or more certificate groups.

    +
    query Parameters
    certificate_group_ids
    Array of strings

    A comma-separated list of certificate group ids. +If there is not at least one resource that matches each of the +elements of certificate_group_ids, then an error is returned. +This cannot be provided in conjunction with the certificate_group_names parameter.

    +
    certificate_group_names
    Array of strings

    A comma-separated list of certificate group names. +If no resource matches each of the elements of certificate_group_names, +then an error is returned. +This cannot be provided in conjunction with the certificate_group_ids parameter.

    +
    certificate_ids
    Array of strings

    A comma-separated list of certificate ids. +If there is not at least one resource that matches each of the +elements of certificate_ids, then an error is returned. +This cannot be provided in conjunction with the certificate_names +parameter.

    +
    certificate_names
    Array of strings

    The names of one or more certificates. +Enter multiple names in comma-separated format. +For example, cert01,cert02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Deletes certificates/certificate-groups

    Deletes one or more certificates from one or more certificate groups.

    +
    query Parameters
    certificate_group_ids
    Array of strings

    A comma-separated list of certificate group ids. +If there is not at least one resource that matches each of the +elements of certificate_group_ids, then an error is returned. +This cannot be provided in conjunction with the certificate_group_names parameter.

    +
    certificate_group_names
    Array of strings

    A comma-separated list of certificate group names. +If no resource matches each of the elements of certificate_group_names, +then an error is returned. +This cannot be provided in conjunction with the certificate_group_ids parameter.

    +
    certificate_ids
    Array of strings

    A comma-separated list of certificate ids. +If there is not at least one resource that matches each of the +elements of certificate_ids, then an error is returned. +This cannot be provided in conjunction with the certificate_names +parameter.

    +
    certificate_names
    Array of strings

    The names of one or more certificates. +Enter multiple names in comma-separated format. +For example, cert01,cert02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List certificates uses

    Displays the usage and associations of certificates.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create certificate-signing-requests

    Creates a certificate signing request using a specified certificate and parameters.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (_referenceNoId)
    common_name
    string

    The common name field listed in the certificate.

    +
    country
    string

    Two-letter country (ISO) code listed in the certificate.

    +
    email
    string

    The email field listed in the certificate.

    +
    locality
    string

    The locality field listed in the certificate.

    +
    organization
    string

    The organization field listed in the certificate.

    +
    organizational_unit
    string

    The organizational unit field listed in the certificate.

    +
    state
    string

    The state/province field listed in the certificate.

    +
    subject_alternative_names
    Array of strings

    The alternative names that are secured by this certificate. +Alternative names include IP addresses, DNS names, or URIs.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "certificate": {
      },
    • "common_name": "Pure Storage Inc.",
    • "country": "CA",
    • "email": "tcrisp@veridiandynamics.com",
    • "locality": "Toronto",
    • "organization": "Veridian Dynamics",
    • "organizational_unit": "Research & Development",
    • "state": "Ontario",
    • "subject_alternative_names": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Certificate Groups

    Certificate groups, also known as certificate bundles, are collections of digital certificates. +Each certificate can belong to one or more groups in order to serve different purposes.

    +

    List certificate-groups

    Display all array certificate groups.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create certificate-groups

    Creates one or more certificate groups on the array.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete certificate-groups

    Deletes one or more certificate groups from the array.

    +
    query Parameters
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List certificate-groups and certificates

    Lists membership associations between groups and certificates on the array.

    +
    query Parameters
    certificate_group_ids
    Array of strings

    A comma-separated list of certificate group ids. +If there is not at least one resource that matches each of the +elements of certificate_group_ids, then an error is returned. +This cannot be provided in conjunction with the certificate_group_names parameter.

    +
    certificate_group_names
    Array of strings

    A comma-separated list of certificate group names. +If no resource matches each of the elements of certificate_group_names, +then an error is returned. +This cannot be provided in conjunction with the certificate_group_ids parameter.

    +
    certificate_ids
    Array of strings

    A comma-separated list of certificate ids. +If there is not at least one resource that matches each of the +elements of certificate_ids, then an error is returned. +This cannot be provided in conjunction with the certificate_names +parameter.

    +
    certificate_names
    Array of strings

    The names of one or more certificates. +Enter multiple names in comma-separated format. +For example, cert01,cert02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create certificate-groups/certificates

    Creates one or more certificates to one or more certificate groups on the array.

    +
    query Parameters
    certificate_group_ids
    Array of strings

    A comma-separated list of certificate group ids. +If there is not at least one resource that matches each of the +elements of certificate_group_ids, then an error is returned. +This cannot be provided in conjunction with the certificate_group_names parameter.

    +
    certificate_group_names
    Array of strings

    A comma-separated list of certificate group names. +If no resource matches each of the elements of certificate_group_names, +then an error is returned. +This cannot be provided in conjunction with the certificate_group_ids parameter.

    +
    certificate_ids
    Array of strings

    A comma-separated list of certificate ids. +If there is not at least one resource that matches each of the +elements of certificate_ids, then an error is returned. +This cannot be provided in conjunction with the certificate_names +parameter.

    +
    certificate_names
    Array of strings

    The names of one or more certificates. +Enter multiple names in comma-separated format. +For example, cert01,cert02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete certificate-groups or certificates

    Deletes one or more certificate groups.

    +
    query Parameters
    certificate_group_ids
    Array of strings

    A comma-separated list of certificate group ids. +If there is not at least one resource that matches each of the +elements of certificate_group_ids, then an error is returned. +This cannot be provided in conjunction with the certificate_group_names parameter.

    +
    certificate_group_names
    Array of strings

    A comma-separated list of certificate group names. +If no resource matches each of the elements of certificate_group_names, +then an error is returned. +This cannot be provided in conjunction with the certificate_group_ids parameter.

    +
    certificate_ids
    Array of strings

    A comma-separated list of certificate ids. +If there is not at least one resource that matches each of the +elements of certificate_ids, then an error is returned. +This cannot be provided in conjunction with the certificate_names +parameter.

    +
    certificate_names
    Array of strings

    The names of one or more certificates. +Enter multiple names in comma-separated format. +For example, cert01,cert02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List certificate-groups/uses

    Lists how certificate groups are being used and by what.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Connections

    A connection gives hosts access to volumes on the array.

    +

    List volume connections

    Displays a list of connections between a volume and its hosts and host groups, as well as +the logical unit numbers (LUNs) or NVMe Namespace IDs (NSIDs) used by the associated hosts +to address these volumes.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    host_group_names
    Array of strings

    Performs the operation on the host group specified. +Enter multiple names in comma-separated format. +A request cannot include a mix of multiple objects with multiple names. +For example, a request cannot include a mix of multiple host group names and volume names; +instead, at least one of the objects (e.g., host_group_names) must be set to only one name +(e.g., hgroup01).

    +
    host_names
    Array of strings

    Performs the operation on the hosts specified. +Enter multiple names in comma-separated format. +For example, host01,host02. +A request cannot include a mix of multiple objects with multiple names. +For example, a request cannot include a mix of multiple host names and volume names; +instead, at least one of the objects (e.g., host_names) must be set to only one name +(e.g., host01).

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    protocol_endpoint_ids
    Array of strings

    Performs the operation on the protocol endpoints specified. +Enter multiple IDs in comma-separated format. +For example, peid01,peid02. +A request cannot include a mix of multiple objects with multiple IDs. +For example, a request cannot include a mix of multiple protocol endpoint IDs and host names. +Instead, at least one of the objects (e.g., protocol_endpoint_ids) must be set to one ID +(e.g., peid01).

    +
    protocol_endpoint_names
    Array of strings

    Performs the operation on the protocol endpoints specified. +Enter multiple names in comma-separated format. +For example, pe01,pe02. +A request cannot include a mix of multiple objects with multiple names. +For example, a request cannot include a mix of multiple protocol endpoint names and host names; +instead, at least one of the objects (e.g., protocol_endpoint_names) must be set to one name +(e.g., pe01).

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    volume_ids
    Array of strings

    Performs the operation on the specified volume. +Enter multiple ids in comma-separated format. +For example, vol01id,vol02id. +A request cannot include a mix of multiple objects with multiple IDs. +For example, a request cannot include a mix of multiple volume IDs and host names; +instead, at least one of the objects (e.g., volume_ids) must be set to only one name +(e.g., vol01id). +Only one of the two between volume_names and volume_ids may be used at a time.

    +
    volume_names
    Array of strings

    Performs the operation on the volume specified. +Enter multiple names in comma-separated format. +For example, vol01,vol02. +A request cannot include a mix of multiple objects with multiple names. +For example, a request cannot include a mix of multiple volume names and host names; +instead, at least one of the objects (e.g., volume_names) must be set to only one name +(e.g., vol01).

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a connection between a volume and host or host group

    Creates a connection between a volume and a host or host group. +One of volume_names or volume_ids and one of host_names +or host_group_names query parameters are required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    host_group_names
    Array of strings

    Performs the operation on the host group specified. +Enter multiple names in comma-separated format. +A request cannot include a mix of multiple objects with multiple names. +For example, a request cannot include a mix of multiple host group names and volume names; +instead, at least one of the objects (e.g., host_group_names) must be set to only one name +(e.g., hgroup01).

    +
    host_names
    Array of strings

    Performs the operation on the hosts specified. +Enter multiple names in comma-separated format. +For example, host01,host02. +A request cannot include a mix of multiple objects with multiple names. +For example, a request cannot include a mix of multiple host names and volume names; +instead, at least one of the objects (e.g., host_names) must be set to only one name +(e.g., host01).

    +
    volume_ids
    Array of strings

    Performs the operation on the specified volume. +Enter multiple ids in comma-separated format. +For example, vol01id,vol02id. +A request cannot include a mix of multiple objects with multiple IDs. +For example, a request cannot include a mix of multiple volume IDs and host names; +instead, at least one of the objects (e.g., volume_ids) must be set to only one name +(e.g., vol01id). +Only one of the two between volume_names and volume_ids may be used at a time.

    +
    volume_names
    Array of strings

    Performs the operation on the volume specified. +Enter multiple names in comma-separated format. +For example, vol01,vol02. +A request cannot include a mix of multiple objects with multiple names. +For example, a request cannot include a mix of multiple volume names and host names; +instead, at least one of the objects (e.g., volume_names) must be set to only one name +(e.g., vol01).

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    lun
    integer <int32> [ 1 .. 4095 ]

    The logical unit number (LUN) by which the specified hosts +are to address the specified volume. If the LUN is not specified, +the system automatically assigns a LUN to the connection. +To automatically assign a LUN to a private connection, +the system starts at LUN 1 and counts up to the maximum LUN 4095, +assigning the first available LUN to the connection. +For shared connections, the system starts at LUN 254 and +counts down to the minimum LUN 1, assigning the first available LUN +to the connection. If all LUNs in the [1...254] range are taken, +the system starts at LUN 255 and counts up to the maximum LUN 4095, +assigning the first available LUN to the connection. +Should not be used together with an NVMe host or host group.

    +
    object (Reference)

    A protocol endpoint (also known as a conglomerate volume) which acts as a proxy through which +virtual volumes are created and then connected to VMware ESXi hosts or host groups. +The protocol endpoint itself does not serve I/Os; instead, +its job is to form connections between FlashArray volumes and ESXi hosts and host groups.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "lun": 7,
    • "protocol_endpoint": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a connection between a volume and its host or host group

    Deletes the connection between a volume and its associated host or host group. +One of volume_names or volume_ids and one of host_names +or host_group_names query parameters are required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    host_group_names
    Array of strings

    Performs the operation on the host group specified. +Enter multiple names in comma-separated format. +A request cannot include a mix of multiple objects with multiple names. +For example, a request cannot include a mix of multiple host group names and volume names; +instead, at least one of the objects (e.g., host_group_names) must be set to only one name +(e.g., hgroup01).

    +
    host_names
    Array of strings

    Performs the operation on the hosts specified. +Enter multiple names in comma-separated format. +For example, host01,host02. +A request cannot include a mix of multiple objects with multiple names. +For example, a request cannot include a mix of multiple host names and volume names; +instead, at least one of the objects (e.g., host_names) must be set to only one name +(e.g., host01).

    +
    volume_ids
    Array of strings

    Performs the operation on the specified volume. +Enter multiple ids in comma-separated format. +For example, vol01id,vol02id. +A request cannot include a mix of multiple objects with multiple IDs. +For example, a request cannot include a mix of multiple volume IDs and host names; +instead, at least one of the objects (e.g., volume_ids) must be set to only one name +(e.g., vol01id). +Only one of the two between volume_names and volume_ids may be used at a time.

    +
    volume_names
    Array of strings

    Performs the operation on the volume specified. +Enter multiple names in comma-separated format. +For example, vol01,vol02. +A request cannot include a mix of multiple objects with multiple names. +For example, a request cannot include a mix of multiple volume names and host names; +instead, at least one of the objects (e.g., volume_names) must be set to only one name +(e.g., vol01).

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Container Default Protections

    Default protection is a list of protection groups that are applied to newly created volumes. +Volumes can opt out of the default protection at creation. The pod's default_protections +defaults to the array's default_protections at pod creation. +Default protection can be configured on the array and the pod.

    +

    List container default protections

    Displays a list of containers with its default protections.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the container ID specified. +Enter multiple source IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together. +Specifying ids or names with no value will perform the operation on local array.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique container name specified. +Enter multiple names in comma-separated format. +The ids or names parameter is required, but they cannot be set together. +Specifying ids or names with no value will perform the operation on local array.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Modify a container's default protections

    Modifies a container's default protections. +To modify, set default_protections to the new list.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the container ID specified. +Enter multiple source IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together. +Specifying ids or names with no value will perform the operation on local array.

    +
    names
    Array of strings

    Performs the operation on the unique container name specified. +Enter multiple names in comma-separated format. +The ids or names parameter is required, but they cannot be set together. +Specifying ids or names with no value will perform the operation on local array.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    Array of objects (_default_protection_reference)

    The default protection that is applied to newly created volumes. +Volumes can opt out of the default protection at creation. +The pod's default_protections defaults to the array's default_protections at pod creation. +To clear the list of default protections, set to an empty list [].

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "default_protections": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Controllers

    Controller data includes the name, mode, FlashArray model, Purity//FA software version, and +status of each controller in the array.

    +

    List controller information and status

    Displays the name, mode, FlashArray model, Purity//FA software version, and status of each controller in the array.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Directories

    Important file system directories should be set up as managed directories. Managed directories +can have policies attached to them. Managed directories differ from standard directories in that +they provide space reporting and metrics.

    +

    List directories

    Displays a list of directories, including those pending eradication.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    file_system_ids
    Array of strings

    Performs the operation on the file system ID specified. +Enter multiple file system IDs in comma-separated format. +The file_system_ids or file_system_names parameter is required, +but they cannot be set together.

    +
    file_system_names
    Array of strings

    Performs the operation on the file system name specified. +Enter multiple file system names in comma-separated format. +For example, filesystem01,filesystem02.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ],
    • "total": [
      ]
    }

    Create directory

    Creates a managed directory at the specified path. +The managed directory name must consist of a file system name prefix and a managed directory +name suffix (separated with ':'). The suffix must be between 1 and 63 characters +(alphanumeric and '-') in length and begin and end with a letter or number. +The suffix must include at least one letter or '-'. +Set names to create a managed directory with the specified full managed directory name, +or set file_system_names or file_system_ids in the query parameters and suffix in +the body parameters to create a managed directory in the specified file system with the +specified suffix. These two options are exclusive.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    file_system_ids
    Array of strings

    Performs the operation on the file system ID specified. +Enter multiple file system IDs in comma-separated format. +The file_system_ids or file_system_names parameter is required, +but they cannot be set together.

    +
    file_system_names
    Array of strings

    Performs the operation on the file system name specified. +Enter multiple file system names in comma-separated format. +For example, filesystem01,filesystem02.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    directory_name
    string

    The managed directory name without the file system name prefix. +A full managed directory name is constructed in the form of FILE_SYSTEM:DIR where +FILE_SYSTEM is the file system name and DIR is the value of this field. +directory_name is required if file_system_names or file_system_ids is set. +directory_name cannot be set if names is set.

    +
    path
    string

    Path of the managed directory in the file system.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "directory_name": "string",
    • "path": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete managed directories

    Deletes one or more managed directories. +To be deleted, a managed directory must be empty and not attached to any enabled export +policies. Deleted managed directories cannot be recovered. +The ids or names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a managed directory

    Modifies a managed directory. +To rename a managed directory, set name to the new name. +The ids or names parameter is required, but cannot be set together. +The name or directory_name parameter is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The new name for the resource.

    +
    directory_name
    string

    The managed directory name without the file system name prefix. +A full managed directory name is constructed in the form of FILE_SYSTEM:DIR where +FILE_SYSTEM is the file system name and DIR is the value of this field.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "directory_name": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List directory performance data

    Displays real-time and historical performance data, real-time latency data, and average I/O +sizes for each directory and as a total of all directories across the entire array.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    protocol
    string

    Protocol type. Valid values are nfs, smb, and all.

    +
    protocol_group
    string

    Protocol group type. Valid values are block, file, and all.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ],
    • "total": [
      ]
    }

    List policies

    Displays a list of policies that are attached to directories.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    List audit policies attached to a directory

    Displays a list of audit policies that are attached to directories.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a membership between a directory and one or more audit policies

    Creates a membership between a directory and one or more audit policies. +Either the member_ids or member_names parameter is required, but they cannot +be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_directorypolicypostPolicies)

    A list of policies to apply to the resource. +The id or name field in each policy parameter is required, +but they cannot be set together.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "policies": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a membership between a directory and one or more audit policies

    Deletes a membership between a directory and one or more audit policies. +Either the policy_ids or policy_names parameter is required, but they cannot be +set together. +Either the member_ids or member_names parameter is required, but they cannot be +set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List auto managed directory policies attached to a directory

    Displays a list of auto managed directory policies that are attached to directories.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a membership between a directory with one or more auto managed directory policies

    Creates a membership between a directory with one or more auto managed directory policies. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_directorypolicypostPolicies)

    A list of policies to apply to the resource. +The id or name field in each policy parameter is required, +but they cannot be set together.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "policies": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a membership between a directory and one or more auto managed directory policies

    Deletes a membership between a directory with one or more auto managed directory policies. +The policy_ids or policy_names parameter is required, but they cannot be set together. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List NFS policies attached to a directory

    Displays a list of NFS policies that are attached to directories.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a membership between a directory and one or more NFS policies

    Creates a membership between a directory and one or more NFS policies. +The member_ids or member_names parameter is required but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_directorypolicyexportpostPolicies)

    A list of export policies to apply to the directory. +The id and name fields in each policy parameter are required, +but cannot be set together.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "policies": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a membership between a directory and one or more NFS policies

    Deletes a membership between a directory and one or more NFS policies. +The policy_ids or policy_names parameter is required, but cannot be set together. +The member_ids or member_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List quota policies attached to a directory

    Displays a list of quota policies that are attached to directories.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a membership between a directory and one or more quota policies

    Creates a membership between a directory and one or more quota policies. +The member_ids or member_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ignore_usage
    boolean

    Flag used to override checks for quota management operations. +If set to true, directory usage is not checked against the quota_limits that are set. +If set to false, the actual logical bytes in use are prevented from exceeding +the limits set on the directory. Client operations might be impacted. +If the limit exceeds the quota, the client operation is not allowed. +If not specified, defaults to false.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_directorypolicypostPolicies)

    A list of policies to apply to the resource. +The id or name field in each policy parameter is required, +but they cannot be set together.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "policies": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a membership between a directory and one or more quota policies

    Deletes a membership between a directory and one or more quota policies. +The policy_ids or policy_names parameter is required, but cannot be set together. +The member_ids or member_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List SMB policies attached to a directory

    Displays a list of SMB policies that are attached to directories.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a membership between a directory and one or more SMB policies

    Creates a membership between a directory and one or more SMB policies. +The member_ids or member_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_directorypolicyexportpostPolicies)

    A list of export policies to apply to the directory. +The id and name fields in each policy parameter are required, +but cannot be set together.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "policies": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a membership between a directory and one or more SMB policies

    Deletes a membership between a directory and one or more SMB policies. +The policy_ids or policy_names parameter is required, but cannot be set together. +The member_ids or member_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List snapshot policies attached to a directory

    Displays a list of snapshot policies that are attached to directories.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a membership between a directory with one or more snapshot policies

    Creates a membership between a directory with one or more snapshot policies. +The member_ids or member_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_directorypolicypostPolicies)

    A list of policies to apply to the resource. +The id or name field in each policy parameter is required, +but they cannot be set together.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "policies": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a membership between a directory and one or more snapshot policies

    Deletes a membership between a directory and one or more snapshot policies. +The policy_ids or policy_names parameter is required, but cannot be set together. +The member_ids or member_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List directory space information

    Displays physical storage consumption data for each directory.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ],
    • "total": [
      ]
    }

    Create NLM reclamation

    Creates an NLM reclamation, which is a system-wide operation that affects all clients, +so only one may be in progress at a time. Attempting to initiate reclamation while one is in +progress will result in an error. When NLM reclamation is initiated, all NLM locks are deleted +and client applications are notified that they can reacquire their locks within a grace period.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    header Parameters
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Directory Exports

    Managed directory exports are created by adding NFS or SMB export policies to managed +directories.

    +

    List directory exports

    Displays a list of directory exports.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    directory_ids
    Array of strings

    Performs the operation on the unique managed directory IDs specified. +Enter multiple managed directory IDs in comma-separated format. +The directory_ids or directory_names parameter is required, but they cannot be set together.

    +
    directory_names
    Array of strings

    Performs the operation on the managed directory names specified. +Enter multiple full managed directory names in comma-separated format. +For example, fs:dir01,fs:dir02.

    +
    export_names
    Array of strings

    Performs the operation on the export names specified. Enter multiple names in comma-separated +format. For example, name01,name02.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create directory exports

    Creates an export of a managed directory. +The directory_ids or directory_names parameter is required, but cannot be set together. +The policy_ids or policy_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    directory_ids
    Array of strings

    Performs the operation on the unique managed directory IDs specified. +Enter multiple managed directory IDs in comma-separated format. +The directory_ids or directory_names parameter is required, but they cannot be set together.

    +
    directory_names
    Array of strings

    Performs the operation on the managed directory names specified. +Enter multiple full managed directory names in comma-separated format. +For example, fs:dir01,fs:dir02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    export_enabled
    boolean

    If set to true, the export is enabled. +If not specified, defaults to true.

    +
    export_name
    string

    The name of the export to create. +Export names must be unique within the same protocol.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "export_enabled": false,
    • "export_name": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete directory exports

    Deletes one or more directory exports. +If any of the export_names is not unique across the system, +policy_ids or policy_names must be specified to determine the exports.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    directory_ids
    Array of strings

    Performs the operation on the unique managed directory IDs specified. +Enter multiple managed directory IDs in comma-separated format. +The directory_ids or directory_names parameter is required, but they cannot be set together.

    +
    directory_names
    Array of strings

    Performs the operation on the managed directory names specified. +Enter multiple full managed directory names in comma-separated format. +For example, fs:dir01,fs:dir02.

    +
    export_names
    Array of strings

    Performs the operation on the export names specified. Enter multiple names in comma-separated +format. For example, name01,name02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify directory exports

    Modifies a directory export. +Used for manually renaming, enabling, and disabling directory exports. +To rename a directory export, set 'export_name' to the new name.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    directory_ids
    Array of strings

    Performs the operation on the unique managed directory IDs specified. +Enter multiple managed directory IDs in comma-separated format. +The directory_ids or directory_names parameter is required, but they cannot be set together.

    +
    directory_names
    Array of strings

    Performs the operation on the managed directory names specified. +Enter multiple full managed directory names in comma-separated format. +For example, fs:dir01,fs:dir02.

    +
    export_names
    Array of strings

    Performs the operation on the export names specified. Enter multiple names in comma-separated +format. For example, name01,name02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    export_enabled
    boolean

    If set to true, the export is enabled. +If not specified, defaults to true.

    +
    export_name
    string

    The new name of the export. +Export names must be unique within the same protocol.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "export_enabled": false,
    • "export_name": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Directory Quotas

    Directory quotas provide the ability to set capacity limits on managed directories.

    +

    List directories with attached quota policies

    Displays a list of directories and the quota policies attached to them. Directories with multiple policies are listed repeatedly (once per policy). The directories without a policy attached are not listed.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    directory_ids
    Array of strings

    Performs the operation on the unique managed directory IDs specified. +Enter multiple managed directory IDs in comma-separated format. +The directory_ids or directory_names parameter is required, but they cannot be set together.

    +
    directory_names
    Array of strings

    Performs the operation on the managed directory names specified. +Enter multiple full managed directory names in comma-separated format. +For example, fs:dir01,fs:dir02.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Directory Services

    Manages directory service configurations for integration with LDAP servers (e.g. Active +Directory and OpenLDAP) in order to support various array services.

    +

    List directory services configuration

    Displays the directory services configuration settings for manageability.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Modify directory services configuration

    Modifies the directory service configuration.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    base_dn
    string

    Base of the Distinguished Name (DN) of the directory service groups.

    +
    bind_password
    string

    Masked password used to query the directory.

    +
    bind_user
    string

    Username used to query the directory.

    +
    ca_certificate
    string

    The certificate of the Certificate Authority (CA) that signed the certificates of the +directory servers, which is used to validate the authenticity of the configured servers.

    +
    check_peer
    boolean

    Whether or not server authenticity is enforced when a certificate is provided.

    +
    enabled
    boolean

    Whether or not the directory service is enabled.

    +
    object (_directoryServiceManagement)

    Properties specific to the management service.

    +
    uris
    Array of strings

    List of URIs for the configured directory servers.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "base_dn": "DC=mycompany,DC=com",
    • "bind_password": "****",
    • "bind_user": "CN=John,OU=Users,DC=example,DC=com",
    • "ca_certificate": "string",
    • "check_peer": false,
    • "enabled": true,
    • "management": {
      },
    • "uris": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List group to management access policy mappings

    Displays access control settings for remote groups.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique names specified. +For example, GroupRoleMappingName. +Enter multiple names in comma-separated format.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    role_names
    Array of strings

    This field has been deprecated.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a group in management access policy mappings

    Creates one or more groups in management access policy mappings.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    required
    Array of strings

    Performs the operation on the unique names specified. +For example, GroupRoleMappingName. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    group
    string

    Group name that contains users with the abilities granted by the associated policies.

    +
    group_base
    string

    Specifies where the configured group is located in the directory tree.

    +
    Array of objects (_referenceWithType)

    List of management access policies to associate with the group.

    +
    object (ReferenceNoId)

    This field has been deprecated. +Predecessor to management access policies. Can be set to the +premade policy of the same name. Cannot be set with management_access_policies.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "group": "groupOfUsers",
    • "group_base": "OU=PureGroups,OU=SANManagers",
    • "management_access_policies": [
      ],
    • "role": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete group to management access policy mappings

    Deletes one or more group to management access policy mappings.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    required
    Array of strings

    Performs the operation on the unique names specified. +For example, GroupRoleMappingName. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify group to management access policy mappings

    Modifies properties of one or more group to management access policy mappings. +Modifying management access policies is done at +/directory-services/roles/policies/management-access instead.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    required
    Array of strings

    Performs the operation on the unique names specified. +For example, GroupRoleMappingName. +Enter multiple names in comma-separated format.

    +
    role_names
    Array of strings

    This field has been deprecated.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group
    string

    Group name that contains users with the abilities granted by the associated policies.

    +
    group_base
    string

    Specifies where the configured group is located in the directory tree.

    +
    object (ReferenceNoId)

    This field has been deprecated. Predecessor to management access policies.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "group": "groupOfUsers",
    • "group_base": "OU=PureGroups,OU=SANManagers",
    • "role": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List management access policies attached to a group to management access policy mapping

    Displays a list of management access policies that are attached to a group to management access +policy mappings.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a membership between a group to management access policy mapping with one or more management access policies

    Creates a membership between a group to management access policy mapping with one or more +management access policies. One of member_ids or member_names parameter is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (PolicyAssignmentPostPolicy)

    A list of policies to apply to the resource. +One of id or name is required in each policy.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "policies": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a membership between a group to management access policy mapping and one or more management access policies

    Deletes a membership between a group to management access policy mapping with one or more +management access policies. One of policy_ids or policy_names is required, and one of +member_ids or member_names is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List directory services test results

    Displays the directory services test and displays the results. The test verifies that URIs can be resolved and that the array can bind and query the tree using the bind user credentials. The test also verifies that the array can find all configured groups to ensure the common names and group base are correctly configured.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    List local groups

    Displays a list of local groups.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    gids
    Array of integers <int32>

    Performs the operation on the specified GIDs. +Enter multiple GIDs in comma-separated format. +For example, 4234235,9681923.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sids
    Array of strings

    Performs the operation on the object SID specified. +Enter multiple SIDs in comma-separated format. +For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create local group

    Creates a local group.

    +
    query Parameters
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    email
    string

    Optional field to set the email address of the local group.

    +
    gid
    integer <int32>

    Optional field to set the GID of the local group.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "email": "string",
    • "gid": 0
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete local groups

    Deletes one or more local groups. +The gids, names, or sids parameter is required, but cannot be set together.

    +
    query Parameters
    gids
    Array of integers <int32>

    Performs the operation on the specified GIDs. +Enter multiple GIDs in comma-separated format. +For example, 4234235,9681923.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    sids
    Array of strings

    Performs the operation on the object SID specified. +Enter multiple SIDs in comma-separated format. +For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify local groups

    Modifies local groups.

    +
    query Parameters
    gids
    Array of integers <int32>

    Performs the operation on the specified GIDs. +Enter multiple GIDs in comma-separated format. +For example, 4234235,9681923.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    sids
    Array of strings

    Performs the operation on the object SID specified. +Enter multiple SIDs in comma-separated format. +For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    email
    string

    The email address of the local group.

    +
    gid
    integer <int32>

    The POSIX user ID of this object (group ID).

    +
    name
    string

    The local group name.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "email": "string",
    • "gid": 0,
    • "name": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List local group memberships

    Displays a list of local group memberships.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    group_gids
    Array of integers <int32>

    Performs the operation on the specified GIDs. +Enter multiple GIDs in comma-separated format. +For example, 4234235,9681923.

    +
    group_names
    Array of strings

    Performs the operation on the group names specified. +Enter multiple group names in comma-separated format. +For example, group1,group2.

    +
    group_sids
    Array of strings

    Performs the operation on the specified group SID. +Enter multiple group SIDs in comma-separated format. +For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of integers <int32>

    Performs the operation on the unique local member IDs specified. +Enter multiple member IDs in comma-separated format. For local group +IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). +The member_ids and member_names parameters cannot be provided together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_sids
    Array of strings

    Performs the operation on the specified member SID. +Enter multiple member SIDs in comma-separated format. +For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create local group membership

    Creates a local group membership with a group. +The group_names, group_sids, or group_ids parameter is required, but cannot be set +together.

    +
    query Parameters
    group_gids
    Array of integers <int32>

    Performs the operation on the specified GIDs. +Enter multiple GIDs in comma-separated format. +For example, 4234235,9681923.

    +
    group_names
    Array of strings

    Performs the operation on the group names specified. +Enter multiple group names in comma-separated format. +For example, group1,group2.

    +
    group_sids
    Array of strings

    Performs the operation on the specified group SID. +Enter multiple group SIDs in comma-separated format. +For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    The member_names, member_sids, or member_gids parameter is required, but cannot be set +together.

    +
    Array of objects (_localgroupmembershippostMembers)

    A list of resources to be a member of the group.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "members": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete local group membership

    Deletes one or more local group memberships. +The group_names, group_sids, or group_ids parameter is required, but cannot be set +together.

    +
    query Parameters
    group_gids
    Array of integers <int32>

    Performs the operation on the specified GIDs. +Enter multiple GIDs in comma-separated format. +For example, 4234235,9681923.

    +
    group_names
    Array of strings

    Performs the operation on the group names specified. +Enter multiple group names in comma-separated format. +For example, group1,group2.

    +
    group_sids
    Array of strings

    Performs the operation on the specified group SID. +Enter multiple group SIDs in comma-separated format. +For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

    +
    member_ids
    Array of integers <int32>

    Performs the operation on the unique local member IDs specified. +Enter multiple member IDs in comma-separated format. For local group +IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). +The member_ids and member_names parameters cannot be provided together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_sids
    Array of strings

    Performs the operation on the specified member SID. +Enter multiple member SIDs in comma-separated format. +For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List local users

    Displays a list of local users.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sids
    Array of strings

    Performs the operation on the object SID specified. +Enter multiple SIDs in comma-separated format. +For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    uids
    Array of integers <int32>

    A comma-separated list of local user IDs (UIDs). +Enter multiple local user IDs in comma-separated format. +For example, 423,51234.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create local user

    Creates a local user.

    +
    query Parameters
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    email
    string

    Optional field to set the email of the local user.

    +
    enabled
    boolean

    If this field is false, the local user will be disabled on creation. +Otherwise, the local user will be enabled and functional.

    +
    password
    string

    The password of the local user. This field is only required if the enabled field is true.

    +
    object (ReferenceWithType)

    Local group that would be assigned as the primary group of the local user.

    +
    uid
    integer <int32>

    Optional field to set the UID of the local user.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "email": "string",
    • "enabled": true,
    • "password": "string",
    • "primary_group": {
      },
    • "uid": 0
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete local users

    Deletes one or more local users. +The uids, names, or sids parameter is required, but cannot be set together.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    sids
    Array of strings

    Performs the operation on the object SID specified. +Enter multiple SIDs in comma-separated format. +For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

    +
    uids
    Array of integers <int32>

    A comma-separated list of local user IDs (UIDs). +Enter multiple local user IDs in comma-separated format. +For example, 423,51234.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify local user

    Modifies a local user.

    +
    query Parameters
    keep_open_sessions
    boolean

    If set to true, the session does not expire. +If set to false, when the user is disabled or password is changed, the session expires. +If not specified, defaults to false.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    sids
    Array of strings

    Performs the operation on the object SID specified. +Enter multiple SIDs in comma-separated format. +For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

    +
    uids
    Array of integers <int32>

    A comma-separated list of local user IDs (UIDs). +Enter multiple local user IDs in comma-separated format. +For example, 423,51234.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    email
    string

    Optional field to set the email of the local user.

    +
    enabled
    boolean

    If this field is false, the local user will be disabled on creation. +Otherwise, the local user will be enabled and functional from the beginning.

    +
    name
    string

    The local user name.

    +
    password
    string

    The password of the local user. This field is only required if the enabled field is true.

    +
    object (ReferenceWithType)

    Local group that would be assigned as the primary group of the local user.

    +
    uid
    integer <int32>

    Optional field to set the UID of the local user.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "email": "string",
    • "enabled": true,
    • "name": "string",
    • "password": "string",
    • "primary_group": {
      },
    • "uid": 0
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List local user memberships

    Displays a list of local user memberships.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    group_gids
    Array of integers <int32>

    Performs the operation on the specified GIDs. +Enter multiple GIDs in comma-separated format. +For example, 4234235,9681923.

    +
    group_names
    Array of strings

    Performs the operation on the group names specified. +Enter multiple group names in comma-separated format. +For example, group1,group2.

    +
    group_sids
    Array of strings

    Performs the operation on the specified group SID. +Enter multiple group SIDs in comma-separated format. +For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of integers <int32>

    Performs the operation on the unique local member IDs specified. +Enter multiple member IDs in comma-separated format. For local group +IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). +The member_ids and member_names parameters cannot be provided together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_sids
    Array of strings

    Performs the operation on the specified member SID. +Enter multiple member SIDs in comma-separated format. +For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create local user membership

    Creates a local user membership with a group. +The member_names or member_sids or member_ids parameter is required, +but cannot be set together.

    +
    query Parameters
    member_ids
    Array of integers <int32>

    Performs the operation on the unique local member IDs specified. +Enter multiple member IDs in comma-separated format. For local group +IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). +The member_ids and member_names parameters cannot be provided together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_sids
    Array of strings

    Performs the operation on the specified member SID. +Enter multiple member SIDs in comma-separated format. +For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    The group_names, group_sids, or group_gids parameter is required, but cannot be set +together.

    +
    Array of objects (_localusermembershippostGroups)

    A list of groups of which the user is a member.

    +
    is_primary
    boolean
    Default: false

    Determines whether memberships are primary group memberships or not.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "groups": [
      ],
    • "is_primary": false
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete local user membership

    Deletes one or more local user memberships. +The member_names, member_sids, or member_ids parameter is required, but cannot be set +together.

    +
    query Parameters
    group_gids
    Array of integers <int32>

    Performs the operation on the specified GIDs. +Enter multiple GIDs in comma-separated format. +For example, 4234235,9681923.

    +
    group_names
    Array of strings

    Performs the operation on the group names specified. +Enter multiple group names in comma-separated format. +For example, group1,group2.

    +
    group_sids
    Array of strings

    Performs the operation on the specified group SID. +Enter multiple group SIDs in comma-separated format. +For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

    +
    member_ids
    Array of integers <int32>

    Performs the operation on the unique local member IDs specified. +Enter multiple member IDs in comma-separated format. For local group +IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). +The member_ids and member_names parameters cannot be provided together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_sids
    Array of strings

    Performs the operation on the specified member SID. +Enter multiple member SIDs in comma-separated format. +For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Directory Snapshots

    Directory snapshots are created manually or by adding snapshot policies to managed directories. +Each snapshot policy can be re-used for multiple directories.

    +

    List directory snapshots

    Displays a list of directory snapshots, including those pending eradication.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ],
    • "total": [
      ]
    }

    Create directory snapshot

    Creates a snapshot of the contents of a directory. +The source_ids or source_names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    client_name
    string

    The client name portion of the client visible snapshot name. +A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where +DIR is the managed directory name, CLIENT_NAME is the value of this field, and +SUFFIX is the suffix. The client visible snapshot name is CLIENT_NAME.SUFFIX.

    +
    keep_for
    integer <int64>

    The time to keep the snapshots for, in milliseconds.

    +
    suffix
    string

    The suffix portion of the client visible snapshot name. +A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where +DIR is the managed directory name, CLIENT_NAME is the client name, and +SUFFIX is the value of this field. +The client visible snapshot name is CLIENT_NAME.SUFFIX. +If not specified, defaults to a monotonically increasing number generated by the system.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "client_name": "string",
    • "keep_for": 0,
    • "suffix": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete directory snapshot

    Deletes a directory snapshot that has been destroyed and is pending eradication. +Eradicated directory snapshots cannot be recovered. +Directory snapshots are destroyed by using the PATCH method. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify directory snapshot

    Modifies a directory snapshot. You can destroy, recover, or update the policy or time remaining +of a directory snapshot. +To destroy a directory snapshot, set destroyed=true. +To recover a directory snapshot that has been destroyed and is pending eradication, +set destroyed=false. +To rename a directory snapshot, set name to the new name. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    destroyed
    boolean

    If set to true, destroys a resource. Once set to true, +the time_remaining value will display the amount of time left +until the destroyed resource is permanently eradicated. +Before the time_remaining period has elapsed, the destroyed resource +can be recovered by setting destroyed=false. +Once the time_remaining period has elapsed, +the resource is permanently eradicated and can no longer be recovered.

    +
    client_name
    string

    The client name portion of the client-visible snapshot name. +A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where +DIR is the managed directory name, CLIENT_NAME is the value of this field, and +SUFFIX is the suffix. The client-visible snapshot name is CLIENT_NAME.SUFFIX. +The client name of a directory snapshot managed by a snapshot policy is not +changeable. +If the name and client_name parameters are both specified, client_name +must match the client name portion of name.

    +
    keep_for
    integer <int64>

    The amount of time to keep the snapshots, in milliseconds. +Can only be set on snapshots that are not managed by any snapshot policy. +Set to "" to clear the keep_for value.

    +
    name
    string

    The new name of a directory snapshot. +The name of a directory snapshot managed by a snapshot policy is not changeable.

    +
    object (Reference)

    The snapshot policy that manages this snapshot. +Set to name or id to "" to clear the policy.

    +
    suffix
    string

    The suffix portion of the client-visible snapshot name. +A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where +DIR is the managed directory name, CLIENT_NAME is the client name, and +SUFFIX is the value of this field. +The client-visible snapshot name is CLIENT_NAME.SUFFIX. +The suffix of a directory snapshot managed by a snapshot policy is not changeable. +If the name and suffix parameters are both specified, suffix must match +the suffix portion of name.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "destroyed": true,
    • "client_name": "string",
    • "keep_for": 0,
    • "name": "string",
    • "policy": {
      },
    • "suffix": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    DNS

    DNS attributes include the domain suffix, static name servers, mode (static or DHCP), and search +domain. The configured attributes can be listed.

    +

    List DNS parameters

    Displays the current DNS configurations and their parameters +including domain suffix, the list of DNS name server IP addresses, +and the list of services that DNS parameters apply to.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create DNS configuration

    Creates new DNS configuration with parameters including the domain suffix, +the list of DNS name server IP addresses, and the list of services that DNS parameters +apply to.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (ReferenceWithType)

    A reference to the certificate to use for validating nameservers +with HTTPS connections. +This property is mutually exclusive with ca_certificate_group property and may only +be configured when nameservers begin with HTTPS.

    +
    object (ReferenceWithType)

    A reference to the certificate group to use for validating nameservers +with HTTPS connections. +This property is mutually exclusive with ca_certificate property and may only +be configured when nameservers begin with HTTPS.

    +
    domain
    string

    The domain suffix to be appended by the appliance when performing DNS lookups.

    +
    nameservers
    Array of strings

    The list of DNS servers either in the form of IP addresses or HTTPS endpoints. +Domain names in HTTPS endpoints are not supported. IP addresses must be used instead. +If nameservers begin with https://, then DNS queries will be performed over HTTPS. +Otherwise, unencrypted DNS queries will be performed. +Using a combination of nameservers that begin with https:// and that do not begin +with https:// is not supported. +If servers are specified with https:// one of ca_certificate and ca_certificate_group +parameters must be set.

    +
    services
    Array of strings

    The list of services utilizing the DNS configuration.

    +
    object (ReferenceNoId)

    The network interface used for communication with the DNS server.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "ca_certificate": {
      },
    • "ca_certificate_group": {
      },
    • "domain": "example.com",
    • "nameservers": [
      ],
    • "services": [
      ],
    • "source": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete DNS configuration

    Deletes DNS configuration identified by configuration name.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify DNS parameters

    Modifies the DNS parameters of an array, including the domain suffix, the list of +DNS name server IP addresses, and the list of services that DNS parameters apply to. +If there is no DNS configuration beforehand new DNS configuration with 'default' +name is created. If more than one DNS configuration exists, name has to be specified +to identify the DNS configuration to be modified.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The new name for the resource.

    +
    object (ReferenceWithType)

    A reference to the certificate to use for validating nameservers +with HTTPS connections. +This property is mutually exclusive with ca_certificate_group property and may only +be configured when nameservers begin with HTTPS.

    +
    object (ReferenceWithType)

    A reference to the certificate group to use for validating nameservers +with HTTPS connections. +This property is mutually exclusive with ca_certificate property and may only +be configured when nameservers begin with HTTPS.

    +
    domain
    string

    The domain suffix to be appended by the appliance when performing DNS lookups.

    +
    nameservers
    Array of strings

    The list of DNS servers either in the form of IP addresses or HTTPS endpoints. +Domain names in HTTPS endpoints are not supported. IP addresses must be used instead. +If nameservers begin with https://, then DNS queries will be performed over HTTPS. +Otherwise, unencrypted DNS queries will be performed. +Using a combination of nameservers that begin with https:// and that do not begin +with https:// is not supported. +If servers are specified with https:// one of ca_certificate and ca_certificate_group +parameters must be set.

    +
    services
    Array of strings

    The list of services utilizing the DNS configuration.

    +
    object (ReferenceNoId)

    The network interface used for communication with the DNS server.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "ca_certificate": {
      },
    • "ca_certificate_group": {
      },
    • "domain": "example.com",
    • "nameservers": [
      ],
    • "services": [
      ],
    • "source": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Drives

    Drive data includes the name, type, status, capacity, protocol and other information +for all flash, NVRAM, and cache modules in an array.

    +

    List flash, NVRAM, and cache modules

    Displays a list of flash, NVRAM, and cache modules that are installed in the array along with their attributes and status.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Modify flash and NVRAM modules

    Modifies flash and NVRAM modules that have been added or connected but not yet admitted to the array.

    +
    query Parameters
    admit
    boolean

    If true, admits any unadmitted drives into the system.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    File Systems

    A FlashArray can contain up to 24 separate file systems, each with a number of directories that +can be exported via supported protocols. Clients, using Active Directory or LDAP, can connect +and access these exports using SMB or NFS.

    +

    List file systems

    Displays a list of file systems, including those pending eradication.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create file system

    Creates one or more file systems.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete file system

    Deletes a file system that has been destroyed and is pending eradication. +Eradicated file systems cannot be recovered. File systems are destroyed using the PATCH method.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a file system

    Modifies a file system. You can rename, destroy, move, or recover a file system. +To rename a file system, set name to the new name. +To destroy a file system, set destroyed=true. +To move a file system, set 'pod' to the destination pod reference. +To recover a file system that has been destroyed and is pending eradication, +set destroyed=false.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    destroyed
    boolean

    If set to true, destroys a resource. Once set to true, +the time_remaining value will display the amount of time left +until the destroyed resource is permanently eradicated. +Before the time_remaining period has elapsed, the destroyed resource +can be recovered by setting destroyed=false. +Once the time_remaining period has elapsed, +the resource is permanently eradicated and can no longer be recovered.

    +
    name
    string

    The new name for the resource.

    +
    object (Reference)

    The pod to move existing file systems into.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "destroyed": true,
    • "name": "string",
    • "pod": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Fleets

    A fleet is a collection of Arrays.

    +

    List fleets

    Displays information about the fleets known to the array.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique resource names specified. +Only one value is supported.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create a fleet

    Creates a fleet and adds the current array as its first member. +Additional arrays can be added to the fleet with POST /fleets/members.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique resource names specified. +Only one value is supported.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a fleet

    Deletes a fleet, permanently. +A fleet can only be deleted if the current array is the only array in the fleet.

    +
    query Parameters
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Only one value is supported.

    +
    names
    Array of strings

    Performs the operation on the unique resource names specified. +Only one value is supported.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a fleet

    Modifies a fleet, changing its name by passing the old name in name query parameter, and the +new name in the name parameter in the request body.

    +
    query Parameters
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Only one value is supported.

    +
    names
    Array of strings

    Performs the operation on the unique resource names specified. +Only one value is supported.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The new name for the resource.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Get fleet key information

    Displays the time remaining on the fleet key. +Note, fleet key itself is not displayed, since that is only available at time of fleet key +creation.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create a fleet key

    Creates a fleet key allowing an array to be added to a fleet. +This is the only time the fleet key is displayed, it cannot be retrieved subsequently. +Note, creation of a subsequent key invalidates all keys created earlier.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List fleet members

    Displays the members in the current fleet.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    fleet_ids
    Array of strings

    Performs the operation on the unique Fleet IDs specified. +This query currently accepts only 1 ID.

    +
    fleet_names
    Array of strings

    Performs the operation on the unique Fleet names specified. +Enter multiple names in comma-separated format. +For example, name01,name02. +This query currently accepts only 1 name.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Add members to a fleet

    Adds arrays to an existing fleet. This API needs to be run from the array that's joining the +fleet.

    +

    To add the current array to the fleet, specify its own array id or name, +as well as the fleet key generated on any array already in the fleet. +resource_type is remote-arrays. +The array's ID and name can be retrieved with a call to GET /arrays on the array.

    +
    query Parameters
    fleet_ids
    Array of strings

    Performs the operation on the unique Fleet IDs specified. +This query currently accepts only 1 ID.

    +
    fleet_names
    Array of strings

    Performs the operation on the unique Fleet names specified. +Enter multiple names in comma-separated format. +For example, name01,name02. +This query currently accepts only 1 name.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    Info about the members being added to fleet.

    +
    Array of objects (_fleetmemberpostMembers)

    Details about the members being added to fleet.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "members": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete fleet members

    Deletes the specified array(s) from the fleet. +Note that this will only succeed if the array(s) to be removed are not making use of any fleet +resources.

    +
    query Parameters
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    unreachable
    boolean

    If set to true, allows a one-sided disconnect when the connection +status is connecting instead of connected or partially connected. +If set to false, it works just like normal coordinated disconnect. +If not specified, defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Hardware

    Operational status is reported by most of the hardware components in an array, including the +chassis, controller, and storage shelf.

    +

    List hardware component information

    Displays a list of hardware slots and bays and status of installed components.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Modify visual identification

    Modifies the visual identification of a specified hardware component, and causing the ID LED to turn on or off.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    identify_enabled
    boolean

    State of an LED used to visually identify the component.

    +
    index
    integer <int32>

    Number that identifies the relative position of a hardware component within the array.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "identify_enabled": true,
    • "index": 1
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Host Groups

    Host groups implement consistent connections between a set of hosts and one or more volumes. +Connections are consistent in the sense that all hosts associated with a host group +address a volume connected to the group by the same LUN. Host groups are typically +used to provide a common view of storage volumes to the hosts in a clustered application.

    +

    List host groups

    Displays a list of host groups.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a host group and upsert tags

    Creates a host group in which the names query parameter is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (NonCopyableTag)

    The list of tags to be upserted with the object.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "tags": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a host group

    Deletes a host group in which the names query parameter is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a host group

    Modifies a host group in which the names query parameter is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    from_member_ids
    Array of strings

    Move the resource from the specified local member realm or array. +This should be a union of all local realms and arrays from which the resource should be removed. +Enter multiple IDs in a comma-separated format.

    +
    from_member_names
    Array of strings

    Move the resource from the specified local member realm or array. +This should be a union of all local realms and arrays to be removed from the specified resource. +Enter multiple names in a comma-separated format.

    +
    modify_resource_access
    string

    Describes how to modify a resource accesses of a resource when that resource is moved. +Possible values are: none, create, and delete. +The none value indicates that no resource access should be modified. +The create value is used when a resource is moving out of a realm into the array and it needs to +create a resource access of the moved resource to the realm from which it is moving. +The delete value is used when a resource that is moving from an array into a realm already has +a resource access into that realm. +This is a required parameter when a resource is being moved to another member.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    to_member_ids
    Array of strings

    The resource will be moved to the specified local member realm or array. +Enter multiple IDs in a comma-separated format.

    +
    to_member_names
    Array of strings

    The resource will be moved to the specified local member realm or array. +Enter multiple names in a comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The new name for the resource.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List host groups that are associated with hosts

    Displays a list of host groups that are associated with hosts.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a membership to a host group

    Create a membership between a host and a host group. Adding a membership to a host group +automatically connects the host to all volumes associated with the group. Multiple hosts can be +belong to a host group, but a host can only belong to one host group. Hosts can be added to host +groups at any time. The group_names and member_names parameters are required and must be set +together, and only one host group can be specified at a time.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a membership from a host group

    Deletes a membership from a host group. Removing a membership from a host group automatically +disconnects the host from all volumes associated with the group. +Hosts can be removed from host groups at any time. +The group_names and member_names parameters are required +and must be set together, and only one host group can be specified at a time.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List host group performance data

    Displays real-time and historical performance data, real-time latency data, and average I/O +sizes of all host groups, displayed both by host group and by total size across all host +groups. This data represents volumes that are connected to the host groups on the local +array and stretched volumes connected to the host groups on arrays that are connected by +synchronous replication.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ],
    • "total": [
      ]
    }

    List host group performance data by array

    Displays real-time and historical performance data, real-time latency data, and average I/O size +data. The data is displayed by total size across all host groups on each array and by individual +host group on each array. The displayed data represents the volumes that are connected to a host +group on the current array and the volumes that are connected to a host group on any remote +arrays that are visible to the current array.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ],
    • "total": [
      ]
    }

    List host groups that are members of protection groups

    Displays a list of host group members that belong to one or more protection groups.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a host group

    Creates a host group member and assigns to a protection group. +Members that are already in the protection group are not affected. +For asynchronous replication, only members of the same type can belong to a protection group. +The group_names parameter represents the name of the protection group, and +the member_names parameter represents the name of the host group. +The group_names and member_names parameters are required and must be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a host group from a protection group

    Deletes a host group member from a protection group. +After the member has been removed, it is no longer protected by the group. +Any protection group snapshots that were taken before the member was removed are not affected. +Removing a member from a protection group does not delete the member from the array, +and the member can be added back to the protection group at any time. +The group_names parameter represents the name of the protection group, and +the member_names parameter represents the name of the host group. +The group_names and member_names parameters are required and must be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List host group space information

    Displays provisioned size and physical storage consumption data for each host group.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ]
    }

    List tags

    Displays the list of tags on host group objects.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resource_destroyed
    boolean

    If set to true, returns only objects from destroyed resources. Returns an error if +the name of a live resource is specified in the resource_names query parameter. +If set to false, returns only objects from live resources. Returns an error if the +name of a destroyed resource is specified in the resource_names query parameter.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Delete tags

    Deletes specified tags on host group objects.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    keys
    Array of strings

    A comma-separated list of tag keys.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Update tags

    Updates tags.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    A list of tags to be created or, if one already exists, updated.

    +
    Array ()
    key
    string

    Key of the tag. Supports up to 64 Unicode characters.

    +
    namespace
    string

    Optional namespace of the tag. +Namespace identifies the category of the tag. Omitting the namespace +defaults to the namespace default. The pure&#42; namespaces are +reserved for plugins and integration partners. It is recommended +that customers avoid using reserved namespaces.

    +
    object (_fixedReference)
    value
    string

    Value of the tag. Supports up to 256 Unicode characters.

    +

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Hosts

    Hosts organize the storage network addresses (iSCSI Qualified Names, NVMe qualified names, or +Fibre Channel world wide names) of client computers to identify the host's intiators. Hosts also +control communications between clients and volumes. After a volume has been created, establish a +host-volume connection so that the host can read data from and write data to the volume.

    +

    List hosts

    Displays a list of hosts.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a host and upsert tags

    Creates a host for which the names query parameter is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (_chap)

    Challenge-Handshake Authentication Protocol (CHAP).

    +
    iqns
    Array of strings

    The iSCSI qualified name (IQN) associated with the host.

    +
    nqns
    Array of strings

    The NVMe Qualified Name (NQN) associated with the host.

    +
    personality
    string

    Determines how the system tunes the array to ensure that it works optimally with the host. +Set personality to the name of the host operating system or virtual memory system. +Valid values are aix, esxi, hitachi-vsp, hpux, +oracle-vm-server, solaris, and vms. +If your system is not listed as one of the valid host personalities, do not set the option. +By default, the personality is not set.

    +
    Array of objects (_reference)

    For synchronous replication configurations, sets a host's preferred array to specify which +array exposes active/optimized paths to that host. +Enter multiple preferred arrays in comma-separated format. +If a preferred array is set for a host, +then the other arrays in the same pod will expose active/non-optimized paths to that host. +If the host is in a host group, preferred_arrays cannot be set because host groups +have their own preferred arrays. +On a preferred array of a certain host, all the paths on all the ports +(for both the primary and secondary controllers) are set up as A/O (active/optimized) paths, +while on a non-preferred array, all the paths are A/N (Active/Non-optimized) paths.

    +
    Array of objects (NonCopyableTag)

    The list of tags to be upserted with the object.

    +
    vlan
    string

    The VLAN ID that the host is associated with. +If not set or set to any, the host can access any VLAN. +If set to untagged, the host can only access untagged VLANs. +If set to a number between 1 and 4094, +the host can only access the specified VLAN with that number.

    +
    wwns
    Array of strings

    The Fibre Channel World Wide Name (WWN) associated with the host.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "chap": {
      },
    • "iqns": [
      ],
    • "nqns": [
      ],
    • "personality": "string",
    • "preferred_arrays": [
      ],
    • "tags": [
      ],
    • "vlan": "1",
    • "wwns": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a host

    Deletes an existing host. All volumes that are connected to the host, +either through private or shared connections, +must be disconnected from the host before the host can be deleted. +The names query parameter is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a host

    Modifies an existing host, including its storage network addresses, CHAP, host personality, and +preferred arrays, or associate a host to a host group. +The names query parameter is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    from_member_ids
    Array of strings

    Move the resource from the specified local member realm or array. +This should be a union of all local realms and arrays from which the resource should be removed. +Enter multiple IDs in a comma-separated format.

    +
    from_member_names
    Array of strings

    Move the resource from the specified local member realm or array. +This should be a union of all local realms and arrays to be removed from the specified resource. +Enter multiple names in a comma-separated format.

    +
    modify_resource_access
    string

    Describes how to modify a resource accesses of a resource when that resource is moved. +Possible values are: none, create, and delete. +The none value indicates that no resource access should be modified. +The create value is used when a resource is moving out of a realm into the array and it needs to +create a resource access of the moved resource to the realm from which it is moving. +The delete value is used when a resource that is moving from an array into a realm already has +a resource access into that realm. +This is a required parameter when a resource is being moved to another member.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    to_member_ids
    Array of strings

    The resource will be moved to the specified local member realm or array. +Enter multiple IDs in a comma-separated format.

    +
    to_member_names
    Array of strings

    The resource will be moved to the specified local member realm or array. +Enter multiple names in a comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The new name for the resource.

    +
    add_iqns
    Array of strings

    Adds the specified iSCSI Qualified Names (IQNs) +to those already associated with the specified host.

    +
    add_nqns
    Array of strings

    Adds the specified NVMe Qualified Names (NQNs) +to those already associated with the specified host.

    +
    add_wwns
    Array of strings

    Adds the specified Fibre Channel World Wide Names (WWNs) +to those already associated with the specified host.

    +
    object (_chap)

    Challenge-Handshake Authentication Protocol (CHAP).

    +
    object (ReferenceNoId)

    The host group to which the host should be associated.

    +
    iqns
    Array of strings

    The iSCSI qualified name (IQN) associated with the host.

    +
    nqns
    Array of strings

    The NVMe Qualified Name (NQN) associated with the host.

    +
    personality
    string

    Determines how the system tunes the array to ensure that it works optimally with the host. +Set personality to the name of the host operating system or virtual memory system. +Valid values are aix, esxi, hitachi-vsp, hpux, +oracle-vm-server, solaris, and vms. +If your system is not listed as one of the valid host personalities, do not set the option. +By default, the personality is not set.

    +
    Array of objects (_reference)

    For synchronous replication configurations, sets a host's preferred array to specify which +array exposes active/optimized paths to that host. +Enter multiple preferred arrays in comma-separated format. +If a preferred array is set for a host, +then the other arrays in the same pod will expose active/non-optimized paths to that host. +If the host is in a host group, preferred_arrays cannot be set because host groups +have their own preferred arrays. +On a preferred array of a certain host, all the paths on all the ports +(for both the primary and secondary controllers) are set up as A/O (active/optimized) paths, +while on a non-preferred array, all the paths are A/N (Active/Non-optimized) paths.

    +
    remove_iqns
    Array of strings

    Disassociates the specified iSCSI Qualified Names (IQNs) from the specified host.

    +
    remove_nqns
    Array of strings

    Disassociates the specified NVMe Qualified Names (NQNs) from the specified host.

    +
    remove_wwns
    Array of strings

    Disassociates the specified Fibre Channel World Wide Names (WWNs) from the specified host.

    +
    vlan
    string

    The VLAN ID that the host is associated with. +If not set, there is no change in VLAN. +If set to any, the host can access any VLAN. +If set to untagged, the host can only access untagged VLANs. +If set to a number between 1 and 4094, +the host can only access the specified VLAN with that number.

    +
    wwns
    Array of strings

    The Fibre Channel World Wide Name (WWN) associated with the host.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "add_iqns": [
      ],
    • "add_nqns": [
      ],
    • "add_wwns": [
      ],
    • "chap": {
      },
    • "host_group": {
      },
    • "iqns": [
      ],
    • "nqns": [
      ],
    • "personality": "string",
    • "preferred_arrays": [
      ],
    • "remove_iqns": [
      ],
    • "remove_nqns": [
      ],
    • "remove_wwns": [
      ],
    • "vlan": "1",
    • "wwns": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List hosts that are associated with host groups

    Displays a list of hosts that are associated with host groups.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a membership to a host group

    Creates a membership to a host group. +Creating a membership to a host group automatically +connects the host to all volumes associated with the group. +Multiple hosts can be belong to a host group, +but a host can only belong to one host group. +Hosts can be added to host groups at any time. +The group_names and member_names parameters are required +and must be set together, and only one host group can be specified at a time.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a membership from a host group

    Deletes a membership from a host group. +Deleting a membership from a host group automatically +disconnects the host from all volumes associated with the group. +Hosts can be deleted from host groups at any time. +The group_names and member_names parameters are required +and must be set together, and only one host group can be specified at a time.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List host performance data

    Displays real-time and historical performance data, real-time latency data, and average I/O +sizes across all hosts, displayed by host and by total size across all hosts. This data +represents volumes that are connected to the hosts on the local array and stretched volumes +connected to the hosts on any arrays that are connected by synchronous replication.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ],
    • "total": [
      ]
    }

    List host performance balance

    Displays the I/O balance statistics for host paths.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ]
    }

    List host performance data by array

    Displays real-time and historical performance data, real-time latency data, and average I/O size +data. The data is displayed by total size across all hosts on each array and by individual host +on each array. The displayed data represents the volumes that are connected to a host on the +current array and the volumes that are connected to a host on any remote arrays that are visible +to the current array.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ],
    • "total": [
      ]
    }

    List hosts that are members of protection groups

    Displays a list of host members that belong to one or more protection groups.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a host

    Creates a host member and adds it to a protection group. +Members that are already in the protection group are not affected. +For asynchronous replication, only members of the same type can belong to a protection group. +The group_names parameter represents the name of the protection group, and +the member_names parameter represents the name of the host. +The group_names and member_names parameters are required and must be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a host from a protection group

    Deletes a host member from a protection group. +After the member has been removed, it is no longer protected by the group. +Any protection group snapshots that were taken before the member was removed are not affected. +Removing a member from a protection group does not delete the member from the array, +and the member can be added back to the protection group at any time. +The group_names parameter represents the name of the protection group, and +the member_names parameter represents the name of the host. +The group_names and member_names parameters are required and must be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List host space information

    Displays provisioned size and physical storage consumption data for each host.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ]
    }

    List tags

    Displays the list of tags on host objects.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resource_destroyed
    boolean

    If set to true, returns only objects from destroyed resources. Returns an error if +the name of a live resource is specified in the resource_names query parameter. +If set to false, returns only objects from live resources. Returns an error if the +name of a destroyed resource is specified in the resource_names query parameter.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Delete tags

    Deletes specified tags on host objects.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    keys
    Array of strings

    A comma-separated list of tag keys.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Update tags

    Updates tags.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    A list of tags to be created or, if one already exists, updated.

    +
    Array ()
    key
    string

    Key of the tag. Supports up to 64 Unicode characters.

    +
    namespace
    string

    Optional namespace of the tag. +Namespace identifies the category of the tag. Omitting the namespace +defaults to the namespace default. The pure&#42; namespaces are +reserved for plugins and integration partners. It is recommended +that customers avoid using reserved namespaces.

    +
    object (_fixedReference)
    value
    string

    Value of the tag. Supports up to 256 Unicode characters.

    +

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    KMIP

    The Key Management Interoperability Protocol (KMIP) server is used in combination with the Pure +Storage Rapid Data Locking (RDL) feature and EncryptReduce feature to further secure the +encrypted data on a FlashArray.

    +

    List KMIP server objects

    Displays the list of KMIP server objects.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create KMIP server object

    Creates KMIP server objects.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    ca_certificate
    string <= 3000 characters

    The text of the CA certificate for the KMIP server.

    +
    object (ReferenceNoId)

    The certificate used to verify FlashArray authenticity to the KMIP servers.

    +
    uris
    Array of strings

    List of URIs for the configured KMIP servers.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
    • "certificate": {
      },
    • "uris": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete KMIP server object

    Deletes KMIP server objects.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify KMIP attributes

    Modifies one or more attributes of KMIP server objects.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    ca_certificate
    string <= 3000 characters

    The text of the CA certificate for the KMIP server.

    +
    object (ReferenceNoId)

    The certificate used to verify FlashArray authenticity to the KMIP servers.

    +
    uris
    Array of strings

    List of URIs for the configured KMIP servers.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
    • "certificate": {
      },
    • "uris": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Lists KMIP connection tests

    Displays communication data between a FlashArray and KMIP server.

    +
    query Parameters
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Log Targets

    Log Targets to be used to send management or data audit logs.

    +

    List log targets

    Displays a list of configured log targets.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    List file log targets

    Displays a list of configured file log targets.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create file log target

    Creates a new file log target.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    object (ReferenceWithType)

    Directory name to be used as log target.

    +
    keep_for
    integer <int64> >= 86400000

    Specifies the period that audit logs are retained before they are deleted, +in milliseconds. +Default value is null which means size based retention does not apply. +Use 0 to reset the value to null. +At least one of the keep_for or keep_size parameters is required, +and they can be set together.

    +
    keep_size
    integer <int64> >= 1000000

    Specifies the maximum size of audit logs to be retained. +Measured in bytes. When exceeded, older logs will be deleted. +Default value is null which means size-based retention does not apply. +Use 0 to reset the value to null.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "directory": {
      },
    • "keep_for": 86400000,
    • "keep_size": 1000000
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete file log target

    Deletes a configured file log target.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify file log target

    Modifies the URI of a configured file log target.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    object (ReferenceWithType)

    Directory name to be used as log target.

    +
    keep_for
    integer <int64> >= 86400000

    Specifies the period that audit logs are retained before they are deleted, +in milliseconds. +Default value is null which means size based retention does not apply. +Use 0 to reset the value to null. +At least one of the keep_for or keep_size parameters is required, +and they can be set together.

    +
    keep_size
    integer <int64> >= 1000000

    Specifies the maximum size of audit logs to be retained. +Measured in bytes. When exceeded, older logs will be deleted. +Default value is null which means size-based retention does not apply. +Use 0 to reset the value to null.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "directory": {
      },
    • "keep_for": 86400000,
    • "keep_size": 1000000
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List syslog servers

    Displays a list of configured syslog servers.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create syslog server

    Creates a new syslog server.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    services
    Array of strings

    Valid values are data-audit and management. +If not specified, defaults to management.

    +
    uri
    string

    The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "services": [
      ],
    • "uri": "tcp://my.syslogserver.com"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete syslog server

    Deletes a configured syslog server and stop forwarding syslog messages.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify syslog server

    Modifies the URI and services of a configured syslog server.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    services
    Array of strings

    Valid values are data-audit and management. +If not specified, defaults to management.

    +
    uri
    string

    The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "services": [
      ],
    • "uri": "tcp://my.syslogserver.com"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List syslog settings

    Displays syslog settings. Values include continuation_token, items, +more_items_remaining, and total_item_count.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Modify syslog settings

    Modifies syslog settings. Values include continuation_token, items, +more_items_remaining, and total_item_count.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ca_certificate
    string

    The certificate of the certificate authority (CA) that signed the directory servers' +certificate(s), which is used to validate the authenticity of the configured servers.

    +
    logging_severity
    string

    Returns the configured logging severity threshold for which events will +be forwarded to the configured syslog servers. Default configuration is +info level severity. +Valid values are debug, info, and notice.

    +
    tls_audit_enabled
    boolean

    Returns a value of true if messages that are necessary in order to +audit TLS negotiations performed by the array are forwarded to the +configured syslog servers.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "ca_certificate": "string",
    • "logging_severity": "string",
    • "tls_audit_enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List syslog server test results

    Displays syslog server test results, which indicate whether the syslog is working and configured correctly.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ]
    }

    Maintenance Windows

    During a maintenance window, alerts are suppressed that are related to connections, paths, +ports, and other resources that are down during maintenance.

    +

    List maintenance window details

    Displays maintenance window details, including start time, end time, and maintenance type.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create a maintenance window

    Creates a maintenance window that suppresses alerts for a specified period of time. +A maintenance window can be manually closed at any time. +The names and timeout parameters are required. Set the names parameter to environment.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    timeout
    integer <int32>

    The specified length of time that alerts are suppressed during a maintenance window, +measured in milliseconds. +The maintenance window timeout value must be between 60000 (1 minute) +and 86400000 (24 hours). +The value entered is rounded down to the nearest minute. +The names and timeout parameters must be set together, and the names parameter +must be set to environment.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "timeout": 3600000
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete maintenance window

    Deletes an open maintenance window before its scheduled end (expire) time. +The names parameter is required and must be set to environment.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Network Interfaces

    Manages the interfaces and the network connection attributes of the array.

    +

    List network interfaces

    Displays all network interfaces for all controllers on the array.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create network interface

    Creates a network interface on a controller on the array.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (_networkinterfacepostEth)

    Ethernet network interface properties.

    +
    services
    Array of strings

    The services provided by the specified network interface or Fibre Channel port.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "eth": {
      },
    • "services": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete network interface

    Deletes a network interface on a controller.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify network interface

    Modifies a network interface on a controller.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    enabled
    boolean

    Returns a value of true if the specified network interface or Fibre Channel port is +enabled. Returns a value of false if the specified network interface or Fibre Channel +port is disabled.

    +
    object (_networkinterfacepatchEth)

    Ethernet network interface properties.

    +
    override_npiv_check
    boolean

    N-Port ID Virtualization (NPIV) requires a balanced configuration of Fibre Channel ports +configured for SCSI on both controllers. Enabling or Disabling a Fibre Channel port +configured for SCSI might cause the NPIV status to change from enabled to disabled or +vice versa. Set this option to proceed with enabling or disabling the port.

    +
    services
    Array of strings

    The services provided by the specified network interface or Fibre Channel port.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "enabled": true,
    • "eth": {
      },
    • "override_npiv_check": true,
    • "services": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List network interface neighbors

    Displays all neighbors for all network interfaces on the array.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    local_port_names
    Array of strings

    Performs the operation on the unique local port name specified. +Enter multiple names in comma-separated format. +For example, ct0.eth0,ct1.eth0.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    List network performance statistics

    Displays network statistics, historical bandwidth, and error reporting for all +specified network interfaces.

    +
    query Parameters
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "total": [
      ]
    }

    List SFP port details

    Displays Ethernet and Fibre Channel SFP details.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Offloads

    The offload feature enables system administrators to replicate point-in-time volume snapshots +from the array to an external storage system for long-term retention. +Each offload target represents an external storage system, such as an Azure Blob container, +NFS device, or S3 bucket, to where Purity//FA volume snapshots can be replicated.

    +

    List offload targets

    Displays a list of offload targets that are connected to the array.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    protocol
    string

    Protocol type. Valid values are azure, google-cloud, nfs, and s3.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ],
    • "total": [
      ]
    }

    Create offload target

    Creates an offload target, connecting it to an array. +Before you can connect to, manage, and replicate to an offload target, the Purity Run app must +be installed.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    initialize
    boolean

    If set to true, initializes the Amazon S3/Azure Blob container/Google Cloud Storage +in preparation for offloading. The parameter must be set to true +if this is the first time the array is connecting to the offload target.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (OffloadAzure)

    Microsoft Azure Blob storage settings.

    +
    object (OffloadGoogleCloud)

    Google Cloud Storage settings.

    +
    object (OffloadNfs)

    NFS settings. +Deprecated from version 6.6.0 onwards - Contact support for additional information.

    +
    object (OffloadS3)

    S3 settings.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "azure": {
      },
    • "google-cloud": {
      },
    • "nfs": {
      },
    • "s3": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete offload target

    Deletes an offload target.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Presets

    Presets are reusable templates that provision resources.

    +

    List workload presets

    Displays a list of workload presets.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Update a workload preset

    Updates a workload preset by replacing it with the new contents in preset. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Only one value is supported.

    +
    names
    Array of strings

    Performs the operation on the unique resource names specified. +Only one value is supported.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    A user-specified name. +The name must be locally unique and can be changed.

    +
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    description
    string

    A brief description of the workload the preset will configure. +Supports up to 1KB of unicode characters.

    +
    Array of objects (_presetWorkloadParameter)

    The parameters to prompt the user when they deploy workloads from the preset.

    +
    Array of objects (_presetWorkloadPeriodicReplicationConfiguration) <= 2 items

    The periodic replication configurations that can be applied to storage resources (such +as volumes) within the preset.

    +
    required
    Array of objects (_presetWorkloadPlacementConfiguration) 1 items

    The placement configurations that can be applied to storage resources (such as volumes) +within the preset. All storage resources associated with the same placement will be +colocated on the same array.

    +
    Array of objects (_presetWorkloadQosConfiguration) <= 5 items

    The QoS configurations that can be applied to storage resources (such as volumes) within +the preset.

    +
    Array of objects (_presetWorkloadSnapshotConfiguration) <= 2 items

    The snapshot configurations that can be applied to storage resources (such as volumes) +within the preset.

    +
    required
    Array of objects (_presetWorkloadVolumeConfiguration) [ 1 .. 5 ] items

    The volumes that will be provisioned by the preset.

    +
    Array of objects (_presetWorkloadWorkloadTag)

    The tags that will be associated with workloads provisioned by the preset.

    +
    workload_type
    required
    string

    The type of workload the preset will configure. Valid values include VDI, File, +MySQL etc.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "context": { },
    • "description": "string",
    • "parameters": [
      ],
    • "periodic_replication_configurations": [
      ],
    • "placement_configurations": [
      ],
    • "qos_configurations": [
      ],
    • "snapshot_configurations": [
      ],
    • "volume_configurations": [
      ],
    • "workload_tags": [
      ],
    • "workload_type": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Create a workload preset

    Creates one workload preset.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    required
    Array of strings

    Performs the operation on the unique resource names specified. +Only one value is supported.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    description
    string

    A brief description of the workload the preset will configure. +Supports up to 1KB of unicode characters.

    +
    Array of objects (_presetWorkloadParameter)

    The parameters to prompt the user when they deploy workloads from the preset.

    +
    Array of objects (_presetWorkloadPeriodicReplicationConfiguration) <= 2 items

    The periodic replication configurations that can be applied to storage resources (such +as volumes) within the preset.

    +
    required
    Array of objects (_presetWorkloadPlacementConfiguration) 1 items

    The placement configurations that can be applied to storage resources (such as volumes) +within the preset. All storage resources associated with the same placement will be +colocated on the same array.

    +
    Array of objects (_presetWorkloadQosConfiguration) <= 5 items

    The QoS configurations that can be applied to storage resources (such as volumes) within +the preset.

    +
    Array of objects (_presetWorkloadSnapshotConfiguration) <= 2 items

    The snapshot configurations that can be applied to storage resources (such as volumes) +within the preset.

    +
    required
    Array of objects (_presetWorkloadVolumeConfiguration) [ 1 .. 5 ] items

    The volumes that will be provisioned by the preset.

    +
    Array of objects (_presetWorkloadWorkloadTag)

    The tags that will be associated with workloads provisioned by the preset.

    +
    workload_type
    required
    string

    The type of workload the preset will configure. Valid values include VDI, File, +MySQL etc.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "description": "string",
    • "parameters": [
      ],
    • "periodic_replication_configurations": [
      ],
    • "placement_configurations": [
      ],
    • "qos_configurations": [
      ],
    • "snapshot_configurations": [
      ],
    • "volume_configurations": [
      ],
    • "workload_tags": [
      ],
    • "workload_type": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a workload preset

    Deletes a workload preset permanently. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Only one value is supported.

    +
    names
    Array of strings

    Performs the operation on the unique resource names specified. +Only one value is supported.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a workload preset

    Modifies a workload preset by overriding the fields specified in preset. +To rename a workload preset, set name to the new name.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Only one value is supported.

    +
    names
    Array of strings

    Performs the operation on the unique resource names specified. +Only one value is supported.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The new name for the resource.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Pods

    Synchronous replication is managed through pods. A pod representing a collection of protection +groups and volumes is created on one array and stretched to another array, resulting in fully +synchronized writes between the two arrays. A pod can contain a mix of volumes, and protection +groups with member volumes. Writes to the pod coming into either array are immediately +synchronized and seen on both arrays.

    +

    List pods

    Displays a list of pods that are stretched to this array.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ],
    • "total": [
      ]
    }

    Create a pod

    Creates a pod on the local array. +Each pod must be given a unique name across the arrays to which they are stretched. +A pod cannot be stretched to an array that already contains a pod with the same name. +After a pod has been created, add volumes and protection groups, +and then stretch the pod to another connected array.

    +
    query Parameters
    allow_throttle
    boolean

    If set to true, allows operation to fail if array health is not optimal.

    +
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_reference)

    Determines which array within a stretched pod should be given priority to stay online +should the arrays ever lose contact with each other. The current array and +any peer arrays that are connected to the current array for synchronous replication can be +added to a pod for failover preference. +By default, failover_preferences=null, +meaning no arrays have been configured for failover preference. +Enter multiple arrays in comma-separated format. +To clear the list of failover preferences, set to an empty list [].

    +
    quota_limit
    integer <int64> [ 1048576 .. 4503599627370496 ]

    The logical quota limit of the pod, measured in bytes. Must be a multiple of 512.

    +
    object (Reference)

    The source pod from where data is cloned to create the new pod.

    +
    Array of objects (Tag)

    The list of tags to be upserted with the object.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "failover_preferences": [
      ],
    • "quota_limit": 1048576,
    • "source": {
      },
    • "tags": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a pod

    Deletes a pod that has been destroyed and is pending eradication. +Eradicated pods cannot be recovered. Pods are destroyed using the PATCH method. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    eradicate_contents
    boolean

    Set to true to eradicate contents (e.g., volumes, protection groups, snapshots) and containers +(e.g., realms, pods, volume groups). This enables you to eradicate containers with contents.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a pod

    Modifies pod details.

    +
    query Parameters
    abort_quiesce
    boolean

    Set to true to promote the pod when the pod-replica-link is in the quiescing state and +abort when waiting for the pod-replica-link to complete the quiescing operation.

    +
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    destroy_contents
    boolean

    Set to true to destroy contents (e.g., volumes, protection groups, snapshots) and containers +(e.g., realms, pods, volume groups), including eradicating containers with content.

    +
    from_member_ids
    Array of strings

    Move the resource from the specified local member realm or array. +This should be a union of all local realms and arrays from which the resource should be removed. +Enter multiple IDs in a comma-separated format.

    +
    from_member_names
    Array of strings

    Move the resource from the specified local member realm or array. +This should be a union of all local realms and arrays to be removed from the specified resource. +Enter multiple names in a comma-separated format.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    move_with_host_group_names
    Array of strings

    The host groups to be moved together with the pods to the specified local member realm or array. +All the hosts in the host groups will also be moved. +Enter multiple names in a comma-separated format.

    +
    move_with_host_names
    Array of strings

    The hosts to be moved together with the pods to the specified local member realm or array. +Enter multiple names in a comma-separated format.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    promote_from
    string

    The undo-demote pod that should be used to promote the pod. +After the pod has been promoted, it will have the same data as the +undo-demote pod and the undo-demote pod will be eradicated.

    +
    quiesce
    boolean

    Set to true to demote the pod after the pod-replica-link goes into quiesced state and allow +the pod to become a target of the remote pod. +This ensures that all local data has been replicated to the remote pod before the pod is demoted.

    +
    skip_quiesce
    boolean

    Set to true to demote the pod without quiescing the pod-replica-link and allow the pod to +become a target of the remote pod. +This stops all pending replication to the remote pod.

    +
    to_member_ids
    Array of strings

    The resource will be moved to the specified local member realm or array. +Enter multiple IDs in a comma-separated format.

    +
    to_member_names
    Array of strings

    The resource will be moved to the specified local member realm or array. +Enter multiple names in a comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    A user-specified name. +The name must be locally unique and can be changed.

    +
    destroyed
    boolean

    If set to true, the pod has been destroyed and is pending eradication. +The time_remaining value displays the amount of time left +until the destroyed pod is permanently eradicated. +A pod can only be destroyed if it is empty, so before destroying a pod, +ensure all volumes and protection groups inside the pod +have been either moved out of the pod or destroyed. +A stretched pod cannot be destroyed unless you unstretch it first. +Before the time_remaining period has elapsed, the destroyed pod can be recovered +by setting destroyed=false. +Once the time_remaining period has elapsed, +the pod is permanently eradicated and can no longer be recovered.

    +
    Array of objects (_reference)

    Determines which array within a stretched pod should be given priority to stay online +should the arrays ever lose contact with each other. The current array and +any peer arrays that are connected to the current array for synchronous replication can be +added to a pod for failover preference. +By default, failover_preferences=null, +meaning no arrays have been configured for failover preference. +Enter multiple arrays in comma-separated format.

    +
    ignore_usage
    boolean

    Set to true to set a quota_limit that is lower than the existing usage. +This ensures that no new volumes can be created until the existing usage +drops below the quota_limit. +If not specified, defaults to false.

    +
    mediator
    string

    Sets the URL of the mediator for this pod, replacing the URL of the current mediator. +By default, the Pure1 Cloud Mediator (purestorage) serves as the mediator.

    +
    quota_limit
    integer <int64> [ 1048576 .. 4503599627370496 ]

    The logical quota limit of the pod, measured in bytes. Must be a multiple of 512.

    +
    requested_promotion_state
    string

    Patch requested_promotion_state to demoted to demote the pod so that it can be used as +a link target for continuous replication between pods. +Demoted pods do not accept write requests, and a destroyed version of the pod with +undo-demote appended to the pod name is created on the array with the state of the pod +when it was in the promoted state. +Patch requested_promotion_state to promoted to start the process of promoting the pod. +The promotion_status indicates when the pod has been successfully promoted. +Promoted pods stop incorporating replicated data from the source pod and start accepting +write requests. +The replication process does not stop when the source pod continues replicating data to the +pod. +The space consumed by the unique replicated data is tracked by the space.journal field +of the pod.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "destroyed": true,
    • "failover_preferences": [
      ],
    • "ignore_usage": true,
    • "mediator": "https://mediator.cloud-support.purestorage.com",
    • "quota_limit": 1048576,
    • "requested_promotion_state": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List pods and their the array members

    Displays a list of pods and the local and remote arrays over which the pods are stretched. +Pods with realm members will not be returned. +The optional group_names parameter represents the name of the pod. +The optional member_names parameter +represents the name of the array over which the pod is stretched. +(Deprecated) Use pods/members instead.)

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Creates a pod to be stretched to an array

    Creates a pod to be stretched to an array. +When a pod is stretched to an array, +the data in the arrays over which the pod is stretched is synchronously replicated. +The group_names parameter represents the name of the pod to be stretched. +The member_names parameter represents the name of the array over which the pod is +to be stretched. +The group_names and member_names parameters are required and must be set together. +(Deprecated) Use pods/members instead.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a pod that was stretched to an array

    Deletes a pod that was stretchd to an array, collapsing the pod to a single array. +Unstretch a pod from an array when the volumes within the stretched pod +no longer need to be synchronously replicated between the two arrays. +After a pod has been unstretched, synchronous replication stops. +A destroyed version of the pod with 'restretch' appended to the pod name +is created on the array that no longer has the pod. +The restretched pod represents a point-in-time snapshot of the pod, +just before it was unstretched. +The restretch pod enters an eradication pending period +starting from the time that the pod was unstretched. +A restretched pod can be cloned or destroyed, but it cannot be explicitly recovered. +The group_names parameter represents the name of the pod to be unstretched. +The member_names parameter represents the name of the array from which the pod is +to be unstretched. +The group_names and member_names parameters are required and must be set together. +(Deprecated) Use pods/members instead.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    with_unknown
    boolean

    If set to true, unstretches the specified pod from the specified array by force. +Use the with_unknown parameter in the following rare event: the local array goes offline +while the pod is still stretched across two arrays, +the status of the remote array becomes unknown, +and there is no guarantee that the pod is online elsewhere.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List pods and their members

    Displays a list of pods and the local and remote members over which the pods are stretched. +Currently either array or realm is supported as member.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    pod_ids
    Array of strings

    A comma-separated list of pod IDs.

    +
    pod_names
    Array of strings

    Performs the operation on the unique pod name specified. +Enter multiple names in comma-separated format. For example, pod01,pod02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Creates a pod to be stretched to a member

    Creates a pod to be stretched to a member. +When a pod is stretched to an array, +the data in the arrays over which the pod is stretched is synchronously replicated. +The member_names or member_ids parameter represents the array over which the pod is +to be stretched. +Both pod and member must be specified by name or ID.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    pod_ids
    Array of strings

    A comma-separated list of pod IDs.

    +
    pod_names
    Array of strings

    Performs the operation on the unique pod name specified. +Enter multiple names in comma-separated format. For example, pod01,pod02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a member from a pod

    Deletes a stretched pod from an array, collapsing the pod to a member array. +Unstretch a pod from an array when the volumes within the stretched pod +no longer need to be synchronously replicated between the two members. +After a pod has been unstretched, synchronous replication stops. +A destroyed version of the pod with 'restretch' appended to the pod name +is created on the member that no longer has the pod. +The restretched pod represents a point-in-time snapshot of the pod, +just before it was unstretched. +The restretched pod enters an eradication pending period +starting from the time that the pod was unstretched. +A restretched pod can be cloned or destroyed, but it cannot be explicitly recovered. +The member_names parameter represents the name of the array from which the pod is +to be unstretched. +Both pod and member must be specified by name or ID.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    pod_ids
    Array of strings

    A comma-separated list of pod IDs.

    +
    pod_names
    Array of strings

    Performs the operation on the unique pod name specified. +Enter multiple names in comma-separated format. For example, pod01,pod02.

    +
    with_unknown
    boolean

    If set to true, unstretches the specified pod from the specified array by force. +Use the with_unknown parameter in the following rare event: the local array goes offline +while the pod is still stretched across two arrays, +the status of the remote array becomes unknown, +and there is no guarantee that the pod is online elsewhere.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List pod performance data

    Displays real-time and historical performance data, real-time latency data, +and average I/O sizes across all pods, displayed both by pod and as a total across all pods.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    protocol
    string

    Protocol type. Valid values are nfs, smb, and all.

    +
    protocol_group
    string

    Protocol group type. Valid values are block, file, and all.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ],
    • "total": [
      ]
    }

    List pod performance data by array

    Displays real-time and historical performance data, real-time latency data, +and average I/O size data. +The data is displayed as a total across all pods on the local array and by individual pod.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    protocol
    string

    Protocol type. Valid values are nfs, smb, and all.

    +
    protocol_group
    string

    Protocol group type. Valid values are block, file, and all.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ],
    • "total": [
      ]
    }

    List pod replication performance data

    Displays pod replication performance data. +The data returned is the real-time and historical performance data for each replication type +at the pod level. Values include continuous, periodic, resync, and sync.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, only return the aggregate value of all items after filtering. +For real-time performance, the values are aggregated for the latest timestamp. +For historical performance, the values are aggregated for each timestamp from +start_time to end_time. Where it makes more sense, the average value is +displayed instead. The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "total": [
      ],
    • "errors": [
      ]
    }

    List pod replication performance data by array

    Displays pod replication performance data, organized by array. +The data returned is the real-time and historical performance data for each replication type +at the pod level. Values include continuous, periodic, resync, and sync.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "total": [
      ],
    • "errors": [
      ]
    }

    List pod space information

    Displays provisioned size and physical storage consumption data for each pod on the +local array.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ],
    • "total": [
      ]
    }

    List tags

    Displays the list of tags.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resource_destroyed
    boolean

    If set to true, returns only objects from destroyed resources. Returns an error if +the name of a live resource is specified in the resource_names query parameter. +If set to false, returns only objects from live resources. Returns an error if the +name of a destroyed resource is specified in the resource_names query parameter.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Delete tags

    Deletes specified tags.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    keys
    Array of strings

    A comma-separated list of tag keys.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces. Only one namespace is allowed per delete request.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Update tags

    Updates tags for all specified objects.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    A list of tags to be created or, if already existing, updated.

    +
    Array ()
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    copyable
    boolean

    Specifies whether or not to include the tag when copying the parent resource. +If set to true, the tag is included in resource copying. +If set to false, the tag is not included. +If not specified, defaults to true.

    +
    key
    string

    Key of the tag. Supports up to 64 Unicode characters.

    +
    namespace
    string

    Optional namespace of the tag. +Namespace identifies the category of the tag. Omitting the namespace +defaults to the namespace default. The pure&#42; namespaces are +reserved for plugins and integration partners. It is recommended +that customers avoid using reserved namespaces.

    +
    object (_fixedReference)
    value
    string

    Value of the tag. Supports up to 256 Unicode characters.

    +

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Create an attempt to clone a pod

    Creates an attempt to clone a pod on the local array without actually cloning it +to test whether the pod can be successfully cloned. This action does not suppport pod creation.

    +
    query Parameters
    allow_throttle
    boolean

    If set to true, allows operation to fail if array health is not optimal.

    +
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_reference)

    Determines which array within a stretched pod should be given priority to stay online +should the arrays ever lose contact with each other. The current array and +any peer arrays that are connected to the current array for synchronous replication can be +added to a pod for failover preference. +By default, failover_preferences=null, +meaning no arrays have been configured for failover preference. +Enter multiple arrays in comma-separated format. +To clear the list of failover preferences, set to an empty list [].

    +
    quota_limit
    integer <int64> [ 1048576 .. 4503599627370496 ]

    The logical quota limit of the pod, measured in bytes. Must be a multiple of 512.

    +
    object (Reference)

    The source pod from where data is cloned to create the new pod.

    +
    Array of objects (Tag)

    The list of tags to be upserted with the object.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "failover_preferences": [
      ],
    • "quota_limit": 1048576,
    • "source": {
      },
    • "tags": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List pod replica links

    Displays the list of pod replica links that are configured between arrays.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    local_pod_ids
    Array of strings

    A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the local_pod_names query parameter.

    +
    local_pod_names
    Array of strings

    A comma-separated list of local pod names. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the local_pod_ids query parameter.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    remote_ids
    Array of strings

    A comma-separated list of remote array IDs. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_names query parameter.

    +
    remote_names
    Array of strings

    A comma-separated list of remote array names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_ids query parameter.

    +
    remote_pod_ids
    Array of strings

    A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the remote_pod_names query parameter.

    +
    remote_pod_names
    Array of strings

    A comma-separated list of remote pod names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_pod_ids query parameter.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create pod replica links

    Creates pod replica links between two arrays. The local_pod_names and remote_pod_names are required. Valid values are replicating, baselining, paused, unhealthy, quiescing, and quiesced. A status of replicating indicates that the source array is replicating to the target array. A status of baselining indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the baselining status to recur. A status of paused indicates that data transfer between objects has stopped. A status of unhealthy indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of quiescing indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of quiesced indicates that the source pod has been demoted and all changes have been replicated to the target pod.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    local_pod_ids
    Array of strings

    A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the local_pod_names query parameter.

    +
    local_pod_names
    Array of strings

    A comma-separated list of local pod names. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the local_pod_ids query parameter.

    +
    remote_ids
    Array of strings

    A comma-separated list of remote array IDs. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_names query parameter.

    +
    remote_names
    Array of strings

    A comma-separated list of remote array names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_ids query parameter.

    +
    remote_pod_ids
    Array of strings

    A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the remote_pod_names query parameter.

    +
    remote_pod_names
    Array of strings

    A comma-separated list of remote pod names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_pod_ids query parameter.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete pod replica links

    Deletes pod replica links. The local_pod_names and remote_pod_names are required. Valid values are replicating, baselining, paused, unhealthy, quiescing, and quiesced. A status of replicating indicates that the source array is replicating to the target array. A status of baselining indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the baselining status to recur. A status of paused indicates that data transfer between objects has stopped. A status of unhealthy indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of quiescing indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of quiesced indicates that the source pod has been demoted and all changes have been replicated to the target pod.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    local_pod_ids
    Array of strings

    A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the local_pod_names query parameter.

    +
    local_pod_names
    Array of strings

    A comma-separated list of local pod names. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the local_pod_ids query parameter.

    +
    remote_pod_ids
    Array of strings

    A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the remote_pod_names query parameter.

    +
    remote_pod_names
    Array of strings

    A comma-separated list of remote pod names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_pod_ids query parameter.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify pod replica links

    Modifies pod replica links. The local_pod_names and remote_pod_names are required. Valid values are replicating, baselining, paused, unhealthy, quiescing, and quiesced. A status of replicating indicates that the source array is replicating to the target array. A status of baselining indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the baselining status to recur. A status of paused indicates that data transfer between objects has stopped. A status of unhealthy indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of quiescing indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of quiesced indicates that the source pod has been demoted and all changes have been replicated to the target pod.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    local_pod_ids
    Array of strings

    A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the local_pod_names query parameter.

    +
    local_pod_names
    Array of strings

    A comma-separated list of local pod names. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the local_pod_ids query parameter.

    +
    remote_ids
    Array of strings

    A comma-separated list of remote array IDs. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_names query parameter.

    +
    remote_names
    Array of strings

    A comma-separated list of remote array names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_ids query parameter.

    +
    remote_pod_ids
    Array of strings

    A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the remote_pod_names query parameter.

    +
    remote_pod_names
    Array of strings

    A comma-separated list of remote pod names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_pod_ids query parameter.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    paused
    boolean

    Returns a value of true if the replica link is to be created in a paused state. +Returns a value of false if the replica link is to be created not in a paused state. +If not specified, defaults to false.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "paused": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List pod replica link lag

    Displays the lag in milliseconds that the replication target is behind the source. This is the time difference between the current time and the recovery point.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    local_pod_ids
    Array of strings

    A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the local_pod_names query parameter.

    +
    local_pod_names
    Array of strings

    A comma-separated list of local pod names. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the local_pod_ids query parameter.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    remote_ids
    Array of strings

    A comma-separated list of remote array IDs. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_names query parameter.

    +
    remote_names
    Array of strings

    A comma-separated list of remote array names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_ids query parameter.

    +
    remote_pod_ids
    Array of strings

    A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the remote_pod_names query parameter.

    +
    remote_pod_names
    Array of strings

    A comma-separated list of remote pod names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_pod_ids query parameter.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    <no summary>

    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    local_pod_ids
    Array of strings

    A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the local_pod_names query parameter.

    +
    local_pod_names
    Array of strings

    A comma-separated list of local pod names. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the local_pod_ids query parameter.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    remote_ids
    Array of strings

    A comma-separated list of remote array IDs. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_names query parameter.

    +
    remote_names
    Array of strings

    A comma-separated list of remote array names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_ids query parameter.

    +
    remote_pod_ids
    Array of strings

    A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the remote_pod_names query parameter.

    +
    remote_pod_names
    Array of strings

    A comma-separated list of remote pod names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_pod_ids query parameter.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, only return the aggregate value of all items after filtering. +For real-time performance, the values are aggregated for the latest timestamp. +For historical performance, the values are aggregated for each timestamp from +start_time to end_time. Where it makes more sense, the average value is +displayed instead. The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "total": [
      ],
    • "errors": [
      ]
    }

    List policy mappings

    Displays a list of policy mappings.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    local_pod_ids
    Array of strings

    A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the local_pod_names query parameter.

    +
    local_pod_names
    Array of strings

    A comma-separated list of local pod names. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the local_pod_ids query parameter.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    pod_replica_link_ids
    Array of strings

    A comma-separated list of pod replica link IDs. +If, after filtering, there is not at least one resource that matches each of the elements, +then an error is returned.

    +
    remote_ids
    Array of strings

    A comma-separated list of remote array IDs. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_names query parameter.

    +
    remote_names
    Array of strings

    A comma-separated list of remote array names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_ids query parameter.

    +
    remote_pod_ids
    Array of strings

    A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the remote_pod_names query parameter.

    +
    remote_pod_names
    Array of strings

    A comma-separated list of remote pod names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_pod_ids query parameter.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Modify policy mappings

    Modifies policy mappings of a replica link. +Valid mapping values are connected and disconnected. connected indicates that the +source policy and its attachments will be mirrored on the target pod. +disconnected indicates that the associated policy and its attachments are independent +from any policy on the remote. This operation can only be performed on +the target side of a pod replica link.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    local_pod_ids
    Array of strings

    A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the local_pod_names query parameter.

    +
    local_pod_names
    Array of strings

    A comma-separated list of local pod names. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the local_pod_ids query parameter.

    +
    pod_replica_link_ids
    Array of strings

    A comma-separated list of pod replica link IDs. +If, after filtering, there is not at least one resource that matches each of the elements, +then an error is returned.

    +
    remote_ids
    Array of strings

    A comma-separated list of remote array IDs. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_names query parameter.

    +
    remote_names
    Array of strings

    A comma-separated list of remote array names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_ids query parameter.

    +
    remote_pod_ids
    Array of strings

    A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource +that matches each of the elements, then an error is returned. This cannot be provided together +with the remote_pod_names query parameter.

    +
    remote_pod_names
    Array of strings

    A comma-separated list of remote pod names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be provided +together with the remote_pod_ids query parameter.

    +
    remote_policy_ids
    Array of strings

    A comma-separated list of remote policy IDs. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be +provided together with the remote_policy_names query parameter.

    +
    remote_policy_names
    Array of strings

    A comma-separated list of remote policy names. If, after filtering, there is not at least one +resource that matches each of the elements, then an error is returned. This cannot be +provided together with the remote_policy_ids query parameter.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    mapping
    string

    The mapping to set on this policy mapping. +Valid values are connected and disconnected.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "mapping": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Policies

    Policies are used to create exports (i.e., shares) and schedule snapshots. NFS and SMB policies +can be created and have one or more rules applied to them. Each policy can be reused, creating +exports for a number of managed directories.

    +

    List policies

    Displays a list of policies.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    List management access policies

    Displays a list of management access policies.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create management access policies

    Creates one or more management access policies. +To copy a policy, one of source_names or source_ids is required. +To create a policy from scratch, policy body is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    enabled
    boolean

    If set to true, enables the policy. If set to false, disables the policy.

    +
    aggregation_strategy
    string

    When set to least-common-permissions, any users to whom this policy applies can +receive no access rights exceeding those defined in this policy's capability and resource. +When this is set to all-permissions, any users to whom this policy applies are capable of +receiving additional access rights from other policies that apply to them. +If not specified, defaults to all-permissions.

    +
    Array of objects (_policyrulemanagementaccessRules)

    List the rules that defines the scoped roles.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "enabled": true,
    • "aggregation_strategy": "string",
    • "rules": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete management access policies

    Deletes one or more management access policies. +One of ids or names is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify management access policies

    Modifies one or more management access policies. +One of ids or names is required. +For renames, can only specify one old policy in ids or names.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The new name for the resource.

    +
    aggregation_strategy
    string

    When this is set to least-common-permissions, any users to whom this policy applies can +receive no access rights exceeding those defined in this policy's capability and resource. +When this is set to all-permissions, any users to whom this policy applies are capable of +receiving additional access rights from other policies that apply to them.

    +
    enabled
    boolean

    Sets whether the policy is enabled and grants the permissions specified.

    +
    Array of objects (_policyrulemanagementaccessRules)

    List the rules that defines the scoped roles.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "aggregation_strategy": "string",
    • "enabled": true,
    • "rules": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List management access policy members

    Displays a list of management access policy members.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in a comma-separated format.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in a comma-separated format.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a membership between an object and a management access policy

    Creates a membership between one or more objects and a management access policy.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in a comma-separated format.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_policymemberpostMembers)

    A list of resources to which the policy may be applied.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "members": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete membership between management access policies and attached object

    Deletes a membership between one or more management access policies and attached object. +One of policy_ids or policy_names is required, as well as one of member_ids +or member_names. member_types is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in a comma-separated format.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List alert-watcher policies

    Displays a list of alert-watcher policies.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create alert-watcher policies

    Creates one or more alert-watcher policies. +To copy a policy, the source_names or source_ids parameter is required, +but they cannot be set together. +To create a policy from scratch, policy body is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    enabled
    boolean

    If set to true, enables the policy. If set to false, disables the policy.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete alert-watcher policies

    Deletes one or more alert-watcher policies. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify alert-watcher policies

    Modifies one or more alert-watcher policies. To enable a policy, set enabled=true. +To disable a policy, set enabled=false. +To rename a policy, set name to the new name. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The new name for the resource.

    +
    enabled
    boolean

    If set to true, enables the policy. If set to false, disables the policy.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List alert-watcher policy members

    Displays a list of alert-watcher policy members.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a membership between an object and an alert-watcher policy

    Creates a membership between one or more objects and an alert-watcher policy. The policy_ids or policy_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_policymemberpostMembers)

    A list of resources to which the policy may be applied.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "members": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete membership between alert-watcher policies and attached object

    Deletes a membership between one or more alert-watcher policies and attached object. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List alert-watcher policy rules

    Displays a list of alert-watcher policy rules.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create alert-watcher policy rules

    Creates one or more alert-watcher policy rules. Either the 'policy_ids' or 'policy_names' parameter is required, but both parameters cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_policyrulealertwatcherpostRules)

    A list of alert-watcher policy rules to create.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "rules": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete alert-watcher policy rules

    Deletes one or more alert-watcher policy rules. Either the 'policy_ids' or 'policy_names' parameter is required, but both parameters cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify alert-watcher policy rules

    Modifies alert-watcher policy rules.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_policyrulealertwatcherpatchRules) <= 1 items

    Updates an alert-watcher rule in a policy. Only one update object will be accepted.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "rules": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List rules of alert-watcher policy rule test

    Displays alert-watcher policy rule email test results.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ]
    }

    List audit policies

    Displays a list of audit policies.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create audit policies

    Creates one or more audit policies. +To copy a policy, the source_names or source_ids parameter is required, +but they cannot be set together. +To create a policy from scratch, policy body is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    enabled
    boolean

    If set to true, enables the policy. If set to false, disables the policy.

    +
    Array of objects (_referenceNoIdWithType)

    A list of targets to which audit logs will be sent.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "enabled": true,
    • "log_targets": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete audit policies

    Deletes one or more audit policies. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify audit policies

    Modifies one or more audit policies. To enable a policy, set enabled=true. +To disable a policy, set enabled=false. +To rename a policy, set name to the new name. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The new name for the resource.

    +
    enabled
    boolean

    If set to true, enables the policy. If set to false, disables the policy.

    +
    Array of objects (_referenceNoIdWithType)

    A list of targets to which audit logs will be sent. +This list, if sent, overrides existing target list.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "enabled": true,
    • "log_targets": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List audit policy members

    Displays a list of audit policy members.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a membership between a managed directory and a audit policy

    Creates a membership between one or more managed directories and a audit policy. The policy_ids or policy_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_policymemberpostMembers)

    A list of resources to which the policy may be applied.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "members": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete membership between audit policies and managed directories

    Deletes a membership between one or more audit policies and managed directories. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List auto managed directory policies

    Displays a list of auto managed directory policies.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create auto managed directory policies

    Creates one or more auto managed directory policies. +To copy a policy, set one of either source_names or source_ids. +Each policy can only have one entry. +To create a policy from scratch, policy body is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    enabled
    boolean

    If set to true, enables the policy. If set to false, disables the policy.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete auto managed directory policies

    Deletes one or more auto managed directory policies. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify auto managed directory policies

    Modifies one or more auto managed directory policies. To enable a policy, +set enabled=true. +To disable a policy, set enabled=true. To rename a policy, +set name to the new name. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The new name for the resource.

    +
    enabled
    boolean

    If set to true, enables the policy. If set to false, disables the policy.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List auto managed directories policy members

    Displays a list of auto managed directory policy members.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create auto managed directory policies

    Creates a membership between one or more resources with an auto managed +directory policy. Applicable resources are directories. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_policymemberpostMembers)

    A list of resources to which the policy may be applied.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "members": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete auto managed directory policies

    Deletes one or more auto managed directory policies from resources. +The policy_ids or policy_names parameter is required, but they cannot be set together. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List policy members

    Displays a list of policy members.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    List NFS policies

    Displays a list of NFS policies.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create NFS policies

    Creates one or more NFS policies or copies an existing policy. +To copy a policy, the source_names or source_ids parameter is required, +but they cannot be set together. +To create a policy, policy body is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    enabled
    boolean

    If set to true, enables the policy. If set to false, disables the policy.

    +
    object (_policynfspostPolicyMapping)

    If set specifies the initial mapping of the policy upon its +creation across a pod replica link. +Policy being created must be in a source pod of a replica-link.

    +
    user_mapping_enabled
    boolean

    If set to true, FlashArray queries the joined +AD/OpenLDAP server to find the user +corresponding to the incoming UID. +If set to false, users are defined by UID/GID pair. +If not specified, defaults to true.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "enabled": true,
    • "policy_mapping": {
      },
    • "user_mapping_enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete NFS policies

    Deletes one or more NFS policies. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify NFS policies

    Modifies one or more NFS policies. To enable a policy, set enabled=true. +To disable a policy, set enabled=false. To rename a policy, set name to the new name. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The new name for the resource.

    +
    enabled
    boolean

    If set to true, enables the policy. If set to false, disables the policy.

    +
    nfs_version
    Array of strings

    NFS protocol version allowed for the export to set for the policy. +This operation updates all rules of the specified policy. +Valid values are nfsv3 and nfsv4.

    +
    security
    Array of strings

    The security flavors to use for accessing files on this mount point. +Values include auth_sys, krb5, krb5i, and krb5p. +If the server does not support the requested flavor, the mount operation fails. +This operation updates all rules of the specified policy. +If auth_sys, the client is trusted to specify the identity of the user. +If krb5, cryptographic proof of the identity of the user is provided in each RPC request. +This provides strong verification of the identity of users accessing data on the server. +Note that additional configuration besides adding this mount option is required to +enable Kerberos security. If krb5i, integrity checking is added to krb5. This ensures +the data has not been tampered with. If krb5p, integrity checking and encryption is added +to krb5. This is the most secure setting, but it also involves the most performance +overhead.

    +
    user_mapping_enabled
    boolean

    If set to true, FlashArray queries the joined AD/OpenLDAP server +to find the user corresponding to the incoming UID. +If set to false, users are defined by UID/GID pair.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "enabled": true,
    • "nfs_version": [
      ],
    • "security": [
      ],
    • "user_mapping_enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List NFS client policy rules

    Displays a list of NFS client policy rules.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create NFS client policy rules

    Creates one or more NFS client policy rules. +The policy_ids or policy_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_policyrulenfsclientpostRules)

    A list of NFS policy rules to create.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "rules": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete NFS client policy rules.

    Deletes one or more NFS client policy rules. +The policy_ids or policy_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List NFS policy members

    Displays a list of NFS policy members.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create NFS policies

    Creates a membership between one or more resources and an NFS policy. +Applicable resources are directories. +The policy_ids or policy_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_policymemberexportpostMembers)

    A list of directories to which the export policy may be applied.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "members": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete NFS policies

    Deletes one or more NFS policies from resources. +The policy_ids or policy_names parameter is required, but cannot be set together. +The member_ids or member_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List password policies

    Displays a list of password policies.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Modify password policies

    Modifies one or more password policies. To enable a policy, set enabled=true. +To disable a policy, set enabled=false.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    A user-specified name. +The name must be locally unique and can be changed.

    +
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    enabled
    boolean

    Returns a value of true if the policy is enabled.

    +
    enforce_dictionary_check
    boolean

    If true, test password against dictionary of known leaked passwords. +Only applies to passwords longer than 6 characters.

    +
    enforce_username_check
    boolean

    If true, the username cannot be a substring of the password. +It only applies to usernames of 3 characters and longer.

    +
    lockout_duration
    integer <int64> [ 1000 .. 7776000000 ]

    The lockout duration, in milliseconds, if a user is locked out after reaching the maximum +number of login attempts. Ranges from 1 second to 90 days.

    +
    max_login_attempts
    integer <int32> [ 1 .. 100 ]

    Maximum number of failed login attempts allowed before the user is locked out.

    +
    max_password_age
    integer <int64> [ 0 .. 8639913600000 ]

    The maximum age of password before password change is required. +Ranges from 1 day to 99999 days, with 0 meaning password expiration is disabled.

    +
    min_character_groups
    integer <int32> [ 0 .. 4 ]

    The minimum number of character groups ([a-z], [A-Z], [0-9], other) required to be present +in a password.

    +
    min_characters_per_group
    integer <int32> >= 1

    The minimum number of characters per group to count the group as present. +Maximum is limited by the minimum password length divided by the number of character groups +(e.g. min_password_length = 9, min_character_groups = 4, then maximum is 2).

    +
    min_password_age
    integer <int64> [ 0 .. 604800000 ]

    The minimum age, in milliseconds, of password before password change is allowed. +Ranges from 0 ms to 7 days

    +
    min_password_length
    integer <int32> [ 1 .. 100 ]

    Minimum password length. If not specified, defaults to 1.

    +
    password_history
    integer <int32> [ 0 .. 64 ]

    The number of passwords tracked to prevent reuse of passwords.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "context": { },
    • "enabled": true,
    • "enforce_dictionary_check": true,
    • "enforce_username_check": true,
    • "lockout_duration": 3600000,
    • "max_login_attempts": 10,
    • "max_password_age": 86400000,
    • "min_character_groups": 3,
    • "min_characters_per_group": 1,
    • "min_password_age": 86400000,
    • "min_password_length": 1,
    • "password_history": 5
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List quota policies

    Displays a list of quota policies.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create quota policies

    Creates one or more quota policies. +To copy a policy, the source_names or source_ids parameter is required, +but they cannot be set together. +To create a policy from scratch, policy body is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    enabled
    boolean

    If set to true, enables the policy. If set to false, disables the policy.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete quota policies

    Deletes one or more quota policies. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify quota policies

    Modifies one or more quota policies. To enable a policy, set enabled=true. +To disable a policy, set enabled=false. +To rename a policy, set name to the new name. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    ignore_usage
    boolean

    Flag used to override checks for quota management operations. +If set to true, directory usage is not checked against the quota_limits that are set. +If set to false, the actual logical bytes in use are prevented from exceeding +the limits set on the directory. Client operations might be impacted. +If the limit exceeds the quota, the client operation is not allowed. +If not specified, defaults to false.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The new name for the resource.

    +
    enabled
    boolean

    If set to true, enables the policy. If set to false, disables the policy.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List quota policy members

    Displays a list of quota policy members.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a membership between a managed directory and a quota policy

    Creates a membership between one or more managed directories and a quota policy. The policy_ids or policy_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ignore_usage
    boolean

    Flag used to override checks for quota management operations. +If set to true, directory usage is not checked against the quota_limits that are set. +If set to false, the actual logical bytes in use are prevented from exceeding +the limits set on the directory. Client operations might be impacted. +If the limit exceeds the quota, the client operation is not allowed. +If not specified, defaults to false.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_policymemberpostMembers)

    A list of resources to which the policy may be applied.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "members": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete membership between quota policies and managed directories

    Deletes a membership between one or more quota policies and managed directories. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List quota policy rules

    Displays a list of quota policy rules.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create quota policy rules

    Creates one or more quota policy rules. The policy_ids or policy_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ignore_usage
    boolean

    Flag used to override checks for quota management operations. +If set to true, directory usage is not checked against the quota_limits that are set. +If set to false, the actual logical bytes in use are prevented from exceeding +the limits set on the directory. Client operations might be impacted. +If the limit exceeds the quota, the client operation is not allowed. +If not specified, defaults to false.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_policyrulequotapostRules)

    A list of quota policy rules to create.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "rules": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete quota policy rules

    Deletes one or more quota policy rules. The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify quota policy rules

    Modifies quota policy rules.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ignore_usage
    boolean

    Flag used to override checks for quota management operations. +If set to true, directory usage is not checked against the quota_limits that are set. +If set to false, the actual logical bytes in use are prevented from exceeding +the limits set on the directory. Client operations might be impacted. +If the limit exceeds the quota, the client operation is not allowed. +If not specified, defaults to false.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_policyrulequotapatchRules) <= 1 items

    Updates rules in a policy and accepts a single-rule update object. The list can contain +only one item that will update all the specified rules.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "rules": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List SMB policies

    Displays a list of SMB policies.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create SMB policies

    Creates one or more SMB policies. +To copy a policy, set one of either source_names or source_ids. +Each policy can only have one entry. +To create a policy from scratch, policy body is required. +To create an SMB policy with access based enumeration enabled, +set access_based_enumeration_enabled=true.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    enabled
    boolean

    If set to true, enables the policy. If set to false, disables the policy.

    +
    access_based_enumeration_enabled
    boolean

    If set to true, enables access based enumeration on the policy. +When access based enumeration is enabled on a policy, +files and folders within exports that are attached to the policy +will be hidden from users who do not have permission to view them. +If not specified, defaults to false.

    +
    object (_policynfspostPolicyMapping)

    If set specifies the initial mapping of the policy upon its +creation across a pod replica link. +Policy being created must be in a source pod of a replica-link.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "enabled": true,
    • "access_based_enumeration_enabled": true,
    • "policy_mapping": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete SMB policies

    Deletes one or more SMB policies. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify SMB policies

    Modifies one or more SMB policies. +To enable a policy, set enabled=true. To disable a policy, set enabled=false. +To enable access based enumeration, set access_based_enumeration_enabled=true. +To disable access based enumeration, set access_based_enumeration_enabled=false. +To rename a policy, set name to the new name. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The new name for the resource.

    +
    enabled
    boolean

    If set to true, enables the policy. If set to false, disables the policy.

    +
    access_based_enumeration_enabled
    boolean

    If set to true, enables access based enumeration on the policy. +When access based enumeration is enabled on a policy, +files and folders within exports that are attached to the policy +will be hidden from users who do not have permission to view them.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "enabled": true,
    • "access_based_enumeration_enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List SMB client policy rules

    Displays a list of SMB client policy rules.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create SMB client policy rules

    Creates one or more SMB client policy rules. +The policy_ids or policy_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_policyrulesmbclientpostRules)

    A list of SMB policy rules to create.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "rules": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete SMB client policy rules.

    Deletes one or more SMB client policy rules. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List SMB policy members

    Displays a list of SMB policy members.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create SMB policies

    Creates a membership between one or more resources and an SMB policy. +Applicable resources are directories. +The policy_ids or policy_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_policymemberexportpostMembers)

    A list of directories to which the export policy may be applied.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "members": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete SMB policies

    Deletes one or more SMB policies from resources. +The policy_ids or policy_names parameter is required, but cannot be set together. +The member_ids or member_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List snapshot policies

    Displays a list of snapshot policies.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create snapshot policies

    Creates one or more snapshot policies. +To copy a policy, set one of either source_names or source_ids. +Each policy can only have one entry. +To create a policy from scratch, policy body is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    enabled
    boolean

    If set to true, enables the policy. If set to false, disables the policy.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete snapshot policies

    Deletes one or more snapshot policies. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify snapshot policies

    Modifies one or more snapshot policies. To enable a policy, set enabled=true. +To disable a policy, set enabled=true. +To rename a policy, set name to the new name. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The new name for the resource.

    +
    enabled
    boolean

    If set to true, enables the policy. If set to false, disables the policy.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List snapshot policy members

    Displays a list of snapshot policy members.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create snapshot policies

    Creates a membership between one or more resources and a snapshot policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_policymemberpostMembers)

    A list of resources to which the policy may be applied.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "members": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete snapshot policies

    Deletes one or more snapshot policies from resources. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    member_types
    Array of strings

    Performs the operation on the member types specified. +The type of member is the full name of the resource endpoint. +Valid values include directories. +Enter multiple member types in comma-separated format. +For example, type01,type02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List snapshot policy rules

    Displays a list of snapshot policy rules.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create snapshot policy rules

    Creates one or more snapshot policy rules. The policy_ids or policy_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_policyrulesnapshotpostRules)

    A list of snapshot policy rules to create.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "rules": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete snapshot policy rules

    Deletes one or more snapshot policy rules. The policy_ids or policy_names parameter is required, but cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    policy_ids
    Array of strings

    Performs the operation on the unique policy IDs specified. +Enter multiple policy IDs in comma-separated format. +The policy_ids or policy_names parameter is required, but they cannot be set together.

    +
    policy_names
    Array of strings

    Performs the operation on the policy names specified. +Enter multiple policy names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Ports

    The ports on a FlashArray are assigned iSCSI Qualified Names (IQNs), NVMe Qualified Names +(NQNs), and Fibre Channel World Wide Names (WWNs).

    +

    List ports

    Displays host name, iSCSI Qualified Names (IQNs), NVMe Qualified Names (NQNs), IPv4 address of the portal, Fibre Channel World Wide Names (WWNs), and failover ports, including those that were discovered by Purity//FA and those that have been manually assigned by system administrators.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ]
    }

    List port initiators

    Displays host iSCSI Qualified Names (IQNs), NVMe Qualified Names (NQNs), and Fibre Channel World Wide Names (WWNs), including those that were discovered by Purity//FA and those that have been manually assigned by system administrators, along with the array ports (targets) on which they are eligible to communicate.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ]
    }

    Protection Groups

    A protection group defines a set of volumes, hosts, or host groups (called members) that are +protected together through snapshots with point-in-time consistency across the member volumes. +The members within the protection group have common data protection requirements and the same +snapshot, replication, and retention schedules.

    +

    List protection groups

    Displays a list of protection groups, +including their associated source arrays, replication targets, +hosts, host groups, and volumes. +The list includes protection groups that were created on the +local array to replicate snapshot data to other arrays or +offload targets, created on a remote array and replicated +asynchronously to this array, or created inside a pod +on a remote array and stretched to the local array.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ],
    • "total": [
      ]
    }

    Create a protection group and upsert tags

    Creates a protection group on the local array for asynchronous replication.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    overwrite
    boolean

    If set to true, +overwrites an existing object during an object copy operation. +If set to false or not set at all and the target name is an existing object, +the copy operation fails. +Required if the source body parameter is set +and the source overwrites an existing object during the copy operation.

    +
    source_ids
    Array of strings

    The id of the protection group or protection group snapshot to be copied +into a new or existing protection group. If the destination protection group +and all of its volumes already exist, include the overwrite parameter to +overwrite all of the existing volumes with the snapshot contents. +If including the overwrite parameter, the names of the volumes that are +being overwritten must match the names of the volumes that are being restored. +If the source is a protection group, the latest snapshot of the protection group +will be used as the source during the copy operation.

    +
    source_names
    Array of strings

    The name of the protection group or protection group snapshot to be copied +into a new or existing protection group. If the destination protection group +and all of its volumes already exist, include the overwrite parameter to +overwrite all of the existing volumes with the snapshot contents. +If including the overwrite parameter, the names of the volumes that are +being overwritten must match the names of the volumes that are being restored. +If the source is a protection group, the latest snapshot of the protection group +will be used as the source during the copy operation.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (Tag)

    The list of tags to be upserted with the object.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "tags": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a protection group

    Deletes a protection group that has been destroyed and is pending eradication. +Eradicated protection groups cannot be recovered. +Protection groups are destroyed through the PATCH method. +The names parameter is required.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a protection group

    Modifies the protection group schedules to generate and replicate +snapshots to another array or to an external storage system. +Renames or destroys a protection group.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    A user-specified name. +The name must be locally unique and can be changed.

    +
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    object (WorkloadConfigurationFixedReferenceWorkload)

    A reference to the workload that is managing this resource. +The name parameter might show as an empty string briefly after controller failover.

    +
    destroyed
    boolean

    Has this protection group been destroyed? +To destroy a protection group, patch to true. +To recover a destroyed protection group, patch to false. +If not specified, defaults to false.

    +
    object (ProtectionGroupEradicationConfig)

    The configuration of the eradication feature.

    +
    object (FixedReference)

    The pod in which the protection group resides.

    +
    object (ReplicationSchedule)

    The schedule settings for asynchronous replication.

    +
    retention_lock
    string

    The valid values are ratcheted and unlocked. +The default value for a newly created protection group is unlocked. +Set retention_lock to ratcheted to enable SafeMode restrictions on the protection group. +Contact Pure Technical Services to change retention_lock to unlocked.

    +
    object (SnapshotSchedule)

    The schedule settings for protection group snapshots.

    +
    object (FixedReference)

    The array or pod on which the protection group was created.

    +
    object (RetentionPolicy)

    The retention policy for the source array of the protection group.

    +
    object (Space)

    Displays provisioned size and physical storage consumption data +for each protection group.

    +
    object (RetentionPolicy)

    The retention policy for the target(s) of the protection group.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "context": { },
    • "workload": { },
    • "destroyed": true,
    • "eradication_config": { },
    • "pod": { },
    • "replication_schedule": {
      },
    • "retention_lock": "unlocked",
    • "snapshot_schedule": {
      },
    • "source": { },
    • "source_retention": {
      },
    • "space": { },
    • "target_retention": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List protection groups with host members

    Displays a list of protection groups that have host members.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create an action to add a host to a protection group

    Creates an action to add a host member to a protection group. +Members that are already in the protection group are not affected. +For asynchronous replication, only members of the same type can belong to a protection group. +The group_names parameter represents the name of the protection group, and +the member_names parameter represents the name of the host. +The group_names and member_names parameters are required and must be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a host from a protection group

    Deletes a host member from a protection group. +After the member has been removed, it is no longer protected by the group. +Any protection group snapshots that were taken before the member was removed +will not be affected. +Removing a member from a protection group does not delete the member from the array, +and the member can be added back to the protection group at any time. +The group_names parameter represents the name of the protection group, and +the member_names parameter represents the name of the host. +The group_names and member_names parameters are required and must be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List protection groups with host group members

    Displays a list of protection groups that have host group members.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Creates an action to add a host group to a protection group

    Creates an action to add a host group member to a protection group. +Members that are already in the protection group are not affected. +For asynchronous replication, only members of the same type can belong to a protection group. +The group_names parameter represents the name of the protection group, and +the member_names parameter represents the name of the host group. +The group_names and member_names parameters are required and must be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a host group from a protection group

    Deletes a host group member from a protection group. +After the member has been removed, it is no longer protected by the group. +Protection group snapshots taken before the member was removed will not be affected. +Removing a member from a protection group does not delete the member from the array, +and the member can be added back to the protection group at any time. +The group_names parameter represents the name of the protection group, and +the member_names parameter represents the name of the host group. +The group_names and member_names parameters are required and must be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List protection group replication performance data

    Displays the total number of bytes of replication data transmitted and received per second. +The data is grouped by protection group.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ]
    }

    List protection group replication performance data with array details

    Displays the total number of bytes of replication data transmitted and received per second. +The data is grouped by protection group and includes the names of the source array and targets +for each protection group.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ]
    }

    List protection group space information

    Displays provisioned size and physical storage consumption data for each protection group.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ],
    • "total": [
      ]
    }

    List tags

    Displays the list of tags.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resource_destroyed
    boolean

    If set to true, returns only objects from destroyed resources. Returns an error if +the name of a live resource is specified in the resource_names query parameter. +If set to false, returns only objects from live resources. Returns an error if the +name of a destroyed resource is specified in the resource_names query parameter.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Delete tags

    Deletes specified tags.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    keys
    Array of strings

    A comma-separated list of tag keys.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces. Only one namespace is allowed per delete request.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Update tags

    Updates tags for all specified objects.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    A list of tags to be created or, if one already exists, updated.

    +
    Array ()
    copyable
    boolean

    Specifies whether or not to include the tag when copying the parent resource. +If set to true, the tag is included in resource copying. +If set to false, the tag is not included. +If not specified, defaults to true.

    +
    key
    string

    Key of the tag. Supports up to 64 Unicode characters.

    +
    namespace
    string

    Optional namespace of the tag. +Namespace identifies the category of the tag. Omitting the namespace +defaults to the namespace default. The pure&#42; namespaces are +reserved for plugins and integration partners. It is recommended +that customers avoid using reserved namespaces.

    +
    object (Reference)

    A reference to the parent object.

    +
    value
    string

    Value of the tag. Supports up to 256 Unicode characters.

    +

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List protection groups with targets

    Displays a list of protection groups that have target arrays, pods, or offload targets.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create an action to add a target to a protection group

    Creates an action to add an array, pod, or offload target to a protection group. +The group_names parameter represents the name of the protection group. +The member_names parameter represents the name of the array, pod, or offload target +that is being added to the protection group. +The group_names and member_names parameters are required and must be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a target from a protection group

    Deletes an array, pod, or offload target from a protection group. +The group_names parameter represents the name of the protection group. +The member_names parameter represents the name of the array, pod, or offload target +that is being removed from the protection group. +The group_names and member_names parameters are required and must be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a protection group target

    Modifies the source array to replicate protection group data to the target, +or disallows the source array from replicating protection group data to the target. +The allowed parameter must be set from the target array. +The group_names parameter represents the name of the protection group. +The allowed and group_names parameters are required and must be set together. +Offload targets do not support the allowed parameter.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    allowed
    boolean

    If set to true, the target array has allowed the source array +to replicate protection group data to the target array. +If set to false, the target array has not allowed the source array +to replicate protection group data to the target.

    +
    object (_fixedReference)
    object (_fixedReferenceNoId)

    Responses

    Request samples

    Content type
    application/json
    {
    • "allowed": true,
    • "protection_group": { },
    • "target": { }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List protection groups with volume members

    Displays a list of protection groups that have volume members.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    group_ids
    Array of strings

    Performs the operation on the unique group id specified. +Provide multiple resource IDs in comma-separated format. +The group_ids or names parameter is required, but they cannot be set together.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    include_remote
    boolean

    If set to true the response will include remote membership for protection groups that belong +to the remote arrays as well as local volumes. +Defaults to false.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_destroyed
    boolean

    If true, returns only destroyed member objects. Returns an error if +a name of a live member object is specified in the member_names query param. +If false, returns only live member objects. Returns an error if +a name of a destroyed member object is specified in the member_names +query param.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a volume to add it to a protection group

    Creates a volume member and adds it to a protection group. +Members that are already in the protection group are not affected. +For asynchronous replication, only members of the same type can belong to a protection group. +The group_names parameter represents the name of the protection group, and +the member_names and member_ids parameters represent the names or IDs of the volume. +The group_names parameter, and either the member_names or member_ids +parameters are required and must be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a volume from a protection group

    Deletes a volume member from a protection group. +After the member has been deleted, it is no longer protected by the group. +Any protection group snapshots that were taken before the member was deleted are not affected. +Deleting a member from a protection group does not delete the member from the array, +and the member can be added back to the protection group at any time. +The group_names parameter represents the name of the protection group, and +the member_names and member_ids parameters represent the names or IDs of the volume. +The group_names parameter, and either the member_names or member_ids +parameters are required and must be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Protection Group Snapshots

    Protection group snapshots capture the content of all volumes on the source array for the +specified protection group at a single point in time.

    +

    List protection group snapshots

    Displays a list of protection group snapshots, including those pending eradication.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ],
    • "total": [
      ]
    }

    Create a protection group snapshot

    Creates a point-in-time snapshot of the contents of a protection group. +The source_ids or source_names parameter is required, but they cannot be set together.

    +
    query Parameters
    allow_throttle
    boolean

    If set to true, allows snapshot to fail if array health is not optimal.

    +
    apply_retention
    boolean

    If true, applies the local and remote retention policy to the snapshots.

    +
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    for_replication
    boolean

    If true, destroys and eradicates the snapshot after 1 hour.

    +
    replicate
    boolean

    If set to true, queues up and begins replicating to each allowed target after all +earlier replication sessions for the same protection group have been +completed to that target. The replicate and replicate_now parameters cannot be used together.

    +
    replicate_now
    boolean

    If set to true, replicates the snapshots to each allowed target. +The replicate and replicate_now parameters cannot be used together.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    object (ProtectionGroupEradicationConfig)

    The configuration of the eradication feature.

    +
    object (FixedReference)

    The pod in which the protection group of the protection group snapshot resides.

    +
    object (FixedReference)

    The original protection group from which this snapshot was taken. +For a replicated protection group snapshot being viewed on the +target side, the source is the replica protection group.

    +
    object (Space)

    Displays provisioned size and physical storage consumption data +for each protection group.

    +
    suffix
    string

    The name suffix appended to the protection group name +to make up the full protection group snapshot name +in the form PGROUP.SUFFIX. +If suffix is not specified, +the protection group name is in the form PGROUP.NNN, +where NNN is a unique monotonically increasing number. +If multiple protection group snapshots are created at a time, +the suffix name is appended to those snapshots.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "context": { },
    • "destroyed": true,
    • "eradication_config": { },
    • "pod": { },
    • "source": { },
    • "space": { },
    • "suffix": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a protection group snapshot

    Deletes a protection group snapshot that has been destroyed and is pending eradication. +Eradicating a protection group snapshot eradicates all of its protection group snapshots +and cannot be recovered. +Protection group snapshots are destroyed through the PATCH method. +The names or ids parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a protection group snapshot

    Modifies a protection group snapshot so that it can be destroyed. +To destroy a volume, set destroyed=true. +To recover a volume that has been destroyed and is pending eradication, set destroyed=false. +The names or ids parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    A user-specified name. +The name must be locally unique and can be changed.

    +
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    destroyed
    boolean

    Returns a value of true if the protection group snapshot +has been destroyed and is pending eradication. +The time_remaining value displays the amount of time left +until the destroyed snapshot is permanently eradicated. +Before the time_remaining period has elapsed, +the destroyed snapshot can be recovered +by setting destroyed=false. +Once the time_remaining period has elapsed, +the snapshot is permanently eradicated and can no longer be recovered.

    +
    object (ProtectionGroupEradicationConfig)

    The configuration of the eradication feature.

    +
    object (FixedReference)

    The pod in which the protection group of the protection group snapshot resides.

    +
    object (FixedReference)

    The original protection group from which this snapshot was taken. +For a replicated protection group snapshot being viewed on the +target side, the source is the replica protection group.

    +
    object (Space)

    Displays provisioned size and physical storage consumption data +for each protection group.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "context": { },
    • "destroyed": true,
    • "eradication_config": { },
    • "pod": { },
    • "source": { },
    • "space": { },
    • "suffix": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Create an action to send protection group snapshots

    Creates an action to send protection group snapshots to protection pgroup targets. +When the on option is used, only specified targets will recieve the +protection group snapshots.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    convert_source_to_baseline
    boolean

    Set to true to have the snapshot be eradicated when it is no longer baseline on source.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    on
    Array of strings

    Performs the operation locally with the target names specified as the +destinations of the operation. +Enter multiple target names in comma-separated format. +For example, targetName01,targetName02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List protection group snapshots with transfer statistics

    Displays a list of protection group snapshots and corresponding transfer statistics.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ],
    • "total": [
      ]
    }

    Create an attempt to take protection group snapshot

    Creates an attempt to take the protection group snapshot, without +actually taking it, to test if the snapshot can be successfully taken.

    +
    query Parameters
    allow_throttle
    boolean

    If set to true, allows snapshot to fail if array health is not optimal.

    +
    apply_retention
    boolean

    If true, applies the local and remote retention policy to the snapshots.

    +
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    for_replication
    boolean

    If true, destroys and eradicates the snapshot after 1 hour.

    +
    replicate
    boolean

    If set to true, queues up and begins replicating to each allowed target after all +earlier replication sessions for the same protection group have been +completed to that target. The replicate and replicate_now parameters cannot be used together.

    +
    replicate_now
    boolean

    If set to true, replicates the snapshots to each allowed target. +The replicate and replicate_now parameters cannot be used together.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    object (ProtectionGroupEradicationConfig)

    The configuration of the eradication feature.

    +
    object (FixedReference)

    The pod in which the protection group of the protection group snapshot resides.

    +
    object (FixedReference)

    The original protection group from which this snapshot was taken. +For a replicated protection group snapshot being viewed on the +target side, the source is the replica protection group.

    +
    object (Space)

    Displays provisioned size and physical storage consumption data +for each protection group.

    +
    suffix
    string

    The name suffix appended to the protection group name +to make up the full protection group snapshot name +in the form PGROUP.SUFFIX. +If suffix is not specified, +the protection group name is in the form PGROUP.NNN, +where NNN is a unique monotonically increasing number. +If multiple protection group snapshots are created at a time, +the suffix name is appended to those snapshots.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "context": { },
    • "destroyed": true,
    • "eradication_config": { },
    • "pod": { },
    • "source": { },
    • "space": { },
    • "suffix": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Realms

    A realm is an administrative domain, a data container, and a namespace for pods, hosts, and host groups.

    +

    List realms

    Displays a list of realms.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "total": [
      ]
    }

    Create realms

    Creates realms on the local array. +Each realm must be given a name that is unique across the connected arrays.

    +
    query Parameters
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (ContainerQos)

    Sets QoS limits.

    +
    quota_limit
    integer <int64> [ 1048576 .. 4503599627370496 ]

    The logical quota limit of the realm, measured in bytes. Must be a multiple of 512.

    +
    Array of objects (NonCopyableTag)

    The list of tags to be upserted with the object.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "qos": {
      },
    • "quota_limit": 1048576,
    • "tags": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete realms

    Deletes realms that have been destroyed and are pending eradication. +Eradicated realms cannot be recovered. Realms are destroyed using the PATCH method.

    +
    query Parameters
    eradicate_contents
    boolean

    Set to true to eradicate contents (e.g., volumes, protection groups, snapshots) and containers +(e.g., realms, pods, volume groups). This enables you to eradicate containers with contents.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify realms

    Modifies realm details.

    +
    query Parameters
    destroy_contents
    boolean

    Set to true to destroy contents (e.g., volumes, protection groups, snapshots) and containers +(e.g., realms, pods, volume groups), including eradicating containers with content.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    ignore_usage
    boolean

    Set to true to set a quota_limit that is lower than the existing usage. +This ensures that no new volumes can be created until the existing usage +drops below the quota_limit. +If not specified, defaults to false.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The new name for the resource.

    +
    destroyed
    boolean

    If set to true, the realm will be destroyed and pending eradication. +The time_remaining value displays the amount of time left +until the destroyed realm is permanently eradicated. +A realm can only be destroyed if it is empty or destroy_contents is set to true. +Before the time_remaining period has elapsed, the destroyed realm can be recovered +by setting destroyed=false. +Once the time_remaining period has elapsed, +the realm is permanently eradicated and can no longer be recovered.

    +
    object (ContainerQos)

    Sets QoS limits.

    +
    quota_limit
    integer <int64> [ 1048576 .. 4503599627370496 ]

    The logical quota limit of the realm, measured in bytes.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "destroyed": true,
    • "qos": {
      },
    • "quota_limit": 1048576
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List realm performance data

    Displays real-time and historical performance data, real-time latency data, +and average I/O sizes across all realms, +displayed both by realm and as a total across all realms.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ],
    • "total": [
      ]
    }

    List realm space information

    Displays provisioned size and storage consumption data for each realm on the +local array.

    +
    query Parameters
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "total": [
      ]
    }

    List tags

    Displays the list of tags.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resource_destroyed
    boolean

    If set to true, returns only objects from destroyed resources. Returns an error if +the name of a live resource is specified in the resource_names query parameter. +If set to false, returns only objects from live resources. Returns an error if the +name of a destroyed resource is specified in the resource_names query parameter.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Delete tags

    Deletes specified tags.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    keys
    Array of strings

    A comma-separated list of tag keys.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces. Only one namespace is allowed per delete request.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Update tags

    Updates or creates tags for all specified objects.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    A list of tags to be created or, if already existing, updated.

    +
    Array ()
    key
    string

    Key of the tag. Supports up to 64 Unicode characters.

    +
    namespace
    string

    Optional namespace of the tag. +Namespace identifies the category of the tag. Omitting the namespace +defaults to the namespace default. The pure&#42; namespaces are +reserved for plugins and integration partners. It is recommended +that customers avoid using reserved namespaces.

    +
    object (_fixedReference)
    value
    string

    Value of the tag. Supports up to 256 Unicode characters.

    +

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Remote Arrays

    Remote arrays provide the ability to list and manage all the remote arrays known to an array.

    +

    List remote arrays

    Dispalys arrays in the current fleet, as well as arrays that the current array has existing +replication connections to.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    current_fleet_only
    boolean

    If current_fleet_only is specified, then results will only show arrays from the same fleet to +which the current array is a member of.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Remote Pods

    A remote pod represents a pod that is on a connected array but not stretched to this array.

    +

    List remote pods

    Displays a list of pods that that are on connected arrays but not stretched to this array.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    on
    Array of strings

    Performs the operation on the target name specified. +Enter multiple target names in comma-separated format. +For example, targetName01,targetName02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ]
    }

    Remote Protection Groups

    A remote protection group represents a protection group that resides on an offload target with +the source side of the remote protection group being another array that is connected to the +local array. The local array can only see the remote protection groups of other arrays if the +two arrays are connected.

    +

    List remote protection groups

    Returns a list of remote protection groups.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    on
    Array of strings

    Performs the operation on the target name specified. +Enter multiple target names in comma-separated format. +For example, targetName01,targetName02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Delete a remote protection group

    Deletes a remote protection group that has been destroyed and is pending eradication. +Eradicated remote protection groups cannot be recovered. +Remote protection groups are destroyed through the PATCH method. +The on parameter represents the name of the offload target. +The ids or names parameter and the on parameter are required and must be used together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    on
    string

    Performs the operation on the target name specified. +For example, targetName01.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a remote protection group

    Modifies the snapshot retention schedule of a remote protection group. +Also destroys a remote protection group from the offload target. +Before the remote protection group can be destroyed, +the offload target must first be removed from the protection group via the source array. +The on parameter represents the name of the offload target. +The ids or names parameter and the on parameter are required and must be used together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    on
    string

    Performs the operation on the target name specified. +For example, targetName01.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    destroyed
    boolean

    Returns a value of true if the remote protection group has been destroyed +and is pending eradication. +The time_remaining value displays the amount of time left +until the destroyed remote protection group is permanently eradicated. +Before the time_remaining period has elapsed, +the destroyed remote protection group can be recovered by setting destroyed=false. +Once the time_remaining period has elapsed, +the remote protection group is permanently eradicated and can no longer be recovered.

    +
    object (FixedReference)

    The offload target that the remote protection group is on.

    +
    object (FixedReference)

    The array where the remote protection group is replicated from.

    +
    object (RetentionPolicy)

    The retention policy for the remote protection group.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "destroyed": true,
    • "remote": { },
    • "source": { },
    • "target_retention": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Remote Protection Group Snapshots

    A remote protection group snapshot represents a protection group snapshot that resides on an +offload target with the source side of the remote protection group snapshot being another array +that is connected to the local array. The local array can only see the remote protection group +snapshots of other arrays if the two arrays are connected.

    +

    List remote protection group snapshots

    Displays a list of remote protection group snapshots.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    on
    Array of strings

    Performs the operation on the target name specified. +Enter multiple target names in comma-separated format. +For example, targetName01,targetName02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create remote protection group snapshot

    Creates remote protection group snapshots.

    +
    query Parameters
    allow_throttle
    boolean

    If set to true, allows snapshot to fail if array health is not optimal.

    +
    apply_retention
    boolean

    If true, applies the local and remote retention policy to the snapshots.

    +
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    convert_source_to_baseline
    boolean

    Set to true to have the snapshot be eradicated when it is no longer baseline on source.

    +
    for_replication
    boolean

    If true, destroys and eradicates the snapshot after 1 hour.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    on
    string

    Performs the operation on the target name specified. +For example, targetName01.

    +
    replicate
    boolean

    If set to true, queues up and begins replicating to each allowed target after all +earlier replication sessions for the same protection group have been +completed to that target. The replicate and replicate_now parameters cannot be used together.

    +
    replicate_now
    boolean

    If set to true, replicates the snapshots to each allowed target. +The replicate and replicate_now parameters cannot be used together.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    object (FixedReference)

    The offload target where the remote protection group snapshot is located.

    +
    object (FixedReference)

    The original protection group from which this snapshot was taken.

    +
    suffix
    string

    The suffix that is appended to the source_name value to generate the full +remote protection group snapshot name in the form PGROUP.SUFFIX. +If the suffix is not specified, the system constructs the snapshot name in the form +PGROUP.NNN, where PGROUP is the protection group name, and NNN is a monotonically +increasing number.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "destroyed": true,
    • "remote": { },
    • "source": { },
    • "suffix": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a remote protection group snapshot

    Deletes a remote protection group snapshot that has been destroyed and is pending eradication. +Eradicated remote protection group snapshots cannot be recovered. +Remote protection group snapshots are destroyed using the PATCH method. +The names parameter represents the name of the protection group snapshot. +The on parameter represents the name of the offload target. +The names and on parameters are required and must be used together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    on
    string

    Performs the operation on the target name specified. +For example, targetName01.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a remote protection group snapshot

    Modifies a remote protection group snapshot, removing it from the offload target and +destroying the snapshot. +The on parameter represents the name of the offload target. +The ids or names parameter and the on parameter are required and must be used together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    on
    string

    Performs the operation on the target name specified. +For example, targetName01.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    destroyed
    boolean

    If set to true, destroys a resource. Once set to true, +the time_remaining value will display the amount of time left +until the destroyed resource is permanently eradicated. +Before the time_remaining period has elapsed, the destroyed resource +can be recovered by setting destroyed=false. +Once the time_remaining period has elapsed, +the resource is permanently eradicated and can no longer be recovered.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "destroyed": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List remote protection groups with transfer statistics

    Displays a list of remote protection groups and their transfer statistics.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    on
    Array of strings

    Performs the operation on the target name specified. +Enter multiple target names in comma-separated format. +For example, targetName01,targetName02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ],
    • "total": [
      ]
    }

    Create an attempt to take remote protection group snapshot

    Creates an attempt to take a remote protection group snapshot without +actually taking it, to test if the snapshot can be successfully taken.

    +
    query Parameters
    allow_throttle
    boolean

    If set to true, allows snapshot to fail if array health is not optimal.

    +
    apply_retention
    boolean

    If true, applies the local and remote retention policy to the snapshots.

    +
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    convert_source_to_baseline
    boolean

    Set to true to have the snapshot be eradicated when it is no longer baseline on source.

    +
    for_replication
    boolean

    If true, destroys and eradicates the snapshot after 1 hour.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    on
    string

    Performs the operation on the target name specified. +For example, targetName01.

    +
    replicate
    boolean

    If set to true, queues up and begins replicating to each allowed target after all +earlier replication sessions for the same protection group have been +completed to that target. The replicate and replicate_now parameters cannot be used together.

    +
    replicate_now
    boolean

    If set to true, replicates the snapshots to each allowed target. +The replicate and replicate_now parameters cannot be used together.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    object (FixedReference)

    The offload target where the remote protection group snapshot is located.

    +
    object (FixedReference)

    The original protection group from which this snapshot was taken.

    +
    suffix
    string

    The suffix that is appended to the source_name value to generate the full +remote protection group snapshot name in the form PGROUP.SUFFIX. +If the suffix is not specified, the system constructs the snapshot name in the form +PGROUP.NNN, where PGROUP is the protection group name, and NNN is a monotonically +increasing number.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "destroyed": true,
    • "remote": { },
    • "source": { },
    • "suffix": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Remote Volume Snapshots

    A remote volume snapshot represents a volume snapshot that resides on an offload target with the +source side of the remote volume snapshot being another array that is connected to the local +array. The local array can only see the remote volume snapshots of other arrays if the two +arrays are connected.

    +

    List remote volume snapshots

    Displays a list of remote volume snapshots.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    on
    Array of strings

    Performs the operation on the target name specified. +Enter multiple target names in comma-separated format. +For example, targetName01,targetName02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a volume snapshot on a connected remote target or offload target

    Creates a volume snapshot on the specified connected remote target or offload target.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    on
    string

    Performs the operation on the target name specified. +For example, targetName01.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    suffix
    string

    The suffix that is appended to the source_name value to generate the +full volume snapshot name in the form VOL.SUFFIX. +If the suffix is not specified, the system constructs the snapshot name +in the form VOL.NNN, where VOL is the volume name, and NNN is a +monotonically increasing number.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "suffix": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a remote volume snapshot

    Deletes a remote volume snapshot +that has been destroyed and is pending eradication. +Eradicated remote volume snapshots cannot be recovered. +Remote volume snapshots are destroyed through the PATCH method. +The names parameter represents the name of the volume snapshot. +The on parameter represents the name of the offload target. +The names and on parameters are required and must be used together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    on
    string

    Performs the operation on the target name specified. +For example, targetName01.

    +
    replication_snapshot
    boolean

    If set to true, allow destruction/eradication of snapshots in use by replication. +If set to false, allow destruction/eradication of snapshots not in use by replication. +If not specified, defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a remote volume snapshot

    Modifies a remote volume snapshot by destroying or recovering it from the offload target. +The on parameter represents the name of the offload target. +The names parameter and the on parameter are required and must be used together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    on
    string

    Performs the operation on the target name specified. +For example, targetName01.

    +
    replication_snapshot
    boolean

    If set to true, allow destruction/eradication of snapshots in use by replication. +If set to false, allow destruction/eradication of snapshots not in use by replication. +If not specified, defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    destroyed
    boolean

    If set to true, destroys a resource. Once set to true, +the time_remaining value will display the amount of time left +until the destroyed resource is permanently eradicated. +Before the time_remaining period has elapsed, the destroyed resource +can be recovered by setting destroyed=false. +Once the time_remaining period has elapsed, +the resource is permanently eradicated and can no longer be recovered.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "destroyed": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List remote volume snapshots with transfer statistics

    Displays a list of remote volume snapshots and their transfer statistics.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    on
    Array of strings

    Performs the operation on the target name specified. +Enter multiple target names in comma-separated format. +For example, targetName01,targetName02.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ],
    • "total": [
      ]
    }

    SAML2 SSO

    SAML2 SSO allows customers to configure settings of SAML2 service provider +and identity provider. It provides a multi-factor authentication (MFA) +mechanism for customers to log in to FlashArray.

    +

    List SAML2 SSO configurations

    Displays the SAML2 SSO service provider and identity provider configuration +settings in the array.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {}

    Create SAML2 SSO configurations

    Creates SAML2 SSO configurations.

    +
    query Parameters
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    array_url
    string

    The URL of the array.

    +
    object (_saml2SsoIdp)

    Properties specific to the identity provider.

    +
    object (Saml2SsoSpCredential)

    Properties specific to the service provider.

    +

    Responses

    Request samples

    Content type
    application/json
    {}

    Response samples

    Content type
    application/json
    {}

    Delete SAML2 SSO configurations

    Deletes SAML2 SSO configurations.

    +
    query Parameters
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify SAML2 SSO configurations

    Modifies one or more attributes of SAML2 SSO configurations.

    +
    query Parameters
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    array_url
    string

    The URL of the array.

    +
    object (_saml2SsoIdp)

    Properties specific to the identity provider.

    +
    object (Saml2SsoSpCredential)

    Properties specific to the service provider.

    +
    enabled
    boolean

    If set to true, the SAML2 SSO configuration is enabled.

    +

    Responses

    Request samples

    Content type
    application/json
    {}

    Response samples

    Content type
    application/json
    {}

    List existing SAML2 SSO configurations

    Displays the existing SAML2 SSO configurations in the array.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Modify provided SAML2 SSO configurations

    Modifies the provided SAML2 SSO configurations. If the configurations with the +specified ids or names exist, the provided configurations will overwrite +the existing configurations, but will not be persisted in the array.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    array_url
    string

    The URL of the array.

    +
    object (_saml2SsoIdp)

    Properties specific to the identity provider.

    +
    object (Saml2SsoSpCredential)

    Properties specific to the service provider.

    +

    Responses

    Request samples

    Content type
    application/json
    {}

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Sessions

    Manages Purity//FA login and user session data.

    +

    List session data

    Displays session data for user login events performed in the Purity//FA GUI, CLI, and REST API.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    SMI-S

    Manages the Pure Storage Storage Management Initiative Specification (SMI-S).

    +

    List SMI-S settings

    Displays the SMI-S settings, including whether SLP and WBEM-HTTPS are enabled.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Modify SLP and SMI-S

    Modifies the Service Location Protocol (SLP) and the SMI-S provider, enabling or +disabling them.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    slp_enabled
    boolean

    If set to true, the Service Location Protocol (SLP) and its ports, +TCP 427 and UDP 427, are enabled.

    +
    wbem_https_enabled
    boolean

    If set to true, the SMI-S provider and its port, TCP 5989 is enabled.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "slp_enabled": true,
    • "wbem_https_enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    SMTP

    Manages connections to Simple Network Management Protocol (SMTP) managers.

    +

    List SMTP server attributes

    Displays SMTP server attributes. Values include user_name, password, relay_host, sender_domain, sender_username, subject_prefix, body_prefix, encryption_mode, and name.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Modify SMTP server attributes

    Modifies SMTP server attributes. Values include user_name, password, relay_host, sender_domain, sender_username, subject_prefix, body_prefix, encryption_mode, and name.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    body_prefix
    string <= 256 characters

    Optional string added to the beginning of the email body when sending alert email messages. +HTML tags are not allowed.

    +
    encryption_mode
    string

    Enforces an encryption mode when sending alert email messages. +Valid values are starttls. +Use "" to clear.

    +
    password
    string

    Password for the relay host, if needed.

    +
    relay_host
    string

    Relay server used as a forwarding point for email sent from the array. +Can be set as a hostname, IPv4 address, or IPv6 address, with optional port numbers. +The expected format for IPv4 is ddd.ddd.ddd.ddd:PORT. +The expected format for IPv6 is xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx or, +if a port number is specified, [xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx]:PORT.

    +
    sender_domain
    string

    Domain name appended to alert email messages.

    +
    sender_username
    string

    The local-part of the email address used when sending alert email messages.

    +
    subject_prefix
    string <= 64 characters

    Optional string added to the beginning of the subject when sending alert email messages. +HTML tags are not allowed.

    +
    user_name
    string

    User name for the relay host, if needed.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "body_prefix": "Classifaction is UNCLASSIFIED",
    • "encryption_mode": "starttls",
    • "password": "string",
    • "relay_host": "string",
    • "sender_domain": "string",
    • "sender_username": "string",
    • "subject_prefix": "DC:45 RM:23 RACK:12",
    • "user_name": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    SNMP Agents

    Manages connections to Simple Network Management Protocol (SNMP) agents.

    +

    List SNMP agent

    Displays the SNMP agent name and protocol attributes.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Modify SNMP agent

    Modifies the name or the protocol attributes of the SNMP agent.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (_snmp_v2c)

    The v2c configurations of SNMP.

    +
    object (_snmp_v3_patch)

    The v3 configurations of SNMP.

    +
    version
    string

    Version of the SNMP protocol to be used by Purity//FA in communications +with the specified manager. +Valid values are v2c and v3.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "v2c": {
      },
    • "v3": {
      },
    • "version": "v3"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List SNMP agent MIB text

    Displays the SNMP MIB text.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    SNMP Managers

    Manages connections to Simple Network Management Protocol (SNMP) managers.

    +

    List SNMP managers

    Displays designated SNMP managers and their communication and security attributes.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create SNMP manager

    Creates a Purity SNMP manager object that identifies a host (SNMP manager) and specifies the +protocol attributes for communicating with it. Once a manager object is created, the +transmission of SNMP traps is immediately enabled.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    host
    string

    DNS hostname or IP address of a computer that hosts an SNMP manager +to which Purity//FA is to send trap messages when it generates alerts.

    +
    notification
    string

    The type of notification the agent will send. +Valid values are inform and trap.

    +
    object (_snmp_v2c)

    The v2c configurations of SNMP.

    +
    object (_snmp_v3_post)

    The v3 configurations of SNMP.

    +
    version
    string

    Version of the SNMP protocol to be used by Purity//FA to communicate with the specified +manager. Valid values are v2c and v3.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "host": "snmp.purestorage.com",
    • "notification": "trap",
    • "v2c": {
      },
    • "v3": {
      },
    • "version": "v3"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete SNMP manager

    Deletes the SNMP manager object and stops communication with specified managers.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify SNMP manager

    Modifies the name or the protocol attributes of the specified SNMP manager.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    A user-specified name. +The name must be locally unique and can be changed.

    +
    host
    string

    DNS hostname or IP address of a computer that hosts an SNMP manager +to which Purity//FA is to send trap messages when it generates alerts.

    +
    notification
    string

    The type of notification the agent will send. +Valid values are inform and trap.

    +
    object (_snmp_v2c)

    The v2c configurations of SNMP.

    +
    object (_snmp_v3_patch)

    The v3 configurations of SNMP.

    +
    version
    string

    Version of the SNMP protocol to be used by Purity//FA to communicate with the specified +manager. Valid values are v2c and v3.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "host": "snmp.purestorage.com",
    • "notification": "trap",
    • "v2c": {
      },
    • "v3": {
      },
    • "version": "v3"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List SNMP manager test results

    Displays SNMP manager test results (traps or informs).

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ]
    }

    Software

    Software to be installed on the array.

    +

    List software packages

    Displays a list of available software packages.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    versions
    Array of strings

    A comma-separated list of versions.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create a software package

    Creates a software package download.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The name of the software.

    +
    version
    string

    The version of the software.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "Purity//FA",
    • "version": "5.2.3"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a software package

    Deletes a software package specified by software name and version. +A software package being used for an installation can be deleted if the installation is +downloading, downloaded, aborted, or finished. If the software package is currently +downloading, the download will be cancelled.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    software_versions
    Array of strings

    A comma-separated list of target software versions.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List software-bundle

    Displays a list of software bundles.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create software-bundle

    Creates and initiates a software bundle download.

    +
    header Parameters
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    source
    string

    The source of the software bundle. Accepts HTTP, HTTPS or FTP, and paths.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "source": "ftp://local/upgrade_bundle.sh"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List software check tasks

    Displays a list of software check tasks.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    software_names
    Array of strings

    A comma-separated list of software names.

    +
    software_versions
    Array of strings

    A comma-separated list of target software versions.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create a software check task

    Creates a software check task. If there are no previously queued or running +software check tasks, the new task immediately starts. Otherwise, it is queued and starts once +all previously queued or running software check tasks finish. To create a task, use a software +name and version.

    +
    query Parameters
    software_names
    Array of strings

    A comma-separated list of software names.

    +
    software_versions
    Array of strings

    A comma-separated list of target software versions.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a software check task

    Deletes a software check task specified by software name and version. +The check task must be queued. If the check task is running or passed/failed +then the task cannot be deleted.

    +
    query Parameters
    software_names
    Array of strings

    A comma-separated list of software names.

    +
    software_versions
    Array of strings

    A comma-separated list of target software versions.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List software upgrades

    Displays a list of software upgrades, including currently running and past upgrades.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    software_ids
    Array of strings

    A comma-separated list of software IDs.

    +
    software_names
    Array of strings

    A comma-separated list of software names.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create a software upgrade

    Creates and initiates a software upgrade.

    +
    query Parameters
    software_ids
    required
    Array of strings

    A comma-separated list of software IDs.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    mode
    string

    Mode that the upgrade is in. Valid values are check-only, interactive, semi-interactive, +and one-click. +The check_only mode is deprecated. Use /software-checks. In this mode, the upgrade only +runs pre-upgrade checks and returns. +In interactive mode, the upgrade pauses at several points, at which users must +enter certain commands to proceed. +In semi-interactive mode, the upgrade pauses if there are any upgrade check failures and +functions like one-click mode otherwise. +In one-click mode, the upgrade proceeds automatically without pausing.

    +
    Array of objects (_override_check)

    A list of upgrade checks whose failures are overridden during the upgrade. +If any optional args are provided, they are validated later when the corresponding check +script runs.

    +
    Array of objects (_upgrade_parameters)

    A list of parameters to be sent to the upgrade process. These parameters can be used to +change the behavior of the upgrade process in specific ways such as enabling or disabling +features in the target version or changing the attributes of the appliance at upgrade time. +When there is a need or option to set an upgrade parameter, Pure Storage will provide +documentation for the specific parameter. If you have been provided documentation +related to a specific upgrade parameter, +follow the instructions in the documentation. +Otherwise, do not set any upgrade parameters.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "mode": "interactive",
    • "override_checks": [
      ],
    • "upgrade_parameters": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Modify software upgrade

    Modifies a software upgrade by continuing, retrying, or aborting it. +All override_checks are updated before the command is issued if +add_override_checks is present. +The override_checks parameter is valid when command is set to continue or retry.

    +
    query Parameters
    command
    required
    string

    A user command that interacts with the upgrade. Commands may only be issued when the upgrade +is paused. Valid values are continue, retry, and abort. +The continue command continues a paused upgrade. +The retry command retries the previous step. +The abort command aborts the upgrade.

    +
    current_step_id
    required
    string

    The current step id of the installation.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_override_check)

    Adds the specified checks to the current list of override checks.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "add_override_checks": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List software upgrade steps

    Displays a list of currently running and completed software upgrade steps.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    software_installation_ids
    Array of strings

    A comma-separated list of software installation IDs.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    List software patches

    Displays a list of software patches.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create a software patch

    Creates software patch download and installation.

    +
    query Parameters
    allow_ha_reduction
    boolean

    If Software Patch has ha_reduction_required set to true, allow_ha_reduction must be +set to true for Software Patch installation.

    +
    name
    required
    string

    Name of software patch to install

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List available software patches

    Displays a list of available software patches.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    List software versions

    Displays a list of software versions.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Subnets

    Manages the subnets and VLANs used to organize the network interfaces.

    +

    List subnets

    Displays a list of subnets with statuses and attributes.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create subnet

    Creates a subnet with the specified parameters.

    +
    query Parameters
    names
    required
    Array of strings

    Performs the operation on the unique name specified. +For example, name01. +Enter multiple names in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    enabled
    boolean

    Returns a value of true if subnet is enabled. +Returns a value of false if subnet is disabled. +If not specified, defaults to true.

    +
    gateway
    string

    The IPv4 or IPv6 address of the gateway through which the specified +subnet is to communicate with the network.

    +
    mtu
    integer <int32> [ 1280 .. 9216 ]

    Maximum message transfer unit (packet) size for the subnet in bytes. +MTU setting cannot exceed the MTU of the corresponding physical interface. +If not specified, defaults to 1500.

    +
    prefix
    string

    The IPv4 or IPv6 address to be associated with the specified subnet.

    +
    vlan
    integer <int32>

    VLAN ID number.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "enabled": true,
    • "gateway": "string",
    • "mtu": 1280,
    • "prefix": "string",
    • "vlan": 0
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete subnet

    Deletes subnets. A subnet can only be deleted if it has no interfaces. Interfaces must be +removed by using the network-interfaces endpoint.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify subnet

    Modifies one or more specified subnet properties.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    A user-specified name. +The name must be locally unique and can be changed.

    +
    enabled
    boolean

    Returns a value of true if subnet is enabled. +Returns a value of false if subnet is disabled. +If not specified, defaults to true.

    +
    gateway
    string

    The IPv4 or IPv6 address of the gateway through which the specified +subnet is to communicate with the network.

    +
    mtu
    integer <int32> [ 1280 .. 9216 ]

    Maximum message transfer unit (packet) size for the subnet in bytes. +MTU setting cannot exceed the MTU of the corresponding physical interface. +If not specified, defaults to 1500.

    +
    prefix
    string

    The IPv4 or IPv6 address to be associated with the specified subnet.

    +
    vlan
    integer <int32>

    VLAN ID number.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "enabled": true,
    • "gateway": "string",
    • "mtu": 1280,
    • "prefix": "string",
    • "vlan": 0
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Subscriptions

    Provides information about subscription offerings.

    +

    List subscriptions

    Displays information about subscriptions.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Subscription Assets

    Provides information about subscription assets.

    +

    List subscription assets

    Displays information about subscription assets.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Support

    Enables Support to fix bugs and help customers solve problems. Support tools include proxy, +phonehome, and remote assist.

    +

    List connection paths

    Displays connection paths between the current array and each connected array.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create connection path

    Creates a connection path from the array to another array.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    phonehome_enabled
    boolean

    The status of phonehome. If set to true, enable phonehome. +If set to false, disable phonehome.

    +
    proxy
    string

    The value of the current proxy, which is used for connecting to cloud services such as +phonehome, remote assist, etc. +Specify the server name, including the scheme and proxy port number.

    +
    remote_assist_active
    boolean

    The status of a remote assist session. If set to true, enable the remote assist session. +If set to false, disable the remote assist session.

    +
    remote_assist_duration
    integer <int64>

    Specifies the duration of the remote assist session in milliseconds. +This parameter should only be provided when establishing a new session. +This parameter determines the length of time the session will remain active +after it is initiated.

    +

    Responses

    Request samples

    Content type
    application/json
    {}

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List remote assist session

    Displays settings for remote assist sessions.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Modify remote assist session

    Modifies settings for remote assist sessions.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    access_level_override
    string

    Overrides the default access level for the remote assist session only. +Values include restricted and elevated. +If not provided, the remote assist session will use the default_access_level setting.

    +
    active
    boolean

    The status of a remote assist session. If set to true, enables the remote assist session. +If set to false, disables the remote assist session.

    +
    duration
    integer <int64>

    Specifies the duration of the remote assist session in milliseconds. +This parameter should only be provided when establishing a new session. +This parameter determines the length of time the session will remain active +after initiation. +Defaults to 86400000 (24h) with a min of 14400000 (4h) and a max of 172800000 (48h).

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "access_level_override": "string",
    • "active": true,
    • "duration": 86400000
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List remote assist session global settings

    Displays global settings for remote assist sessions.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Update remote assist session global settings

    Updates global settings for remote assist sessions.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    default_access_level
    string

    The default access level that support will have when connecting to the array. +Values include restricted and elevated.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "default_access_level": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List Pure Storage Support connection data

    Displays information about whether the array can connect to Pure Storage Support by establishing a secure shell or secure HTTP connection and verifies that messages can be exchanged.

    +
    query Parameters
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    test_type
    string

    Specifies the type of test. Valid values are all, phonehome, and remote-assist. +If not specified, defaults to all.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    List diagnostics details

    Displays the diagnostics tests details.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    List diagnostics tools version and last updated date

    Displays diagnostics tools version and last updated date.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Update diagnostics tools

    Update diagnostics tools from downloaded bundle.

    +
    query Parameters
    purity_default
    boolean

    Set diagnostics tool to default version.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Syslog

    Copied to Log Targets/Syslog for more organized way to handle all log targets. +Both endpoints are identical. We encourage our users to use Log Targets/Syslog.

    +

    List syslog servers

    Displays a list of configured syslog servers.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create syslog server

    Creates a new syslog server.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    services
    Array of strings

    Valid values are data-audit and management. +If not specified, defaults to management.

    +
    uri
    string

    The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "services": [
      ],
    • "uri": "tcp://my.syslogserver.com"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete syslog server

    Deletes a configured syslog server and stops forwarding syslog messages.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify syslog server

    Modifies the URI and services of a configured syslog server.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    services
    Array of strings

    Valid values are data-audit and management. +If not specified, defaults to management.

    +
    uri
    string

    The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "services": [
      ],
    • "uri": "tcp://my.syslogserver.com"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List syslog settings

    Displays syslog settings. Values include continuation_token, items, more_items_remaining, and total_item_count.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Modify syslog settings

    Modifies syslog settings. Values include continuation_token, items, more_items_remaining, and total_item_count.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ca_certificate
    string

    The certificate of the certificate authority (CA) that signed the directory servers' +certificate(s), which is used to validate the authenticity of the configured servers.

    +
    logging_severity
    string

    Returns the configured logging severity threshold for which events will +be forwarded to the configured syslog servers. Default configuration is +info level severity. +Valid values are debug, info, and notice.

    +
    tls_audit_enabled
    boolean

    Returns a value of true if messages that are necessary in order to +audit TLS negotiations performed by the array are forwarded to the +configured syslog servers.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "ca_certificate": "string",
    • "logging_severity": "string",
    • "tls_audit_enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List syslog server test results

    Displays syslog server test results, which indicate whether the syslog is working and configured correctly.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ]
    }

    Vchost Connections

    A vchost connection is between a protocol endpoint and vchost. +In the context of vchost-connection, the vchost represents a vCenter, +and the protocol endpoint is used to represent a storage container. +Creating a vchost connection gives the vCenter access to the storage container. +If all_vchosts is set to true, the container will be accessible to all vchosts.

    +

    List the vchost-connections between protocol endpoint and vchost.

    Displays a list of vchost-connections between the protocol endpoint and vchost.

    +
    query Parameters
    all_vchosts
    boolean
    Default: false

    If set to true, the storage container represented by the protocol endpoint +is accessible to all vchosts. +Users should not specify vchost_ids or vchost_names in the request. +If set to false, the storage container represented by the protocol endpoint +is only accessible to the vchosts that have explicit vchost-connections with +the protocol endpoint. Users need to specify vchost_ids or vchost_names in the request.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    protocol_endpoint_ids
    Array of strings

    A comma-separated list of protocol endpoint IDs. +Performs the operation on the protocol endpoints specified. +For example, peid01,peid02. +Cannot be used in conjunction with protocol_endpoint_names. +If the list contains more than one value, +then vchost_ids or vchost_names must have exactly one value.

    +
    protocol_endpoint_names
    Array of strings

    A comma-separated list of protocol endpoint names. +Performs the operation on the protocol endpoints specified. +For example, pe01,pe02. +Cannot be used in conjunction with protocol_endpoint_ids. +If the list contains more than one value, +then vchost_ids or vchost_names must have exactly one value.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    vchost_ids
    Array of strings

    A comma-separated list of vchost IDs. +Performs the operation on the vchosts specified. +For example, vchostid01,vchostid02. +Cannot be used in conjunction with vchost_names. +If the list contains more than one value, +then protocol_endpoint_ids or protocol_endpoint_names must have exactly one value.

    +
    vchost_names
    Array of strings

    A comma-separated list of vchost names. +Performs the operation on the vchosts specified. +For example, vchost01,vchost02. +Cannot be used in conjunction with vchost_ids. +If the list contains more than one value, +then protocol_endpoint_ids or protocol_endpoint_names must have exactly one value.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create a vchost-connection between protocol endpoint and vchost.

    Creates a vchost-connection between protocol endpoint and vchost. +Each vchost is associated with a vCenter. Each protocol endpoint +is associated with a storage container. A vchost-connection makes +the storage container accessible to the vCenter when the vCenter +attempts to mount the container. One of protocol_endpoint_names +or protocol_endpoint_ids query parameters and one of vchost_names +or vchost_ids query parameters are required. But if all_vchosts is +set to true, vchost_names and vchost_ids should not be specified.

    +
    query Parameters
    all_vchosts
    boolean
    Default: false

    If set to true, the storage container represented by the protocol endpoint +is accessible to all vchosts. +Users should not specify vchost_ids or vchost_names in the request. +If set to false, the storage container represented by the protocol endpoint +is only accessible to the vchosts that have explicit vchost-connections with +the protocol endpoint. Users need to specify vchost_ids or vchost_names in the request.

    +
    allow_stretched_multi_vchost
    boolean
    Default: false

    If set to true, users are allowed to create a new +vchost-connection to a stretched container that already has +a vchost-connection. In principle, a stretched container can +only have one vchost-connection at a time.

    +
    protocol_endpoint_ids
    Array of strings

    A comma-separated list of protocol endpoint IDs. +Performs the operation on the protocol endpoints specified. +For example, peid01,peid02. +Cannot be used in conjunction with protocol_endpoint_names. +If the list contains more than one value, +then vchost_ids or vchost_names must have exactly one value.

    +
    protocol_endpoint_names
    Array of strings

    A comma-separated list of protocol endpoint names. +Performs the operation on the protocol endpoints specified. +For example, pe01,pe02. +Cannot be used in conjunction with protocol_endpoint_ids. +If the list contains more than one value, +then vchost_ids or vchost_names must have exactly one value.

    +
    vchost_ids
    Array of strings

    A comma-separated list of vchost IDs. +Performs the operation on the vchosts specified. +For example, vchostid01,vchostid02. +Cannot be used in conjunction with vchost_names. +If the list contains more than one value, +then protocol_endpoint_ids or protocol_endpoint_names must have exactly one value.

    +
    vchost_names
    Array of strings

    A comma-separated list of vchost names. +Performs the operation on the vchosts specified. +For example, vchost01,vchost02. +Cannot be used in conjunction with vchost_ids. +If the list contains more than one value, +then protocol_endpoint_ids or protocol_endpoint_names must have exactly one value.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete the vchost-connection between a protocol endpoint and its vchost

    Deletes the vchost-connection between a protocol endpoint and its vchost. +The storage container represented by the protocol endpoint will no longer +be visible to the vCenter represented by the vchost. +One of the protocol_endpoint_names or protocol_endpoint_ids query parameters, +and one of the vchost_names or vchost_ids query parameters are required. +But if all_vchosts is set to true, vchost_names and vchost_ids +should not be specified.

    +
    query Parameters
    all_vchosts
    boolean
    Default: false

    If set to true, the storage container represented by the protocol endpoint +is accessible to all vchosts. +Users should not specify vchost_ids or vchost_names in the request. +If set to false, the storage container represented by the protocol endpoint +is only accessible to the vchosts that have explicit vchost-connections with +the protocol endpoint. Users need to specify vchost_ids or vchost_names in the request.

    +
    protocol_endpoint_ids
    Array of strings

    A comma-separated list of protocol endpoint IDs. +Performs the operation on the protocol endpoints specified. +For example, peid01,peid02. +Cannot be used in conjunction with protocol_endpoint_names. +If the list contains more than one value, +then vchost_ids or vchost_names must have exactly one value.

    +
    protocol_endpoint_names
    Array of strings

    A comma-separated list of protocol endpoint names. +Performs the operation on the protocol endpoints specified. +For example, pe01,pe02. +Cannot be used in conjunction with protocol_endpoint_ids. +If the list contains more than one value, +then vchost_ids or vchost_names must have exactly one value.

    +
    vchost_ids
    Array of strings

    A comma-separated list of vchost IDs. +Performs the operation on the vchosts specified. +For example, vchostid01,vchostid02. +Cannot be used in conjunction with vchost_names. +If the list contains more than one value, +then protocol_endpoint_ids or protocol_endpoint_names must have exactly one value.

    +
    vchost_names
    Array of strings

    A comma-separated list of vchost names. +Performs the operation on the vchosts specified. +For example, vchost01,vchost02. +Cannot be used in conjunction with vchost_ids. +If the list contains more than one value, +then protocol_endpoint_ids or protocol_endpoint_names must have exactly one value.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Volumes

    A volume represents a container that manages the storage space on the array. After a volume has +been created, host-volume connections must be established so that the host can read data from +and write data to the volume. Volume data should be protected using asynchronous replication to +a remote array, synchronous replication between remote arrays, and replication to external +storage systems.

    +

    List volumes

    Displays a list of volumes, including those pending eradication.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ],
    • "total": [
      ]
    }

    Create or copy a volume and upsert tags

    Creates one or more virtual storage volumes of the specified size. +If provisioned is not specified, the size of the new volume defaults to 1 MB. +The names query parameter is required. +The add_to_protection_group_names query parameter specifies a list of protection group +names that will compose the initial protection for the volume. +The with_default_protection query parameter specifies whether to use the container +default protection configuration for the volume. +The add_to_protection_group_names and with_default_protection query parameters +cannot be provided when overwrite is true.

    +
    query Parameters
    add_to_protection_group_ids
    Array of strings

    The volumes will be added to the specified protection groups along with creation or movement +across pods and array. +When a volume is moved, the specified protection groups must be in the target pod or array. +Enter multiple ids in comma-separated format.

    +
    add_to_protection_group_names
    Array of strings

    The volumes will be added to the specified protection groups along with creation or movement +across pods and array. +When a volume is moved, the specified protection groups must be in the target pod or array. +Enter multiple names in a comma-separated format.

    +
    allow_throttle
    boolean

    If set to true, allows operation to fail if array health is not optimal.

    +
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    overwrite
    boolean

    If set to true, +overwrites an existing object during an object copy operation. +If set to false or not set at all and the target name is an existing object, +the copy operation fails. +Required if the source body parameter is set +and the source overwrites an existing object during the copy operation.

    +
    with_default_protection
    boolean

    If specified as true, the initial protection of the newly created volumes will be +the union of the container default protection configuration and +add_to_protection_group_names. +If specified as false, the default protection of the container will not be applied +automatically. The initial protection of the newly created volumes will be configured +by add_to_protection_group_names. +If not specified, defaults to true.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    destroyed
    boolean

    If set to true, destroys a resource. Once set to true, +the time_remaining value will display the amount of time left +until the destroyed resource is permanently eradicated. +Before the time_remaining period has elapsed, the destroyed resource +can be recovered by setting destroyed=false. +Once the time_remaining period has elapsed, +the resource is permanently eradicated and can no longer be recovered.

    +
    object (PriorityAdjustment)

    Adjusts volume priority.

    +
    object (ProtocolEndpoint)

    Sets the properties that are specific to protocol endpoints. +This can only be used in conjunction to subtype=protocol_endpoint.

    +
    provisioned
    integer <int64> <= 4503599627370496

    Sets the virtual size of the volume, measured in bytes.

    +
    object (Qos)

    Sets QoS limits.

    +
    object (Reference)

    The source volume of a volume copy.

    +
    subtype
    string

    The type of volume. Valid values are protocol_endpoint and regular.

    +
    Array of objects (Tag)

    The list of tags to be upserted with the object.

    +
    object (WorkloadConfigurationReference)

    The workload to which the volume is added. +Set one of id or name, and configuration to add the volume to the workload +and configure it based on the configuration from the preset the workload was +originally provisioned from.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "destroyed": true,
    • "priority_adjustment": {
      },
    • "protocol_endpoint": {
      },
    • "provisioned": 0,
    • "qos": {
      },
    • "source": {
      },
    • "subtype": "string",
    • "tags": [
      ],
    • "workload": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a volume

    Deletes a volume that has been destroyed and is pending eradication. +Eradicated volumes cannot be recovered. +Volumes are destroyed using the PATCH method. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a volume

    Modifies a volume by renaming, destroying, or resizing it. +To rename a volume, set name to the new name. To destroy a volume, set destroyed=true. +To recover a volume that has been destroyed and is pending eradication, set destroyed=false. +Set the bandwidth and IOPS limits of a volume through the respective bandwidth_limit and +iops_limit parameter. This moves the volume into a pod or volume group through the respective +pod or volume_group parameter. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    add_to_protection_group_ids
    Array of strings

    The volumes will be added to the specified protection groups along with creation or movement +across pods and array. +When a volume is moved, the specified protection groups must be in the target pod or array. +Enter multiple ids in comma-separated format.

    +
    add_to_protection_group_names
    Array of strings

    The volumes will be added to the specified protection groups along with creation or movement +across pods and array. +When a volume is moved, the specified protection groups must be in the target pod or array. +Enter multiple names in a comma-separated format.

    +
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    remove_from_protection_group_ids
    Array of strings

    The volumes will be removed from the specified protection groups in the source pod or array along +with the move. +This can only be used when moving volumes across pods and arrays and must include all protection +groups that the volumes are members of before the move. +Enter multiple ids in a comma-separated format.

    +
    remove_from_protection_group_names
    Array of strings

    The volumes will be removed from the specified protection groups in the source pod or array along +with the move. +This can only be used when moving volumes across pods and arrays and must include all protection +groups that the volumes are members of before the move. +Enter multiple names in a comma-separated format.

    +
    truncate
    boolean

    If set to true, reduces the size of a volume +during a volume resize operation. +When a volume is truncated, Purity automatically takes an undo snapshot, +providing a 24-hour window during which the previous contents +can be retrieved. After truncating a volume, +its provisioned size can be subsequently increased, +but the data in truncated sectors cannot be retrieved. +If set to false or not set at all and the volume is being reduced in size, +the volume copy operation fails. +Required if the provisioned parameter is set to a volume size +that is smaller than the original size.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    destroyed
    boolean

    If set to true, destroys a resource. Once set to true, +the time_remaining value will display the amount of time left +until the destroyed resource is permanently eradicated. +Before the time_remaining period has elapsed, the destroyed resource +can be recovered by setting destroyed=false. +Once the time_remaining period has elapsed, +the resource is permanently eradicated and can no longer be recovered.

    +
    name
    string

    The new name for the resource.

    +
    object (Reference)

    Moves the volume into the specified pod.

    +
    object (PriorityAdjustment)

    Adjusts volume priority.

    +
    object (ProtocolEndpoint)

    Sets the properties that are specific to protocol endpoints. +This can only be used in conjunction to subtype=protocol_endpoint.

    +
    provisioned
    integer <int64> <= 4503599627370496

    Updates the virtual size of the volume, measured in bytes.

    +
    object (Qos)

    Sets QoS limits.

    +
    requested_promotion_state
    string

    Valid values are promoted and demoted. +Patch requested_promotion_state to demoted to demote the volume so that the volume +stops accepting write requests. +Patch requested_promotion_state to promoted to promote the volume so that the volume +starts accepting write requests.

    +
    object (Reference)

    Adds the volume to the specified volume group.

    +
    object (ReferenceWithFixedType)

    Set the id or name of the workload to an empty string to remove the +volume from the workload.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "destroyed": true,
    • "name": "string",
    • "pod": {
      },
    • "priority_adjustment": {
      },
    • "protocol_endpoint": {
      },
    • "provisioned": 0,
    • "qos": {
      },
    • "requested_promotion_state": "string",
    • "volume_group": {
      },
    • "workload": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Create or copy volumes and upsert tags

    Creates or copies a list of virtual storage volumes. Volumes of different +sizes, vgroups, and tag upsertions can be copied this way.

    +
    query Parameters
    allow_throttle
    boolean

    If set to true, allows operation to fail if array health is not optimal.

    +
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    overwrite
    boolean

    If set to true, +overwrites an existing object during an object copy operation. +If set to false or not set at all and the target name is an existing object, +the copy operation fails. +Required if the source body parameter is set +and the source overwrites an existing object during the copy operation.

    +
    with_default_protection
    boolean

    If specified as true, the initial protection of the newly created volumes will be +the union of the container default protection configuration and +add_to_protection_group_names. +If specified as false, the default protection of the container will not be applied +automatically. The initial protection of the newly created volumes will be configured +by add_to_protection_group_names. +If not specified, defaults to true.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    A list of volumes to be created or copied.

    +
    Array ()
    destroyed
    boolean

    If set to true, destroys a resource. Once set to true, +the time_remaining value will display the amount of time left +until the destroyed resource is permanently eradicated. +Before the time_remaining period has elapsed, the destroyed resource +can be recovered by setting destroyed=false. +Once the time_remaining period has elapsed, +the resource is permanently eradicated and can no longer be recovered.

    +
    object (PriorityAdjustment)

    Adjusts volume priority.

    +
    object (ProtocolEndpoint)

    Sets the properties that are specific to protocol endpoints. +This can only be used in conjunction to subtype=protocol_endpoint.

    +
    provisioned
    integer <int64> <= 4503599627370496

    Sets the virtual size of the volume, measured in bytes.

    +
    object (Qos)

    Sets QoS limits.

    +
    object (Reference)

    The source volume of a volume copy.

    +
    subtype
    string

    The type of volume. Valid values are protocol_endpoint and regular.

    +
    Array of objects (Tag)

    The list of tags to be upserted with the object.

    +
    Array of objects (_reference)

    Specifies a list of protection groups that will compose +the initial protection for the volume.

    +
    name
    string

    Specifies the name of the volume.

    +

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List volume diffs

    Displays block differences for the specified volumes.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    base_id
    string

    ID of the volume or volume snapshot that the diff comparison is based on. +If a base volume or volume snapshot is not specified, +all mapped blocks for the volume or volume snapshot are displayed. +The base_name or base_id parameter is required, but they cannot be set together.

    +
    base_name
    string

    Name of the volume or volume snapshot that the diff comparison is based on. +If a base volume or volume snapshot is not specified, +all mapped blocks for the volume or volume snapshot are displayed. +The base_name or base_id parameter is required, but they cannot be set together.

    +
    block_size
    required
    integer <int64>

    Granularity at which to compare, in bytes. Must be a multiple of 512.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    next_allocated_block_hint
    boolean

    If set to true, appends offset of the next allocated block in bytes +for the volume specified in names or ids to the output items. +base_name or base_id must not be specified if this is set to true. +If not specified, defaults to false.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    segment_length
    required
    integer <int64>

    Length of the segment, in bytes, to compare.

    +
    segment_offset
    integer <int64>

    Absolute offset, in bytes, of the segment to compare. +Must be a multiple of block_size.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create an attempt to copy volumes and upsert tags

    Creates an attempt to copy virtual storage volumes of different sizes in different vgroups and +also upserts tags, without actually creating them, to test if they can be successfully created. +Only available for creating volumes via a copy, not direct volume creation.

    +
    query Parameters
    allow_throttle
    boolean

    If set to true, allows operation to fail if array health is not optimal.

    +
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    overwrite
    boolean

    If set to true, +overwrites an existing object during an object copy operation. +If set to false or not set at all and the target name is an existing object, +the copy operation fails. +Required if the source body parameter is set +and the source overwrites an existing object during the copy operation.

    +
    with_default_protection
    boolean

    If specified as true, the initial protection of the newly created volumes will be +the union of the container default protection configuration and +add_to_protection_group_names. +If specified as false, the default protection of the container will not be applied +automatically. The initial protection of the newly created volumes will be configured +by add_to_protection_group_names. +If not specified, defaults to true.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    A list of volumes to be copied.

    +
    Array ()
    destroyed
    boolean

    If set to true, destroys a resource. Once set to true, +the time_remaining value will display the amount of time left +until the destroyed resource is permanently eradicated. +Before the time_remaining period has elapsed, the destroyed resource +can be recovered by setting destroyed=false. +Once the time_remaining period has elapsed, +the resource is permanently eradicated and can no longer be recovered.

    +
    object (PriorityAdjustment)

    Adjusts volume priority.

    +
    object (ProtocolEndpoint)

    Sets the properties that are specific to protocol endpoints. +This can only be used in conjunction to subtype=protocol_endpoint.

    +
    provisioned
    integer <int64> <= 4503599627370496

    Sets the virtual size of the volume, measured in bytes.

    +
    object (Qos)

    Sets QoS limits.

    +
    object (Reference)

    The source volume of a volume copy.

    +
    subtype
    string

    The type of volume. Valid values are protocol_endpoint and regular.

    +
    Array of objects (Tag)

    The list of tags to be upserted with the object.

    +
    Array of objects (_reference)

    Specifies a list of protection groups that will compose +the initial protection for the volume.

    +
    name
    string

    Specifies the name of the volume.

    +

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List volume performance data

    Displays real-time and historical performance data, real-time latency data, and average I/O +sizes for each volume and and as a total of all volumes across the entire array.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ],
    • "total": [
      ]
    }

    List volume performance data by array

    Displays real-time and historical performance data, real-time latency data, +and average I/O size data. +The data returned is for each volume on the current array and for each volume +on any remote arrays that are visible to the current array. +The data is grouped by individual volumes +and as a total across all volumes on each array.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ],
    • "total": [
      ]
    }

    List volumes that are members of protection groups

    Displays a list of volume members that belong to one or more protection groups.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_destroyed
    boolean

    If true, returns only destroyed member objects. Returns an error if +a name of a live member object is specified in the member_names query param. +If false, returns only live member objects. Returns an error if +a name of a destroyed member object is specified in the member_names +query param.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a volume and add it to a protection group

    Creates a volume member and adds it to a protection group. +Members that are already in the protection group are not affected. +For asynchronous replication, only members of the same type can belong to a protection group. +The group_names parameter represents the name of the protection group, and +the member_names and member_ids parameters represent the names or IDs of the volume. +The group_names and only one of member_names or member_ids +parameters are required and must be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a volume from a protection group

    Deletes a volume member from a protection group. +After the member has been deleted, it is no longer protected by the group. +Any protection group snapshots that were taken before the member was deleted +are not affected. +Deleting a member from a protection group does not delete the member from the array, +and the member can be added back to the protection group at any time. +The group_names parameter represents the name of the protection group, and +the member_names and member_ids parameters represent the names or IDs of the volume. +The group_names and only one of member_names or member_ids +parameters are required and must be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    List volume space information

    Displays the provisioned size and physical storage consumption data for each volume.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ],
    • "total": [
      ]
    }

    List tags

    Displays the list of tags.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resource_destroyed
    boolean

    If set to true, returns only objects from destroyed resources. Returns an error if +the name of a live resource is specified in the resource_names query parameter. +If set to false, returns only objects from live resources. Returns an error if the +name of a destroyed resource is specified in the resource_names query parameter.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Delete tags

    Deletes specified tags.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    keys
    Array of strings

    A comma-separated list of tag keys.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces. Only one namespace is allowed per delete request.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Update tags

    Updates tags.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    A list of tags to be created or, if one already exists, updated.

    +
    Array ()
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    copyable
    boolean

    Specifies whether or not to include the tag when copying the parent resource. +If set to true, the tag is included in resource copying. +If set to false, the tag is not included. +If not specified, defaults to true.

    +
    key
    string

    Key of the tag. Supports up to 64 Unicode characters.

    +
    namespace
    string

    Optional namespace of the tag. +Namespace identifies the category of the tag. Omitting the namespace +defaults to the namespace default. The pure&#42; namespaces are +reserved for plugins and integration partners. It is recommended +that customers avoid using reserved namespaces.

    +
    object (_fixedReference)
    value
    string

    Value of the tag. Supports up to 256 Unicode characters.

    +

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Create a dry run attempt to copy a volume

    Creates a dry run attempt to see if copying a volume would +succeed. No virtual volumes are actually copied or created in this process.

    +
    query Parameters
    add_to_protection_group_ids
    Array of strings

    The volumes will be added to the specified protection groups along with creation or movement +across pods and array. +When a volume is moved, the specified protection groups must be in the target pod or array. +Enter multiple ids in comma-separated format.

    +
    add_to_protection_group_names
    Array of strings

    The volumes will be added to the specified protection groups along with creation or movement +across pods and array. +When a volume is moved, the specified protection groups must be in the target pod or array. +Enter multiple names in a comma-separated format.

    +
    allow_throttle
    boolean

    If set to true, allows operation to fail if array health is not optimal.

    +
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    overwrite
    boolean

    If set to true, +overwrites an existing object during an object copy operation. +If set to false or not set at all and the target name is an existing object, +the copy operation fails. +Required if the source body parameter is set +and the source overwrites an existing object during the copy operation.

    +
    with_default_protection
    boolean

    If specified as true, the initial protection of the newly created volumes will be +the union of the container default protection configuration and +add_to_protection_group_names. +If specified as false, the default protection of the container will not be applied +automatically. The initial protection of the newly created volumes will be configured +by add_to_protection_group_names. +If not specified, defaults to true.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    destroyed
    boolean

    If set to true, destroys a resource. Once set to true, +the time_remaining value will display the amount of time left +until the destroyed resource is permanently eradicated. +Before the time_remaining period has elapsed, the destroyed resource +can be recovered by setting destroyed=false. +Once the time_remaining period has elapsed, +the resource is permanently eradicated and can no longer be recovered.

    +
    object (PriorityAdjustment)

    Adjusts volume priority.

    +
    object (ProtocolEndpoint)

    Sets the properties that are specific to protocol endpoints. +This can only be used in conjunction to subtype=protocol_endpoint.

    +
    provisioned
    integer <int64> <= 4503599627370496

    Sets the virtual size of the volume, measured in bytes.

    +
    object (Qos)

    Sets QoS limits.

    +
    object (Reference)

    The source volume of a volume copy.

    +
    subtype
    string

    The type of volume. Valid values are protocol_endpoint and regular.

    +
    Array of objects (Tag)

    The list of tags to be upserted with the object.

    +
    object (WorkloadConfigurationReference)

    The workload to which the volume is added. +Set one of id or name, and configuration to add the volume to the workload +and configure it based on the configuration from the preset the workload was +originally provisioned from.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "destroyed": true,
    • "priority_adjustment": {
      },
    • "protocol_endpoint": {
      },
    • "provisioned": 0,
    • "qos": {
      },
    • "source": {
      },
    • "subtype": "string",
    • "tags": [
      ],
    • "workload": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List volumes that are in volume groups

    Displays a list of volumes that are in a volume group.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Volume Groups

    Volume groups organize volumes into logical groupings. If virtual volumes are configured, each +volume group on the FlashArray array represents its associated virtual machine, and inside each +of those volumes groups are the FlashArray volumes that are assigned to the virtual machine. +Volume groups that are associated with virtual machines have names that begin with vvol- and +end with the virtual machine name.

    +

    List volume groups

    Displays a list of volume groups, including those pending eradication.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ],
    • "total": [
      ]
    }

    Create a volume group and upsert tags.

    Creates a volume group. The volume group itself does not contain any meaningful +content; instead, it acts as a container that is used to organize volumes. +Once a volume group has been created, volumes can be created inside the volume group or moved +into and out of the volume group.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (_priorityAdjustment)
    object (_qos)
    object (Space)
    Array of objects (Tag)

    The list of tags to be upserted with the object.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "priority_adjustment": {
      },
    • "qos": {
      },
    • "space": { },
    • "tags": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a volume group

    Deletes a volume group that has been destroyed and is pending eradication. +Eradicated volume groups cannot be recovered. +Volume groups are destroyed through the PATCH method. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    eradicate_contents
    boolean

    Set to true to eradicate contents (e.g., volumes, protection groups, snapshots) and containers +(e.g., realms, pods, volume groups). This enables you to eradicate containers with contents.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a volume group

    Modifies a volume group. You can rename, destroy, recover, or set QoS limits for a volume group. +To rename a volume group, set name to the new name. +To destroy a volume group, set destroyed=true. +To recover a volume group that has been destroyed and is pending eradication, set +destroyed=false. +Sets the bandwidth and IOPS limits of a volume group through the respective bandwidth_limit +and iops_limit parameter. The ids or names parameter is required, but they cannot be set +together. +Sets the priority adjustment for a volume group using the priority_adjustment_operator and +priority_adjustment_value fields.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    destroy_contents
    boolean

    Set to true to destroy contents (e.g., volumes, protection groups, snapshots) and containers +(e.g., realms, pods, volume groups), including eradicating containers with content.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    A user-specified name. +The name must be locally unique and can be changed.

    +
    destroyed
    boolean

    Returns a value of true if the volume group has been destroyed and is pending eradication. +Before the time_remaining period has elapsed, the destroyed volume group can be recovered +by setting destroyed=false. +After the time_remaining period has elapsed, the volume group is permanently eradicated +and cannot be recovered.

    +
    object (_priorityAdjustment)
    object (_qos)
    object (Space)

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "destroyed": true,
    • "priority_adjustment": {
      },
    • "qos": {
      },
    • "space": { }
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List volume group performance data

    Displays real-time and historical performance data, real-time latency data, and average I/O +sizes for each volume group and and as a total of all volume groups across the entire array.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ],
    • "total": [
      ]
    }

    List volume group space information

    Displays the provisioned size and physical storage consumption data +for each volume group.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    end_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resolution
    integer <int64> >= 0
    Example: resolution=30000

    The number of milliseconds between samples of historical data. +For array-wide performance metrics (/arrays/performance endpoint), +valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), +1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For performance metrics on storage objects (<object name>/performance endpoint), +such as volumes, +valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), +7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). +For space metrics, (<object name>/space endpoint), +valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), +28800000 (8 hours), and 86400000 (24 hours). +Include the start_time parameter to display the performance data +starting at the specified start time. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +Include the end_time parameter to display the performance data until the specified end time. +If end_timeis not specified, the end time will default to the current time. +If the resolution parameter is not specified +but either the start_time or end_time parameter is, +then resolution will default to the lowest valid resolution.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    start_time
    integer <int64>

    Displays historical performance data for the specified time window, +where start_time is the beginning of the time window, +and end_time is the end of the time window. +The start_time and end_time parameters +are specified in milliseconds since the UNIX epoch. +If start_time is not specified, +the start time will default to one resolution before the end time, +meaning that the most recent sample of performance data will be displayed. +If end_timeis not specified, the end time will default to the current time. +Include the resolution parameter to display the performance data at the specified resolution. +If not specified, resolution defaults to the lowest valid resolution.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "errors": [
      ],
    • "items": [
      ],
    • "total": [
      ]
    }

    List volume groups with volumes

    Displays a list of volume groups that contain volumes.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    group_ids
    Array of strings

    A comma-separated list of group IDs.

    +
    group_names
    Array of strings

    Performs the operation on the unique group name specified. +Examples of groups include host groups, pods, protection groups, and volume groups. +Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    member_ids
    Array of strings

    Performs the operation on the unique member IDs specified. +Enter multiple member IDs in comma-separated format. +The member_ids or member_names parameter is required, but they cannot be set together.

    +
    member_names
    Array of strings

    Performs the operation on the unique member name specified. +Examples of members include volumes, hosts, host groups, and directories. +Enter multiple names in comma-separated format. For example, vol01,vol02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    List tags

    Displays the list of tags.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resource_destroyed
    boolean

    If set to true, returns only objects from destroyed resources. Returns an error if +the name of a live resource is specified in the resource_names query parameter. +If set to false, returns only objects from live resources. Returns an error if the +name of a destroyed resource is specified in the resource_names query parameter.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Delete tags

    Deletes specified tags.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    keys
    Array of strings

    A comma-separated list of tag keys.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces. Only one namespace is allowed per delete request.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Update tags

    Updates tags for all specified objects.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    A list of tags to be created or, if one already exists, updated.

    +
    Array ()
    copyable
    boolean

    Specifies whether or not to include the tag when copying the parent resource. +If set to true, the tag is included in resource copying. +If set to false, the tag is not included. +If not specified, defaults to true.

    +
    key
    string

    Key of the tag. Supports up to 64 Unicode characters.

    +
    namespace
    string

    Optional namespace of the tag. +Namespace identifies the category of the tag. Omitting the namespace +defaults to the namespace default. The pure&#42; namespaces are +reserved for plugins and integration partners. It is recommended +that customers avoid using reserved namespaces.

    +
    object (Reference)

    A reference to the parent object.

    +
    value
    string

    Value of the tag. Supports up to 256 Unicode characters.

    +

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Volume Snapshots

    Volume snapshots are immutable, point-in-time images of the contents of one or more volumes. +There are two types of volume snapshots: volume snapshots and protection group volume +snapshots. A volume snapshot is a snapshot that captures the contents of a single volume. +A protection group volume snapshot is a volume snapshot that is created from a group of +volumes that are part of the same protection group. All of the volume snapshots created from a +protection group snapshot are point-in-time consistent with each other.

    +

    List volume snapshots

    Displays a list of volume snapshots, including those pending eradication.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ],
    • "total": [
      ]
    }

    Create a volume snapshot

    Creates a point-in-time snapshot of the contents of a volume. +The source_ids or source_names parameter is required, but they cannot be set together.

    +
    query Parameters
    allow_throttle
    boolean

    If set to true, allows snapshot to fail if array health is not optimal.

    +
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    on
    string

    Performs the operation on the target name specified. +For example, targetName01.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    destroyed
    boolean

    If set to true, destroys a resource. Once set to true, +the time_remaining value will display the amount of time left +until the destroyed resource is permanently eradicated. +Before the time_remaining period has elapsed, the destroyed resource +can be recovered by setting destroyed=false. +Once the time_remaining period has elapsed, +the resource is permanently eradicated and can no longer be recovered.

    +
    suffix
    string

    The suffix that is appended to the source_name value to generate the +full volume snapshot name in the form VOL.SUFFIX. +If the suffix is not specified, the system constructs the snapshot name +in the form VOL.NNN, where VOL is the volume name, and NNN is a +monotonically increasing number.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "destroyed": true,
    • "suffix": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a volume snapshot

    Deletes a volume snapshot that has been destroyed and is pending eradication. +Eradicated volume snapshots cannot be recovered. +Volume snapshots are destroyed by using the PATCH method. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    replication_snapshot
    boolean

    If set to true, allow destruction/eradication of snapshots in use by replication. +If set to false, allow destruction/eradication of snapshots not in use by replication. +If not specified, defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a volume snapshot

    Modifies a volume snapshot by renaming, destroying, or recovering it. +To rename the suffix of a volume snapshot, set name to the new suffix name. +To recover a volume snapshot that has been destroyed and is pending eradication, +set destroyed=true. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    replication_snapshot
    boolean

    If set to true, allow destruction/eradication of snapshots in use by replication. +If set to false, allow destruction/eradication of snapshots not in use by replication. +If not specified, defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    destroyed
    boolean

    If set to true, destroys a resource. Once set to true, +the time_remaining value will display the amount of time left +until the destroyed resource is permanently eradicated. +Before the time_remaining period has elapsed, the destroyed resource +can be recovered by setting destroyed=false. +Once the time_remaining period has elapsed, +the resource is permanently eradicated and can no longer be recovered.

    +
    name
    string

    The new name for the resource.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "destroyed": true,
    • "name": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List volume snapshots with transfer statistics

    Displays a list of volume snapshots and their transfer statistics.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    total_only
    boolean

    If set to true, returns the aggregate value of all items after filtering. +Where it makes more sense, the average value is displayed instead. +The values are displayed for each name where meaningful. +If total_only=true, the items list will be empty.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ],
    • "total": [
      ]
    }

    List tags

    Displays the list of tags.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    resource_destroyed
    boolean

    If set to true, returns only objects from destroyed resources. Returns an error if +the name of a live resource is specified in the resource_names query parameter. +If set to false, returns only objects from live resources. Returns an error if the +name of a destroyed resource is specified in the resource_names query parameter.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Delete tags

    Deletes specified tags.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    keys
    Array of strings

    A comma-separated list of tag keys.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces. Only one namespace is allowed per delete request.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Update tags

    Updates tags.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    A list of tags to be created or modified.

    +
    Array ()
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    copyable
    boolean

    Specifies whether or not to include the tag when copying the parent resource. +If set to true, the tag is included in resource copying. +If set to false, the tag is not included. +If not specified, defaults to true.

    +
    key
    string

    Key of the tag. Supports up to 64 Unicode characters.

    +
    namespace
    string

    Optional namespace of the tag. +Namespace identifies the category of the tag. Omitting the namespace +defaults to the namespace default. The pure&#42; namespaces are +reserved for plugins and integration partners. It is recommended +that customers avoid using reserved namespaces.

    +
    object (_fixedReference)
    value
    string

    Value of the tag. Supports up to 256 Unicode characters.

    +

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Create the volume snapshot path

    Creates the volume snapshot path without actually taking a volume snapshot.

    +
    query Parameters
    allow_throttle
    boolean

    If set to true, allows snapshot to fail if array health is not optimal.

    +
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    on
    string

    Performs the operation on the target name specified. +For example, targetName01.

    +
    source_ids
    Array of strings

    Performs the operation on the source ID specified. +Enter multiple source IDs in comma-separated format.

    +
    source_names
    Array of strings

    Performs the operation on the source name specified. +Enter multiple source names in comma-separated format. For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    destroyed
    boolean

    If set to true, destroys a resource. Once set to true, +the time_remaining value will display the amount of time left +until the destroyed resource is permanently eradicated. +Before the time_remaining period has elapsed, the destroyed resource +can be recovered by setting destroyed=false. +Once the time_remaining period has elapsed, +the resource is permanently eradicated and can no longer be recovered.

    +
    suffix
    string

    The suffix that is appended to the source_name value to generate the +full volume snapshot name in the form VOL.SUFFIX. +If the suffix is not specified, the system constructs the snapshot name +in the form VOL.NNN, where VOL is the volume name, and NNN is a +monotonically increasing number.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "destroyed": true,
    • "suffix": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Workloads

    Workloads organize storage resources (such as volumes) and their related configuration and +policy objects into logical groupings. Workloads can be deployed from workload presets.

    +

    List workload placement recommendations

    Displays a list of placement recommendations for workloads.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create a request for a workload placement recommendation.

    Creates a recommendation for the placement of the specified workload. +The computation might take a few minutes.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    placement_names
    Array of strings

    Placements from the preset which should be used to compute recommendation. +Optional parameter if preset has just one placement.

    +
    preset_ids
    Array of strings

    Creates the workload placement recommendations using the presets +specified by ids. Only one preset can be specified. One of the +preset_ids or preset_names parameters are required, but they +cannot be set together.

    +
    preset_names
    Array of strings

    Creates the workload placement recommendations using the presets +specified by names. Only one preset can be specified. One of the +preset_ids or preset_names parameters are required, but they +cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (FixedReference)

    The context in which the operation was performed. +Valid values include a reference to any array which is a member of the same fleet. +If the array is not a member of a fleet, context will always implicitly be set +to the array that received the request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    object (_workloadPlacementRecommendationAdditionalConstraints)

    The list of targets considered for workload placement must +satisfy the requirements imposed by the preset. It is +also possible to specify additional constraints to further restrict the +list of targets for consideration.

    +
    Array of objects (_workloadParameter)

    The parameter values to pass to the preset. +Value must be supplied for all parameters that do not have a default +defined in the preset.

    +
    object (FixedReference)
    projection_months
    integer <int32>

    The number of months to compute the projections. +If not specified, defaults to 1 month.

    +
    results_limit
    integer <int32>

    The maximum number of results to return. +If not specified, defaults to 10 results.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "context": { },
    • "additional_constraints": {
      },
    • "parameters": [
      ],
    • "preset": { },
    • "projection_months": 0,
    • "results_limit": 0
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List workloads

    Displays a list of workloads.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Create a workload

    Creates one workload.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    names
    required
    Array of strings

    Performs the operation on the unique resource names specified. +Only one value is supported.

    +
    preset_ids
    Array of strings

    Create the resource using the preset specified by the ID. Only one preset can be specified. +One of the preset_ids or preset_names parameters are required, but they cannot be +set together.

    +
    preset_names
    Array of strings

    Create the resource using the preset specified by name. Only one preset can be specified. +One of the preset_ids or preset_names parameters are required, but they cannot be +set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_workloadParameter)

    The parameter values to pass to the preset when creating the workload. +Value must be supplied for all parameters that do not have a default defined in the preset.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "parameters": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a workload

    Deletes a workload that has been destroyed and is pending eradication. +Eradicated workloads cannot be recovered. +Workloads are destroyed using the PATCH method. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Only one value is supported.

    +
    names
    Array of strings

    Performs the operation on the unique resource names specified. +Only one value is supported.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a workload

    Modifies a workload by renaming or destroying it. +To rename a workload, set name to the new name. To destroy a workload, set destroyed=true. +To recover a workload that has been destroyed and is pending eradication, set destroyed=false. +The ids or names parameter is required, but they cannot be set together.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Only one value is supported.

    +
    names
    Array of strings

    Performs the operation on the unique resource names specified. +Only one value is supported.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    destroyed
    boolean

    If set to true, destroys a resource. Once set to true, +the time_remaining value will display the amount of time left +until the destroyed resource is permanently eradicated. +Before the time_remaining period has elapsed, the destroyed resource +can be recovered by setting destroyed=false. +Once the time_remaining period has elapsed, +the resource is permanently eradicated and can no longer be recovered.

    +
    name
    string

    The new name for the resource.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "destroyed": true,
    • "name": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List tags

    Displays the list of tags.

    +
    query Parameters
    allow_errors
    boolean
    Default: false

    If set to true, the API will allow the operation to continue even if there are errors. +Any errors will be returned in the errors field of the response. +If set to false, the operation will fail if there are any errors.

    +
    context_names
    Array of strings

    Performs the operation on the unique contexts specified. +If specified, each context name must be the name of an array in the same fleet. +If not specified, the context will default to the array that received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +

    Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ],
    • "errors": [
      ]
    }

    Delete tags

    Deletes specified tags.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    keys
    Array of strings

    A comma-separated list of tag keys.

    +
    namespaces
    Array of strings

    A comma-separated list of namespaces. Only one namespace is allowed per delete request.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Update tags

    Updates or creates tags for all specified objects.

    +
    query Parameters
    context_names
    Array of strings

    Performs the operation on the context specified. If specified, the context names +must be an array of size 1, and the single element must be the name of an array +in the same fleet. If not specified, the context will default to the array that +received this request.

    +

    Other parameters provided with the request, such as names of volumes or snapshots, +are resolved relative to the provided context.

    +
    resource_ids
    Array of strings

    A comma-separated list of resource IDs. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    resource_names
    Array of strings

    A comma-separated list of resource names. +The resource_ids or resource_names parameter is required, but they cannot be set together.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json

    A list of tags to be created or, if they already exist, updated.

    +
    Array ()
    copyable
    boolean

    Specifies whether or not to include the tag when copying the parent resource. +If set to true, the tag is included in resource copying. +If set to false, the tag is not included. +If not specified, defaults to true.

    +
    key
    string

    Key of the tag. Supports up to 64 Unicode characters.

    +
    namespace
    string

    Optional namespace of the tag. +Namespace identifies the category of the tag. Omitting the namespace +defaults to the namespace default. The pure&#42; namespaces are +reserved for plugins and integration partners. It is recommended +that customers avoid using reserved namespaces.

    +
    object (Reference)

    A reference to the parent object.

    +
    value
    string

    Value of the tag. Supports up to 256 Unicode characters.

    +

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Files

    Create a file copy

    Creates a file copy from one path to another path. +The directory_ids, directory_names or paths value must be specified. +If the directory_ids or directory_names value is not specified, the file is copied to the +source directory specified in the body params. +The paths value refers to the path of the target file relative to the target directory. +If paths value is not specified, the file will be copied to the relative path specified +in source_path under the target directory. +The source_path value refers to the path of the source file relative to the source directory. +To overwrite an existing file, set the overwrite flag to true.

    +
    query Parameters
    directory_ids
    Array of strings

    Performs the operation on the unique managed directory IDs specified. +Enter multiple managed directory IDs in comma-separated format. +The directory_ids or directory_names parameter is required, but they cannot be set together.

    +
    directory_names
    Array of strings

    Performs the operation on the managed directory names specified. +Enter multiple full managed directory names in comma-separated format. +For example, fs:dir01,fs:dir02.

    +
    overwrite
    boolean

    If set to true, +overwrites an existing object during an object copy operation. +If set to false or not set at all and the target name is an existing object, +the copy operation fails. +Required if the source body parameter is set +and the source overwrites an existing object during the copy operation.

    +
    paths
    Array of strings

    Target file path relative to the target directory. +Enter multiple target file path in a comma-separated format. +For example, /dir1/dir2/file1,/dir3/dir4/file2.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (ReferenceWithType)

    The source information of a file copy.

    +
    source_path
    string

    The source file path relative to the source directory.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "source": {
      },
    • "source_path": "string"
    }

    Resource Accesses

    List resource access configurations

    Displays a list of configured resource accesses.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Delete a resource access configuration

    Deletes a resource access object.

    +
    query Parameters
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Create a resource access configuration

    Creates resource access objects.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array ()
    object (ReferenceWithType)

    Resource to which the scope has access.

    +
    object (ReferenceWithType)

    Scope which has access to the resource.

    +

    Responses

    Request samples

    Content type
    application/json
    [
    • {
      }
    ]

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List status of resource accesses as specified by resource access configuration

    Displays a list of effective resource accesses.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Vchosts

    List vchosts

    Displays a list of vchosts.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create a vchost

    Creates a vchost. +The names query parameter is required.

    +
    query Parameters
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    vcuuid
    string

    The vCenter Server uuid of the vchost.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "vcuuid": "ddf43502-4e00-405e-b341-e87e7eaa13f6"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a vchost

    Deletes an existing vchost. +The names or ids query parameter is required.

    +
    query Parameters
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a vchost

    Modifies an existing vchost. +The names or ids query parameter is required.

    +
    query Parameters
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    names
    Array of strings

    Performs the operation on the unique name specified. +Enter multiple names in comma-separated format. +For example, name01,name02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    name
    string

    The new name of the vchost.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "vchost-b"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List vchost certificates

    Displays certificates that are attached to configured vchosts on at least one endpoint.

    +
    query Parameters
    certificate_names
    Array of strings

    The names of one or more certificates. +Enter multiple names in comma-separated format. +For example, cert01,cert02.

    +
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    vchost_ids
    Array of strings

    Performs the operation on the unique vchost IDs specified. +Enter multiple vchost IDs in a comma-separated format. +For example, vchostid01,vchostid02.

    +
    vchost_names
    Array of strings

    Performs the operation on the unique vchost name specified. +Enter multiple names in a comma-separated format. +For example, vchost01,vchost02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create a vchost certificate

    Creates an association between a certificate and vchost on one or more endpoints. +The vchost_names or vchost_ids query parameter is required.

    +
    query Parameters
    vchost_ids
    Array of strings

    Performs the operation on the unique vchost IDs specified. +Enter multiple vchost IDs in a comma-separated format. +For example, vchostid01,vchostid02.

    +
    vchost_names
    Array of strings

    Performs the operation on the unique vchost name specified. +Enter multiple names in a comma-separated format. +For example, vchost01,vchost02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    object (ReferenceNoIdWithType)

    The certificate to be presented by the vchost over the configured endpoints.

    +
    endpoints
    Array of strings

    The IPv4 or IPv6 addresses of the endpoints to configure for the vchost, over which the +configured certificate will be presented.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "certificate": {
      },
    • "endpoints": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a vchost certificate

    Deletes an existing vchost certificate. +The ids query parameter alone, or the certificate_names +query parameter together with one of vchost_names or vchost_ids, is required.

    +
    query Parameters
    certificate_names
    Array of strings

    The names of one or more certificates. +Enter multiple names in comma-separated format. +For example, cert01,cert02.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    vchost_ids
    Array of strings

    Performs the operation on the unique vchost IDs specified. +Enter multiple vchost IDs in a comma-separated format. +For example, vchostid01,vchostid02.

    +
    vchost_names
    Array of strings

    Performs the operation on the unique vchost name specified. +Enter multiple names in a comma-separated format. +For example, vchost01,vchost02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a vchost certificate

    Modifies an existing vchost certificate. +The ids query parameter alone, or the certificate_names query parameter together +with one of vchost_names or vchost_ids, is required.

    +
    query Parameters
    certificate_names
    Array of strings

    The names of one or more certificates. +Enter multiple names in comma-separated format. +For example, cert01,cert02.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    vchost_ids
    Array of strings

    Performs the operation on the unique vchost IDs specified. +Enter multiple vchost IDs in a comma-separated format. +For example, vchostid01,vchostid02.

    +
    vchost_names
    Array of strings

    Performs the operation on the unique vchost name specified. +Enter multiple names in a comma-separated format. +For example, vchost01,vchost02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    endpoints
    Array of strings

    The IPv4 or IPv6 addresses of the endpoints to configure for the vchost, over which the +configured certificate will be presented.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "endpoints": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List vchost endpoints

    Displays a list of vchost endpoints with their associated vchosts and certificates.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    endpoints
    Array of strings

    Performs the operation on the unique endpoints specified. +Enter multiple endpoints in a comma-separated format.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    vchost_ids
    Array of strings

    Performs the operation on the unique vchost IDs specified. +Enter multiple vchost IDs in a comma-separated format. +For example, vchostid01,vchostid02.

    +
    vchost_names
    Array of strings

    Performs the operation on the unique vchost name specified. +Enter multiple names in a comma-separated format. +For example, vchost01,vchost02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create a vchost endpoint

    Creates a vchost endpoint. +Either the vchost_names or vchost_ids query parameter is required.

    +
    query Parameters
    vchost_ids
    Array of strings

    Performs the operation on the unique vchost IDs specified. +Enter multiple vchost IDs in a comma-separated format. +For example, vchostid01,vchostid02.

    +
    vchost_names
    Array of strings

    Performs the operation on the unique vchost name specified. +Enter multiple names in a comma-separated format. +For example, vchost01,vchost02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_referenceNoIdWithType)

    The certificate to be presented by the vchost over the configured endpoints.

    +
    endpoint
    string

    The IPv4 or IPv6 address of the endpoint.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "certificates": [
      ],
    • "endpoint": "1.2.3.4"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Delete a vchost endpoint

    Deletes an existing vchost endpoint +The ids query parameter alone, or the endpoints query parameter together with +one of vchost_names or vchost_ids, is required.

    +
    query Parameters
    endpoints
    Array of strings

    Performs the operation on the unique endpoints specified. +Enter multiple endpoints in a comma-separated format.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    vchost_ids
    Array of strings

    Performs the operation on the unique vchost IDs specified. +Enter multiple vchost IDs in a comma-separated format. +For example, vchostid01,vchostid02.

    +
    vchost_names
    Array of strings

    Performs the operation on the unique vchost name specified. +Enter multiple names in a comma-separated format. +For example, vchost01,vchost02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Modify a vchost endpoint

    Modifies an existing vchost endpoint. +The ids query parameter alone, or the endpoints query parameter together with +one of vchost_names or vchost_ids, is required.

    +
    query Parameters
    endpoints
    Array of strings

    Performs the operation on the unique endpoints specified. +Enter multiple endpoints in a comma-separated format.

    +
    ids
    Array of strings

    Performs the operation on the unique resource IDs specified. +Enter multiple resource IDs in comma-separated format. +The ids or names parameter is required, but they cannot be set together.

    +
    vchost_ids
    Array of strings

    Performs the operation on the unique vchost IDs specified. +Enter multiple vchost IDs in a comma-separated format. +For example, vchostid01,vchostid02.

    +
    vchost_names
    Array of strings

    Performs the operation on the unique vchost name specified. +Enter multiple names in a comma-separated format. +For example, vchost01,vchost02.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    Array of objects (_referenceNoIdWithType)

    The certificate to be presented by the vchost over the configured endpoints.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "certificates": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Virtual Machines

    List Virtual Machines

    Displays a list of virtual machines, including those pending eradication. +If vm_type is vvol, the recovery_context in the response will represent +the most recent snapshot of the config vVol. This must be used as the source in +the PATCH method when recovering a virtual machine from the destroyed state.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    vm_ids
    Array of strings

    Performs the operation on the unique virtual machine IDs specified. +Enter multiple virtual machine IDs in a comma-separated format.

    +
    vm_type
    string

    The type of virtual machine. +The only valid value is vvol.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    Create a virtual machine

    Creates one or more virtual machines from a protection group snapshot. +If the virtual machine is of type vvol, the source property of the request body must +be a recovery_context value retrieved from the GET /virtual-machine-snapshots endpoint. +If overwrite is specified, an existing virtual machine will have its volumes overwritten by +the snapshot. Otherwise, a new virtual machine will be created from the snapshot. +If creating the new virtual machine will cause a conflict with an existing virtual machine, the +operation will fail.

    +
    query Parameters
    overwrite
    boolean

    If set to true, +overwrites an existing object during an object copy operation. +If set to false or not set at all and the target name is an existing object, +the copy operation fails. +Required if the source body parameter is set +and the source overwrites an existing object during the copy operation.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    id
    string

    The ID of the virtual machine to create or modify, as assigned by the external system. +id is deprecated. Use vm_id instead.

    +
    object (Reference)

    The recovery context for the virtual machine or virtual machine snapshot +being modified.

    +
    vm_id
    string

    The ID of the virtual machine to create or modify, as assigned by the external system.

    +
    vm_type
    string

    The type of virtual machine. +The only valid value is vvol.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "id": "string",
    • "source": {
      },
    • "vm_id": "string",
    • "vm_type": "vvol"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    Update a virtual machine

    Updates a virtual machine, recovering it from the destroyed state. +If the virtual machine is of type vvol, the source property of the request body must +be a recovery_context value retrieved from the GET /virtual-machines endpoint. +If recovering the virtual machine will cause a conflict with an existing virtual machine, the +operation will fail.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +
    Request Body schema: application/json
    id
    string

    The ID of the virtual machine to create or modify, as assigned by the external system. +id is deprecated. Use vm_id instead.

    +
    object (Reference)

    The recovery context for the virtual machine or virtual machine snapshot +being modified.

    +
    vm_id
    string

    The ID of the virtual machine to create or modify, as assigned by the external system.

    +
    vm_type
    string

    The type of virtual machine. +The only valid value is vvol.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "id": "string",
    • "source": {
      },
    • "vm_id": "string",
    • "vm_type": "vvol"
    }

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    List Virtual Machine Volume Snapshots

    Displays a list of virtual machine volume snapshots, including those pending eradication. +If vm_type is vvol, the recover_context in the response will represent +a protection group snapshot containing the virtual machine volume.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    vm_ids
    required
    Array of strings

    Performs the operation on the unique virtual machine IDs specified. +Enter multiple resource IDs in a comma-separated format.

    +
    vm_type
    string

    The type of virtual machine. +The only valid value is vvol.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }

    List Virtual Machine Snapshots

    Displays a list of virtual machine snapshots, including those pending eradication. +If vm_type is vvol, the recovery_context in the response will represent +a protection group snapshot containing the virtual machine. This must be used as +the source in the POST /virtual-machine method when recovering or overwriting a +virtual machine from a snapshot.

    +
    query Parameters
    continuation_token
    string

    A token used to retrieve the next page of data +with some consistency guaranteed. +The token is a Base64 encoded value. +Set continuation_token to the system-generated token taken from the x-next-token +header field of the response. +A query has reached its last page when the response does not include a token. +Pagination requires the limit and continuation_token +query parameters.

    +
    destroyed
    boolean

    If set to true, lists only destroyed objects +that are in the eradication pending state. +If set to false, lists only objects that are not destroyed. +For destroyed objects, the time remaining is displayed in milliseconds.

    +
    filter
    string

    Narrows down the results to only the response objects +that satisfy the filter criteria.

    +
    limit
    integer <int32> >= 0
    Example: limit=10

    Limits the size of the response to the specified number of objects on each page. +To return the total number of resources, set limit=0. +The total number of resources is returned as a total_item_count value. +If the page size requested is larger than the system maximum limit, +the server returns the maximum limit, disregarding the requested page size.

    +
    offset
    integer <int32> >= 0
    Example: offset=10

    The starting position based on the results of the query +in relation to the full set of response objects returned.

    +
    sort
    Array of strings

    Returns the response objects in the order specified. +Set sort to the name in the response by which to sort. +Sorting can be performed on any of the names in the response, +and the objects can be sorted in ascending or descending order. +By default, the response objects are sorted in ascending order. +To sort in descending order, append the minus sign (-) to the name. +A single request can be sorted on multiple objects. +For example, you can sort all volumes from largest to smallest volume size, +and then sort volumes of the same size in ascending order by volume name. +To sort on multiple names, list the names as comma-separated values.

    +
    total_item_count
    boolean

    If set to true, the total_item_count matching the +specified query parameters is calculated and returned in +the response. If set to false, the total_item_count +is null in the response. This may speed up queries +where the total_item_count is large. If not specified, +defaults to false.

    +
    vm_ids
    Array of strings

    Performs the operation on the unique virtual machine IDs specified. +Enter multiple resource IDs in a comma-separated format.

    +
    vm_type
    string

    The type of virtual machine. +The only valid value is vvol.

    +
    header Parameters
    Authorization
    string

    Access token (in JWT format) required to use any API +endpoint (except /oauth2, /login, and /logout)

    +
    X-Request-ID
    string

    Supplied by client during request or generated by server.

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "continuation_token": "string",
    • "more_items_remaining": false,
    • "total_item_count": 0,
    • "items": [
      ]
    }
    + + + + \ No newline at end of file