{ "opencollection": "1.0.0", "info": { "name": "Pure1 Public REST API", "version": "1.5" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Authorization", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Access Token", "type": "http" }, "http": { "method": "POST", "url": "https://api-staging.pure1.purestorage.com/oauth2/1.0/token", "headers": [ { "name": "X-Request-ID", "value": "" } ], "body": { "type": "form-urlencoded", "data": [ { "name": "grant_type", "value": "" }, { "name": "subject_token", "value": "" }, { "name": "subject_token_type", "value": "" } ] } }, "docs": "Exchanges an ID Token for an OAuth 2.0 access token.\n" } ] }, { "info": { "name": "Alerts", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Alerts", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/alerts", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about alerts generated by Pure1-monitored appliances.\n" } ] }, { "info": { "name": "Arrays", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Arrays", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/arrays", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "fqdns", "value": "", "type": "query", "description": "A comma-separated list of resource FQDNs.\nIf there is not at least one resource that matches each `fqdn` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about FlashArray and FlashBlade storage appliances.\n" }, { "info": { "name": "Pure Storage Get Array Support Contracts", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/arrays/support-contracts", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "resource_fqdns", "value": "", "type": "query", "description": "A comma-separated list of resource FQDNs.\nIf there is not at least one resource that matches each `resource_fqdn`\nelement, an error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "resource_ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `resource_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "resource_names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `resource_name`\nelement, an error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves the support contracts associated with arrays.\n" }, { "info": { "name": "Pure Storage Get Array Tags", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/arrays/tags", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "keys", "value": "", "type": "query", "description": "A comma-separated list of tag keys.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "namespaces", "value": "", "type": "query", "description": "A comma-separated list of namespaces.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "resource_ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `resource_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "resource_names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `resource_name`\nelement, an error is returned.\nSingle quotes are required around all strings.\n" } ] }, "docs": "Retrieves the tags associated with specified arrays.\n" }, { "info": { "name": "Pure Storage Delete Array Tags", "type": "http" }, "http": { "method": "DELETE", "url": "https://api-staging.pure1.purestorage.com/api/1.5/arrays/tags", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "keys", "value": "", "type": "query", "description": "A comma-separated list of tag keys.\nSingle quotes are required around all strings.\n" }, { "name": "namespaces", "value": "", "type": "query", "description": "A comma-separated list of namespaces.\nSingle quotes are required around all strings.\n" }, { "name": "resource_ids", "value": "", "type": "query", "description": "REQUIRED: either `resource_ids` or `resource_names`.\nA comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `resource_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "resource_names", "value": "", "type": "query", "description": "REQUIRED: either `resource_ids` or `resource_names`.\nA comma-separated list of resource names.\nIf there is not at least one resource that matches each `resource_name`\nelement, an error is returned.\nSingle quotes are required around all strings.\n" } ] }, "docs": "Deletes array tags from Pure1.\n" }, { "info": { "name": "Pure Storage Create or Update Array Tags", "type": "http" }, "http": { "method": "PUT", "url": "https://api-staging.pure1.purestorage.com/api/1.5/arrays/tags/batch", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "namespaces", "value": "", "type": "query", "description": "A comma-separated list of namespaces.\nSingle quotes are required around all strings.\n" }, { "name": "resource_ids", "value": "", "type": "query", "description": "REQUIRED: either `resource_ids` or `resource_names`.\nA comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `resource_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "resource_names", "value": "", "type": "query", "description": "REQUIRED: either `resource_ids` or `resource_names`.\nA comma-separated list of resource names.\nIf there is not at least one resource that matches each `resource_name`\nelement, an error is returned.\nSingle quotes are required around all strings.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates array tags contextual to Pure1 only.\n" } ] }, { "info": { "name": "Sustainability", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Appliance Sustainability Information.", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/assessment/sustainability/arrays", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "fqdns", "value": "", "type": "query", "description": "A comma-separated list of resource FQDNs.\nIf there is not at least one resource that matches each `fqdn` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about FlashArray and FlashBlade size,\npower consumption, heat generation and its sustainability assessment.\n" }, { "info": { "name": "Pure Storage Get Appliance Sustainability Insights Information.", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/assessment/sustainability/insights/arrays", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about FlashArray and FlashBlade insights\nconnected to sustainability assessment.\n" } ] }, { "info": { "name": "Audits", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Audits", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/audits", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves audit objects.\n" } ] }, { "info": { "name": "Blades", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Blades", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/blades", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about FlashBlade blades.\n" } ] }, { "info": { "name": "Buckets", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Buckets", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/buckets", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves buckets.\n" } ] }, { "info": { "name": "Bucket Replica Links", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Bucket Replica Links", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/bucket-replica-links", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "A list of member IDs. Member IDs separated by a `+` indicate that both\nmembers must be present in each element. Member IDs separated by a `,`\nindicate that at least one member must be present in each element.\nIf there is not at least one resource that matches each `member_id` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of member IDs separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A list of member names. Member names separated by a `+` indicate that both\nmembers must be present in each element. Member names separated by a `,`\nindicate that at least one member must be present in each element.\nIf there is not at least one resource that matches each `member_name` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of member names separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" }, { "name": "source_ids", "value": "", "type": "query", "description": "A list of source IDs. Source IDs separated by a `+` indicate that both\nsources must be present in each element. Source IDs separated by a `,`\nindicate that at least one source must be present in each element.\nIf there is not at least one resource that matches each `source_id` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of source IDs separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "source_names", "value": "", "type": "query", "description": "A list of source names. Source names separated by a `+` indicate that both\nsources must be present in each element. Source names separated by a `,`\nindicate that at least one source must be present in each element.\nIf there is not at least one resource that matches each `source_name` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of source names separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "target_ids", "value": "", "type": "query", "description": "A list of target IDs. Target IDs separated by a `+` indicate that both\ntargets must be present in each element. Target IDs separated by a `,`\nindicate that at least one target must be present in each element.\nIf there is not at least one resource that matches each `target_id` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of target IDs separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "target_names", "value": "", "type": "query", "description": "A list of target names. Target names separated by a `+` indicate that both\ntargets must be present in each element. Target names separated by a `,`\nindicate that at least one target must be present in each element.\nIf there is not at least one resource that matches each `target_name` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of target names separated by a `+`\nmust be entered in the same item cell.\n" } ] }, "docs": "Retrieves information about bucket replica links.\n" } ] }, { "info": { "name": "Controllers", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Controllers", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/controllers", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about controllers.\n" } ] }, { "info": { "name": "Directories", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Managed Directories", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/directories", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "file_system_ids", "value": "", "type": "query", "description": "Performs the operation on the file system ID specified.\nEnter multiple file system IDs in comma-separated format.\nThe `file_system_ids` and `file_system_names` parameters cannot be provided together.\nSingle quotes are required around all strings.\n" }, { "name": "file_system_names", "value": "", "type": "query", "description": "Performs the operation on the file system name specified.\nEnter multiple file system names in comma-separated format.\nFor example, `filesystem1,filesystem2`.\nThe `file_system_ids` and `file_system_names` parameters cannot be provided together.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about FlashArray managed directory objects.\n" } ] }, { "info": { "name": "Drives", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Drives", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/drives", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about FlashArray drives.\n" } ] }, { "info": { "name": "File Systems", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get FlashArray and FlashBlade File Systems", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/file-systems", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about FlashArray and FlashBlade file system objects.\n" }, { "info": { "name": "Pure Storage Get FlashBlade File System / Policy Pairs", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/file-systems/policies", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf there is not at least one resource that matches each `member_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\nIf there is not at least one resource that matches each `member_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "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 there is not at least one resource that matches each `policy_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\nIf there is not at least one resource that matches each `policy_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves pairs of FlashBlade file system members and their policies.\n" } ] }, { "info": { "name": "File System Replica Links", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get FlashBlade File System Replica Links", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/file-system-replica-links", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "A list of member IDs. Member IDs separated by a `+` indicate that both\nmembers must be present in each element. Member IDs separated by a `,`\nindicate that at least one member must be present in each element.\nIf there is not at least one resource that matches each `member_id` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of member IDs separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A list of member names. Member names separated by a `+` indicate that both\nmembers must be present in each element. Member names separated by a `,`\nindicate that at least one member must be present in each element.\nIf there is not at least one resource that matches each `member_name` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of member names separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" }, { "name": "source_ids", "value": "", "type": "query", "description": "A list of source IDs. Source IDs separated by a `+` indicate that both\nsources must be present in each element. Source IDs separated by a `,`\nindicate that at least one source must be present in each element.\nIf there is not at least one resource that matches each `source_id` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of source IDs separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "source_names", "value": "", "type": "query", "description": "A list of source names. Source names separated by a `+` indicate that both\nsources must be present in each element. Source names separated by a `,`\nindicate that at least one source must be present in each element.\nIf there is not at least one resource that matches each `source_name` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of source names separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "target_ids", "value": "", "type": "query", "description": "A list of target IDs. Target IDs separated by a `+` indicate that both\ntargets must be present in each element. Target IDs separated by a `,`\nindicate that at least one target must be present in each element.\nIf there is not at least one resource that matches each `target_id` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of target IDs separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "target_names", "value": "", "type": "query", "description": "A list of target names. Target names separated by a `+` indicate that both\ntargets must be present in each element. Target names separated by a `,`\nindicate that at least one target must be present in each element.\nIf there is not at least one resource that matches each `target_name` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of target names separated by a `+`\nmust be entered in the same item cell.\n" } ] }, "docs": "Retrieves information about FlashBlade file system replica links.\n" }, { "info": { "name": "Pure Storage Get FlashBlade File System Replica Link / Policy Pairs", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/file-system-replica-links/policies", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf there is not at least one resource that matches each `member_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\nIf there is not at least one resource that matches each `member_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "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 there is not at least one resource that matches each `policy_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\nIf there is not at least one resource that matches each `policy_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves pairs of FlashBlade file system replica link members and their policies.\n" } ] }, { "info": { "name": "File System Snapshots", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get FlashBlade File System Snapshots", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/file-system-snapshots", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" }, { "name": "source_ids", "value": "", "type": "query", "description": "A comma-separated list of ids for the source of the object.\nIf there is not at least one resource that matches each `source_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "source_names", "value": "", "type": "query", "description": "A comma-separated list of names for the source of the object.\nIf there is not at least one resource that matches each `source_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" } ] }, "docs": "Retrieves snapshots of FlashBlade file systems.\n" }, { "info": { "name": "Pure Storage Get FlashBlade File System Snapshot / Policy Pairs", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/file-system-snapshots/policies", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf there is not at least one resource that matches each `member_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\nIf there is not at least one resource that matches each `member_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "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 there is not at least one resource that matches each `policy_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\nIf there is not at least one resource that matches each `policy_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves pairs of FlashBlade file system snapshot members and their policies.\n" } ] }, { "info": { "name": "Hardware", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Hardware", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/hardware", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about hardware components.\n" } ] }, { "info": { "name": "Hardware Connectors", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Hardware Connectors", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/hardware-connectors", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about FlashBlade hardware connectors.\n" } ] }, { "info": { "name": "Invoices", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Invoices", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/invoices", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "partner_purchase_orders", "value": "", "type": "query", "description": "A comma-separated list of partner purchase order numbers.\nIf there is not at least one resource that matches each `partner_purchase_order` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" }, { "name": "subscription_ids", "value": "", "type": "query", "description": "A comma-separated list of subscription IDs.\nIf there is not at least one resource that matches each `subscription.id`\nelement, an error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "subscription_names", "value": "", "type": "query", "description": "A comma-separated list of subscription names.\nIf there is not at least one resource that matches each `subscription.name`\nelement, an error is returned.\nSingle quotes are required around all strings.\n" } ] }, "docs": "Retrieves information about Pure1 subscription invoices.\n" } ] }, { "info": { "name": "Metrics", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Metrics", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/metrics", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "resource_types", "value": "", "type": "query", "description": "The resource types to list the available metrics.\nValid values are `arrays`, `buckets`, `directories`,\n`file-systems`, `pods`, `subscription-licenses` and\n`volumes`.\nA metric can belong to a combination of resources,\ne.g., write-iops from array to pod. In that case, query by\n['arrays', 'pods'].\nSingle quotes are required around all strings.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about metrics that can be queried for.\n" }, { "info": { "name": "Pure Storage Get Metrics History", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/metrics/history", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "aggregation", "value": "", "type": "query", "description": "Aggregation needed on the metric data.\nValid values are `avg` and `max`.\nSingle quotes are required around all strings.\nLatency metrics averages are weighted by the IOPS.\n" }, { "name": "end_time", "value": "", "type": "query", "description": "Timestamp of when the time window ends. Measured in milliseconds since the UNIX epoch.\n" }, { "name": "ids", "value": "", "type": "query", "description": "REQUIRED: either `ids` or `names`.\nA comma-separated list of object IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "names", "value": "", "type": "query", "description": "REQUIRED: either `names` or `ids`.\nA comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "resolution", "value": "", "type": "query", "description": "The duration of time between individual data points, in milliseconds.\n" }, { "name": "resource_ids", "value": "", "type": "query", "description": "REQUIRED: either `resource_ids` or `resource_names`.\nA comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `resource_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "resource_names", "value": "", "type": "query", "description": "REQUIRED: either `resource_ids` or `resource_names`.\nA comma-separated list of resource names.\nIf there is not at least one resource that matches each `resource_name`\nelement, an error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "start_time", "value": "", "type": "query", "description": "Timestamp of when the time window starts. Measured in milliseconds since the UNIX epoch.\n" } ] }, "docs": "Retrieves historical metric data for resources.\nThis endpoint supports batching: Up to 32 time series can be retrieved in one call.\nIt can be multiple metrics for one resource,\n(e.g., load and bandwidth for one array - 2 time series),\none metric for multiple resource (e.g., load for arrayA and arrayB - 2 time series),\nor a combination of both, multiple metrics for multiple resources,\n(e.g., load and bandwidth for arrayA and arrayB - 4 time series).\n" } ] }, { "info": { "name": "Network Interfaces", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Network Interfaces", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/network-interfaces", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about physical and virtual network interface objects.\n" } ] }, { "info": { "name": "Object Store Accounts", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Object Store Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/object-store-accounts", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves object store accounts.\n" } ] }, { "info": { "name": "Protection Group Snapshots", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Protection Group Snapshots", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/protection-group-snapshots", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" }, { "name": "source_ids", "value": "", "type": "query", "description": "A comma-separated list of ids for the source of the object.\nIf there is not at least one resource that matches each `source_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "source_names", "value": "", "type": "query", "description": "A comma-separated list of names for the source of the object.\nIf there is not at least one resource that matches each `source_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" } ] }, "docs": "Retrieves information about snapshots of protection groups\n" }, { "info": { "name": "Pure Storage Get Protection Group Snapshots with Transfer Statistics", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/protection-group-snapshots/transfer", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" }, { "name": "source_ids", "value": "", "type": "query", "description": "A comma-separated list of ids for the source of the object.\nIf there is not at least one resource that matches each `source_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "source_names", "value": "", "type": "query", "description": "A comma-separated list of names for the source of the object.\nIf there is not at least one resource that matches each `source_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" } ] }, "docs": "Retrieves information about snapshots of protection groups\n" } ] }, { "info": { "name": "Pods", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Pods", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/pods", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about pod objects.\n" } ] }, { "info": { "name": "Pod Replica Links", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Pod Replica Links", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/pod-replica-links", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "A list of member IDs. Member IDs separated by a `+` indicate that both\nmembers must be present in each element. Member IDs separated by a `,`\nindicate that at least one member must be present in each element.\nIf there is not at least one resource that matches each `member_id` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of member IDs separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A list of member names. Member names separated by a `+` indicate that both\nmembers must be present in each element. Member names separated by a `,`\nindicate that at least one member must be present in each element.\nIf there is not at least one resource that matches each `member_name` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of member names separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" }, { "name": "source_ids", "value": "", "type": "query", "description": "A list of source IDs. Source IDs separated by a `+` indicate that both\nsources must be present in each element. Source IDs separated by a `,`\nindicate that at least one source must be present in each element.\nIf there is not at least one resource that matches each `source_id` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of source IDs separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "source_names", "value": "", "type": "query", "description": "A list of source names. Source names separated by a `+` indicate that both\nsources must be present in each element. Source names separated by a `,`\nindicate that at least one source must be present in each element.\nIf there is not at least one resource that matches each `source_name` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of source names separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "target_ids", "value": "", "type": "query", "description": "A list of target IDs. Target IDs separated by a `+` indicate that both\ntargets must be present in each element. Target IDs separated by a `,`\nindicate that at least one target must be present in each element.\nIf there is not at least one resource that matches each `target_id` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of target IDs separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "target_names", "value": "", "type": "query", "description": "A list of target names. Target names separated by a `+` indicate that both\ntargets must be present in each element. Target names separated by a `,`\nindicate that at least one target must be present in each element.\nIf there is not at least one resource that matches each `target_name` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of target names separated by a `+`\nmust be entered in the same item cell.\n" } ] }, "docs": "Retrieves information about pod replica links.\n" } ] }, { "info": { "name": "Policies", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Policies", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/policies", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves policies and their rules.\n" }, { "info": { "name": "Pure Storage Get Policy / FlashBlade File System Pairs", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/policies/file-systems", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf there is not at least one resource that matches each `member_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\nIf there is not at least one resource that matches each `member_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "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 there is not at least one resource that matches each `policy_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\nIf there is not at least one resource that matches each `policy_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves pairs of policy references and their FlashBlade file system members.\n" }, { "info": { "name": "Pure Storage Get Policy / FlashBlade File System Replica Link Pairs", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/policies/file-system-replica-links", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf there is not at least one resource that matches each `member_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\nIf there is not at least one resource that matches each `member_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "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 there is not at least one resource that matches each `policy_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\nIf there is not at least one resource that matches each `policy_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves pairs of policy references and their FlashBlade file system replica link members.\n" }, { "info": { "name": "Pure Storage Get Policy / FlashBlade File System Snapshot Pairs", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/policies/file-system-snapshots", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf there is not at least one resource that matches each `member_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\nIf there is not at least one resource that matches each `member_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "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 there is not at least one resource that matches each `policy_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\nIf there is not at least one resource that matches each `policy_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves pairs of policy references and their FlashBlade file system snapshot members.\n" }, { "info": { "name": "Pure Storage Get Policy / Member Pairs", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/policies/members", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf there is not at least one resource that matches each `member_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\nIf there is not at least one resource that matches each `member_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "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 there is not at least one resource that matches each `policy_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\nIf there is not at least one resource that matches each `policy_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves pairs of policy references and their members.\n" } ] }, { "info": { "name": "Ports", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Ports", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/ports", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about FlashArray ports.\n" } ] }, { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/subscriptions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about Pure1 subscriptions.\n" }, { "info": { "name": "Pure Storage Get Subscription Licenses", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/subscription-licenses", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "marketplace_partner_reference_ids", "value": "", "type": "query", "description": "A comma-separated list of marketplace partner reference IDs.\nIf there is not at least one resource that matches each\n`marketplace_partner.reference_id` element, an error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" }, { "name": "subscription_ids", "value": "", "type": "query", "description": "A comma-separated list of subscription IDs.\nIf there is not at least one resource that matches each `subscription.id`\nelement, an error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "subscription_names", "value": "", "type": "query", "description": "A comma-separated list of subscription names.\nIf there is not at least one resource that matches each `subscription.name`\nelement, an error is returned.\nSingle quotes are required around all strings.\n" } ] }, "docs": "Retrieves information about Pure1 subscription licenses.\n" }, { "info": { "name": "Pure Storage Get Subscription Assets", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/subscription-assets", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "advanced_space", "value": "", "type": "query", "description": "If `true`, returns the `advanced_space` field containing physical and effective space information.\n" }, { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "license_ids", "value": "", "type": "query", "description": "A comma-separated list of subscriptionLicense IDs.\nIf there is not at least one resource that matches each `license.id`\nelement, an error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "license_names", "value": "", "type": "query", "description": "A comma-separated list of subscriptionLicense names.\nIf there is not at least one resource that matches each `license.name`\nelement, an error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" }, { "name": "subscription_ids", "value": "", "type": "query", "description": "A comma-separated list of subscription IDs.\nIf there is not at least one resource that matches each `subscription.id`\nelement, an error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "subscription_names", "value": "", "type": "query", "description": "A comma-separated list of subscription names.\nIf there is not at least one resource that matches each `subscription.name`\nelement, an error is returned.\nSingle quotes are required around all strings.\n" } ] }, "docs": "Retrieves information about Pure1 subscription assets.\n" } ] }, { "info": { "name": "Targets", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Targets", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/targets", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about targets.\n" } ] }, { "info": { "name": "Volumes", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Volumes", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/volumes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" } ] }, "docs": "Retrieves information about FlashArray volume objects.\n" } ] }, { "info": { "name": "Volume Snapshots", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage Get Volume Snapshots", "type": "http" }, "http": { "method": "GET", "url": "https://api-staging.pure1.purestorage.com/api/1.5/volume-snapshots", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" }, { "name": "source_ids", "value": "", "type": "query", "description": "A comma-separated list of ids for the source of the object.\nIf there is not at least one resource that matches each `source_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "source_names", "value": "", "type": "query", "description": "A comma-separated list of names for the source of the object.\nIf there is not at least one resource that matches each `source_name` element,\nan error is returned.\nSingle quotes are required around all strings.\n" } ] }, "docs": "Retrieves information about snapshots of volumes.\n" } ] } ], "bundled": true }