Pure Storage · Schema

Policy

Policy schema from FlashArray REST API

StorageData StorageFlash StorageEnterprise StorageCloud StorageObject StorageFile StorageBlock StorageKubernetes StorageInfrastructure
View JSON Schema on GitHub

JSON Schema

flasharray-rest-api-policy-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Policy",
  "description": "Policy schema from FlashArray REST API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-policy-schema.json",
  "allOf": [
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/_resource"
        },
        {
          "$ref": "#/components/schemas/_context"
        },
        {
          "type": "object",
          "properties": {
            "policy_type": {
              "description": "The type of policy. Values include `autodir`, `network-access`, `nfs`, `smb`, `snapshot`,\n`quota`, and `object-store-access`.\n",
              "type": "string",
              "readOnly": true
            }
          }
        }
      ]
    },
    {
      "type": "object",
      "properties": {
        "destroyed": {
          "description": "Returns a value of `true` if the policy has been destroyed and is pending\neradication.\nThe `time_remaining` value displays the amount of time left\nuntil the destroyed policy is permanently eradicated.\nOnce the `time_remaining` period has elapsed,\nthe policy is permanently eradicated and can no longer be recovered.\n",
          "type": "boolean"
        },
        "enabled": {
          "description": "Returns a value of `true` if the policy is enabled.\n",
          "type": "boolean"
        },
        "pod": {
          "description": "A reference to the pod.\n",
          "title": "Reference",
          "allOf": [
            {
              "$ref": "#/components/schemas/_reference"
            }
          ]
        },
        "time_remaining": {
          "description": "The amount of time left, measured in milliseconds, until the destroyed policy is\npermanently eradicated.\n",
          "type": "integer",
          "format": "int64",
          "readOnly": true
        }
      }
    }
  ]
}