{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Subscriptions API", "version": "2.52" }, "items": [ { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/subscriptions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays information about subscriptions.\n\n" }, { "info": { "name": "Pure Storage Get Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "/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": "/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": "/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" } ] } ], "bundled": true }