{
  "opencollection": "1.0.0",
  "info": {
    "name": "FlashArray REST Active Directory Log Targets API",
    "version": "2.52"
  },
  "items": [
    {
      "info": {
        "name": "Log Targets",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Pure Storage List Log Targets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/2.52/log-targets",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "allow_errors",
                "value": "",
                "type": "query",
                "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n"
              },
              {
                "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": "continuation_token",
                "value": "",
                "type": "query",
                "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n"
              },
              {
                "name": "limit",
                "value": "10",
                "type": "query",
                "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\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"
              },
              {
                "name": "offset",
                "value": "10",
                "type": "query",
                "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n"
              },
              {
                "name": "total_item_count",
                "value": "",
                "type": "query",
                "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n"
              }
            ]
          },
          "docs": "Displays a list of configured log targets."
        },
        {
          "info": {
            "name": "Pure Storage List File Log Targets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/2.52/log-targets/file",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "allow_errors",
                "value": "",
                "type": "query",
                "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n"
              },
              {
                "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": "continuation_token",
                "value": "",
                "type": "query",
                "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n"
              },
              {
                "name": "limit",
                "value": "10",
                "type": "query",
                "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\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"
              },
              {
                "name": "offset",
                "value": "10",
                "type": "query",
                "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n"
              },
              {
                "name": "total_item_count",
                "value": "",
                "type": "query",
                "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n"
              }
            ]
          },
          "docs": "Displays a list of configured file log targets."
        },
        {
          "info": {
            "name": "Pure Storage Create File Log Target",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/2.52/log-targets/file",
            "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 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"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new file log target.\n"
        },
        {
          "info": {
            "name": "Pure Storage Modify File Log Target",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/2.52/log-targets/file",
            "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 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"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies the URI of a configured file log target."
        },
        {
          "info": {
            "name": "Pure Storage Delete File Log Target",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/2.52/log-targets/file",
            "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 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": "Deletes a configured file log target."
        },
        {
          "info": {
            "name": "Pure Storage List Syslog Servers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/2.52/log-targets/syslog",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "allow_errors",
                "value": "",
                "type": "query",
                "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n"
              },
              {
                "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": "continuation_token",
                "value": "",
                "type": "query",
                "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n"
              },
              {
                "name": "limit",
                "value": "10",
                "type": "query",
                "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\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"
              },
              {
                "name": "offset",
                "value": "10",
                "type": "query",
                "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n"
              },
              {
                "name": "total_item_count",
                "value": "",
                "type": "query",
                "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n"
              }
            ]
          },
          "docs": "Displays a list of configured syslog servers.\n"
        },
        {
          "info": {
            "name": "Pure Storage Create Syslog Server",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/2.52/log-targets/syslog",
            "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 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"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new syslog server.\n"
        },
        {
          "info": {
            "name": "Pure Storage Modify Syslog Server",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/2.52/log-targets/syslog",
            "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 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"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies the URI and services of a configured syslog server.\n"
        },
        {
          "info": {
            "name": "Pure Storage Delete Syslog Server",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/2.52/log-targets/syslog",
            "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 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": "Deletes a configured syslog server and stop forwarding syslog messages.\n"
        },
        {
          "info": {
            "name": "Pure Storage List Syslog Settings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/2.52/log-targets/syslog/settings",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "allow_errors",
                "value": "",
                "type": "query",
                "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n"
              },
              {
                "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": "continuation_token",
                "value": "",
                "type": "query",
                "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n"
              },
              {
                "name": "limit",
                "value": "10",
                "type": "query",
                "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n"
              },
              {
                "name": "offset",
                "value": "10",
                "type": "query",
                "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n"
              },
              {
                "name": "total_item_count",
                "value": "",
                "type": "query",
                "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n"
              }
            ]
          },
          "docs": "Displays syslog settings. Values include `continuation_token`, `items`,\n`more_items_remaining`, and `total_item_count`.\n"
        },
        {
          "info": {
            "name": "Pure Storage Modify Syslog Settings",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/2.52/log-targets/syslog/settings",
            "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"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies syslog settings. Values include `continuation_token`, `items`,\n`more_items_remaining`, and `total_item_count`.\n"
        },
        {
          "info": {
            "name": "Pure Storage List Syslog Server Test Results",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/2.52/log-targets/syslog/test",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "allow_errors",
                "value": "",
                "type": "query",
                "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n"
              },
              {
                "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": "continuation_token",
                "value": "",
                "type": "query",
                "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n"
              },
              {
                "name": "limit",
                "value": "10",
                "type": "query",
                "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n"
              },
              {
                "name": "offset",
                "value": "10",
                "type": "query",
                "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n"
              },
              {
                "name": "total_item_count",
                "value": "",
                "type": "query",
                "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n"
              }
            ]
          },
          "docs": "Displays syslog server test results, which indicate whether the syslog is working and configured correctly."
        }
      ]
    }
  ],
  "bundled": true
}