{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Vchosts API", "version": "2.52" }, "items": [ { "info": { "name": "Vchosts", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Vchosts", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/vchosts", "headers": [ { "name": "Authorization", "value": "" }, { "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": "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": "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 vchosts.\n\n" }, { "info": { "name": "Pure Storage Create a Vchost", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/vchosts", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "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 vchost.\nThe `names` query parameter is required.\n\n" }, { "info": { "name": "Pure Storage Modify a Vchost", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/vchosts", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies an existing vchost.\nThe `names` or `ids` query parameter is required.\n\n" }, { "info": { "name": "Pure Storage Delete a Vchost", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/vchosts", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "Deletes an existing vchost.\nThe `names` or `ids` query parameter is required.\n\n" }, { "info": { "name": "Pure Storage List Vchost Certificates", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/vchosts/certificates", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "certificate_names", "value": "", "type": "query", "description": "The names of one or more certificates.\nEnter multiple names in comma-separated format.\nFor example, `cert01,cert02`.\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": "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": "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" }, { "name": "vchost_ids", "value": "", "type": "query", "description": "Performs the operation on the unique vchost IDs specified.\nEnter multiple vchost IDs in a comma-separated format.\nFor example, `vchostid01,vchostid02`.\n" }, { "name": "vchost_names", "value": "", "type": "query", "description": "Performs the operation on the unique vchost name specified.\nEnter multiple names in a comma-separated format.\nFor example, `vchost01,vchost02`.\n" } ] }, "docs": "Displays certificates that are attached to configured vchosts on at least one endpoint.\n\n" }, { "info": { "name": "Pure Storage Create a Vchost Certificate", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/vchosts/certificates", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "vchost_ids", "value": "", "type": "query", "description": "Performs the operation on the unique vchost IDs specified.\nEnter multiple vchost IDs in a comma-separated format.\nFor example, `vchostid01,vchostid02`.\n" }, { "name": "vchost_names", "value": "", "type": "query", "description": "Performs the operation on the unique vchost name specified.\nEnter multiple names in a comma-separated format.\nFor example, `vchost01,vchost02`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an association between a certificate and vchost on one or more endpoints.\nThe `vchost_names` or `vchost_ids` query parameter is required.\n\n" }, { "info": { "name": "Pure Storage Modify a Vchost Certificate", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/vchosts/certificates", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "certificate_names", "value": "", "type": "query", "description": "The names of one or more certificates.\nEnter multiple names in comma-separated format.\nFor example, `cert01,cert02`.\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": "vchost_ids", "value": "", "type": "query", "description": "Performs the operation on the unique vchost IDs specified.\nEnter multiple vchost IDs in a comma-separated format.\nFor example, `vchostid01,vchostid02`.\n" }, { "name": "vchost_names", "value": "", "type": "query", "description": "Performs the operation on the unique vchost name specified.\nEnter multiple names in a comma-separated format.\nFor example, `vchost01,vchost02`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies an existing vchost certificate.\nThe `ids` query parameter alone, or the `certificate_names` query parameter together\nwith one of `vchost_names` or `vchost_ids`, is required.\n\n" }, { "info": { "name": "Pure Storage Delete a Vchost Certificate", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/vchosts/certificates", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "certificate_names", "value": "", "type": "query", "description": "The names of one or more certificates.\nEnter multiple names in comma-separated format.\nFor example, `cert01,cert02`.\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": "vchost_ids", "value": "", "type": "query", "description": "Performs the operation on the unique vchost IDs specified.\nEnter multiple vchost IDs in a comma-separated format.\nFor example, `vchostid01,vchostid02`.\n" }, { "name": "vchost_names", "value": "", "type": "query", "description": "Performs the operation on the unique vchost name specified.\nEnter multiple names in a comma-separated format.\nFor example, `vchost01,vchost02`.\n" } ] }, "docs": "Deletes an existing vchost certificate.\nThe `ids` query parameter alone, or the `certificate_names`\nquery parameter together with one of `vchost_names` or `vchost_ids`, is required.\n\n" }, { "info": { "name": "Pure Storage List Vchost Endpoints", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/vchosts/endpoints", "headers": [ { "name": "Authorization", "value": "" }, { "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": "endpoints", "value": "", "type": "query", "description": "Performs the operation on the unique endpoints specified.\nEnter multiple endpoints in a comma-separated format.\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 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": "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" }, { "name": "vchost_ids", "value": "", "type": "query", "description": "Performs the operation on the unique vchost IDs specified.\nEnter multiple vchost IDs in a comma-separated format.\nFor example, `vchostid01,vchostid02`.\n" }, { "name": "vchost_names", "value": "", "type": "query", "description": "Performs the operation on the unique vchost name specified.\nEnter multiple names in a comma-separated format.\nFor example, `vchost01,vchost02`.\n" } ] }, "docs": "Displays a list of vchost endpoints with their associated vchosts and certificates.\n\n" }, { "info": { "name": "Pure Storage Create a Vchost Endpoint", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/vchosts/endpoints", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "vchost_ids", "value": "", "type": "query", "description": "Performs the operation on the unique vchost IDs specified.\nEnter multiple vchost IDs in a comma-separated format.\nFor example, `vchostid01,vchostid02`.\n" }, { "name": "vchost_names", "value": "", "type": "query", "description": "Performs the operation on the unique vchost name specified.\nEnter multiple names in a comma-separated format.\nFor example, `vchost01,vchost02`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a vchost endpoint.\nEither the `vchost_names` or `vchost_ids` query parameter is required.\n\n" }, { "info": { "name": "Pure Storage Modify a Vchost Endpoint", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/vchosts/endpoints", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "endpoints", "value": "", "type": "query", "description": "Performs the operation on the unique endpoints specified.\nEnter multiple endpoints in a comma-separated format.\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": "vchost_ids", "value": "", "type": "query", "description": "Performs the operation on the unique vchost IDs specified.\nEnter multiple vchost IDs in a comma-separated format.\nFor example, `vchostid01,vchostid02`.\n" }, { "name": "vchost_names", "value": "", "type": "query", "description": "Performs the operation on the unique vchost name specified.\nEnter multiple names in a comma-separated format.\nFor example, `vchost01,vchost02`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies an existing vchost endpoint.\nThe `ids` query parameter alone, or the `endpoints` query parameter together with\none of `vchost_names` or `vchost_ids`, is required.\n\n" }, { "info": { "name": "Pure Storage Delete a Vchost Endpoint", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/vchosts/endpoints", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "endpoints", "value": "", "type": "query", "description": "Performs the operation on the unique endpoints specified.\nEnter multiple endpoints in a comma-separated format.\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": "vchost_ids", "value": "", "type": "query", "description": "Performs the operation on the unique vchost IDs specified.\nEnter multiple vchost IDs in a comma-separated format.\nFor example, `vchostid01,vchostid02`.\n" }, { "name": "vchost_names", "value": "", "type": "query", "description": "Performs the operation on the unique vchost name specified.\nEnter multiple names in a comma-separated format.\nFor example, `vchost01,vchost02`.\n" } ] }, "docs": "Deletes an existing vchost endpoint\nThe `ids` query parameter alone, or the `endpoints` query parameter together with\none of `vchost_names` or `vchost_ids`, is required.\n\n" } ] } ], "bundled": true }