{
  "opencollection": "1.0.0",
  "info": {
    "name": "FlashArray REST Active Directory Presets API",
    "version": "2.52"
  },
  "items": [
    {
      "info": {
        "name": "Presets",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Pure Storage List Workload Presets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/2.52/presets/workload",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n  if ids or names is not provided, but it cannot be used together with name or names.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique names specified.\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n\nIf there is not at least one resource that matches\neach of the elements of `names`, then an error is returned,\nexcept when creating new resources.\n"
              }
            ]
          },
          "docs": "Displays a list of workload presets.\n"
        },
        {
          "info": {
            "name": "Pure Storage Create a Workload Preset",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/2.52/presets/workload",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique resource names specified.\nOnly one value is supported.\n"
              },
              {
                "name": "skip_verify_deployable",
                "value": "",
                "type": "query",
                "description": "If set to `true`, only the most basic syntax checks are performed on the preset to ensure it\nis valid, but it is possible that it includes configuration that no array in the current fleet\ncan honor when creating a workload. This is primarily useful when uploading a preset created\nelsewhere so it can be edited until it is deployable.\nIf set to `false`, when a workload preset is created or updated, arrays in the fleet are queried\nto ensure at least one array in the fleet can deploy a workload based on the configuration\nspecified in the preset.\nDefaults to `false`.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates one workload preset.\n"
        },
        {
          "info": {
            "name": "Pure Storage Update a Workload Preset",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/2.52/presets/workload",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique resource IDs specified.\nOnly one value is supported.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique resource names specified.\nOnly one value is supported.\n"
              },
              {
                "name": "skip_verify_deployable",
                "value": "",
                "type": "query",
                "description": "If set to `true`, only the most basic syntax checks are performed on the preset to ensure it\nis valid, but it is possible that it includes configuration that no array in the current fleet\ncan honor when creating a workload. This is primarily useful when uploading a preset created\nelsewhere so it can be edited until it is deployable.\nIf set to `false`, when a workload preset is created or updated, arrays in the fleet are queried\nto ensure at least one array in the fleet can deploy a workload based on the configuration\nspecified in the preset.\nDefaults to `false`.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a workload preset by replacing it with the new contents in `preset`.\nThe `ids` or `names` parameter is required, but they cannot be set together.\n"
        },
        {
          "info": {
            "name": "Pure Storage Modify a Workload Preset",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/2.52/presets/workload",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique resource IDs specified.\nOnly one value is supported.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique resource names specified.\nOnly one value is supported.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies a workload preset by overriding the fields specified in `preset`.\nTo rename a workload preset, set name to the new name.\n"
        },
        {
          "info": {
            "name": "Pure Storage Delete a Workload Preset",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/2.52/presets/workload",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique resource IDs specified.\nOnly one value is supported.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique resource names specified.\nOnly one value is supported.\n"
              }
            ]
          },
          "docs": "Deletes a workload preset permanently.\nThe `ids` or `names` parameter is required, but they cannot be set together.\n"
        },
        {
          "info": {
            "name": "Pure Storage List Workload Presets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/2.26/presets/workload",
            "headers": [
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of resource IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `ids`, then an error is returned.\nThis cannot be provided together with the `name` or `names` query parameters.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique names specified.\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n\nIf there is not at least one resource that matches\neach of the elements of `names`, then an error is returned,\nexcept when creating new resources.\n"
              }
            ]
          },
          "docs": "Displays a list of workload presets.\n"
        },
        {
          "info": {
            "name": "Pure Storage Create a Workload Preset",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/2.26/presets/workload",
            "headers": [
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique resource names specified.\nOnly one value is supported.\n"
              },
              {
                "name": "skip_verify_deployable",
                "value": "",
                "type": "query",
                "description": "If set to `true`, only the most basic syntax checks are performed on the preset to ensure it\nis valid, but it is possible that it includes configuration that no array in the current fleet\ncan honor when creating a workload. This is primarily useful when uploading a preset created\nelsewhere so it can be edited until it is deployable.\nIf set to `false`, when a workload preset is created or updated, arrays in the fleet are queried\nto ensure at least one array in the fleet can deploy a workload based on the configuration\nspecified in the preset.\nDefaults to `false`.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates one workload preset.\n"
        },
        {
          "info": {
            "name": "Pure Storage Update a Workload Preset",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/2.26/presets/workload",
            "headers": [
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique resource IDs specified.\nOnly one value is supported.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique resource names specified.\nOnly one value is supported.\n"
              },
              {
                "name": "skip_verify_deployable",
                "value": "",
                "type": "query",
                "description": "If set to `true`, only the most basic syntax checks are performed on the preset to ensure it\nis valid, but it is possible that it includes configuration that no array in the current fleet\ncan honor when creating a workload. This is primarily useful when uploading a preset created\nelsewhere so it can be edited until it is deployable.\nIf set to `false`, when a workload preset is created or updated, arrays in the fleet are queried\nto ensure at least one array in the fleet can deploy a workload based on the configuration\nspecified in the preset.\nDefaults to `false`.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a workload preset by replacing it with the new contents in `preset`.\nThe `ids` or `names` parameter is required, but they cannot be set together.\n"
        },
        {
          "info": {
            "name": "Pure Storage Modify a Workload Preset",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/2.26/presets/workload",
            "headers": [
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique resource IDs specified.\nOnly one value is supported.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique resource names specified.\nOnly one value is supported.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies a workload preset by overriding the fields specified in `preset`.\nTo rename a workload preset, set name to the new name.\n"
        },
        {
          "info": {
            "name": "Pure Storage Delete a Workload Preset",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/2.26/presets/workload",
            "headers": [
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "context_names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique resource IDs specified.\nOnly one value is supported.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "Performs the operation on the unique resource names specified.\nOnly one value is supported.\n"
              }
            ]
          },
          "docs": "Deletes a workload preset permanently.\nThe `ids` or `names` parameter is required, but they cannot be set together.\n"
        }
      ]
    }
  ],
  "bundled": true
}