{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Policies - TLS API", "version": "2.52" }, "items": [ { "info": { "name": "Policies - TLS", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage GET Network-interfaces/tls-policies", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/network-interfaces/tls-policies", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `member_ids`, then an error is returned.\nThis cannot be provided together with the `member_names` query parameter.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "A comma-separated list of policy IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `policy_ids`, then an error is returned.\nThis cannot be provided together with the `policy_names` query parameter.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nNOTE: If you provide a sort you will not get a `continuation_token` in\nthe response.\n" } ] }, "docs": "List network interface TLS policies." }, { "info": { "name": "Pure Storage POST Network-interfaces/tls-policies", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/network-interfaces/tls-policies", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `member_ids`, then an error is returned.\nThis cannot be provided together with the `member_names` query parameter.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "A comma-separated list of policy IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `policy_ids`, then an error is returned.\nThis cannot be provided together with the `policy_names` query parameter.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\n" } ] }, "docs": "Apply a TLS policy to a specific network interface. A given network interface may only have 1 TLS policy applied to it at any given time." }, { "info": { "name": "Pure Storage DELETE Network-interfaces/tls-policies", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/network-interfaces/tls-policies", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `member_ids`, then an error is returned.\nThis cannot be provided together with the `member_names` query parameter.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "A comma-separated list of policy IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `policy_ids`, then an error is returned.\nThis cannot be provided together with the `policy_names` query parameter.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\n" } ] }, "docs": "Remove a TLS policy from a network interface." }, { "info": { "name": "Pure Storage List TLS Policies", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/tls-policies", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "effective", "value": "", "type": "query", "description": "If `true`, then the TLS policies returned will be fully evaluated. This\ninvolves expanding shortened TLS ciphers, removing disabled TLS ciphers from\nthe list of expanded enabled TLS ciphers, and converting values such as\n`default` and `legacy` into concrete values, in order to return the discrete\neffective TLS settings that the policies encode.\nDefaults to `false`.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\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": "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 offset of the first resource to return from a collection.\n" }, { "name": "purity_defined", "value": "", "type": "query", "description": "If `true`, then the results returned will be include the specification\nfor purity-defined values on the current purity version. These values\nmay be used in configurations in order to dynamically adopt new behavior\nacross upgrades, and this option allows the exact behavior for the current\nversion to be returned.\nDefaults to `false`.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nNOTE: If you provide a sort you will not get a `continuation_token` in\nthe response.\n" } ] }, "docs": "List TLS policies" }, { "info": { "name": "Pure Storage Create TLS Policies", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/tls-policies", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates TLS policies." }, { "info": { "name": "Pure Storage Modify TLS Policies", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/tls-policies", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies one or more attributes of TLS policies." }, { "info": { "name": "Pure Storage Delete TLS Policies", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/tls-policies", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "Deletes TLS policies." }, { "info": { "name": "Pure Storage GET Tls-policies/members", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/tls-policies/members", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `member_ids`, then an error is returned.\nThis cannot be provided together with the `member_names` query parameter.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "A comma-separated list of policy IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `policy_ids`, then an error is returned.\nThis cannot be provided together with the `policy_names` query parameter.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nNOTE: If you provide a sort you will not get a `continuation_token` in\nthe response.\n" } ] }, "docs": "List TLS policies mapped to the array as a whole, or to one or more specific objects on the array (such as network interfaces)." }, { "info": { "name": "Pure Storage GET Tls-policies/network-interfaces", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/tls-policies/network-interfaces", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `member_ids`, then an error is returned.\nThis cannot be provided together with the `member_names` query parameter.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "A comma-separated list of policy IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `policy_ids`, then an error is returned.\nThis cannot be provided together with the `policy_names` query parameter.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nNOTE: If you provide a sort you will not get a `continuation_token` in\nthe response.\n" } ] }, "docs": "List network interface TLS policies." }, { "info": { "name": "Pure Storage POST Tls-policies/network-interfaces", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/tls-policies/network-interfaces", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `member_ids`, then an error is returned.\nThis cannot be provided together with the `member_names` query parameter.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "A comma-separated list of policy IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `policy_ids`, then an error is returned.\nThis cannot be provided together with the `policy_names` query parameter.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\n" } ] }, "docs": "Apply a TLS policy to a specific network interface. A given network interface may only have 1 TLS policy applied to it at any given time." }, { "info": { "name": "Pure Storage DELETE Tls-policies/network-interfaces", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/tls-policies/network-interfaces", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `member_ids`, then an error is returned.\nThis cannot be provided together with the `member_names` query parameter.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "A comma-separated list of policy IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `policy_ids`, then an error is returned.\nThis cannot be provided together with the `policy_names` query parameter.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\n" } ] }, "docs": "Remove a TLS policy from a network interface." } ] } ], "bundled": true }