openapi: 3.0.1 info: title: FlashArray REST Active Directory Alerts API version: '2.52' description: 'Active Directory configuration authenticates users for NFS using Kerberos or SMB using Kerberos or New Technology LAN Manager (NTLM). Active Directory is also used to authorize users by mapping identities across the NFS and SMB protocols by using LDAP queries. ' servers: - url: / tags: - name: Alerts description: 'Alerts indicate significant events that occur on an array, including whenever a component degrades or the capacity threshold of the component is reached. ' paths: /api/2.52/alerts: get: tags: - Alerts summary: Pure Storage List Alerts description: Displays a list of alerts. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Flagged' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlertGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/AlertGetResponse' patch: tags: - Alerts summary: Pure Storage Modify Flagged State description: Modifies one or more alerts and display updated information about these alerts. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/Alert' required: true x-codegen-request-body-name: alert responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlertResponse' x-codegen-request-body-name: alert /api/2.52/alerts/events: get: tags: - Alerts summary: Pure Storage List Alert Events description: Displays a list of alert events. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Flagged' - $ref: '#/components/parameters/IdsSemiRequired' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/NamesSemiRequired' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlertEventGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/AlertEventGetResponse' /api/2.52/alerts/rules: get: tags: - Alerts summary: Pure Storage List Custom Alert Rules description: 'Displays a list of custom alert rules. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Alert_rules_code_list' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlertRulesGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/AlertRulesGetResponse' post: tags: - Alerts summary: Pure Storage Create a Custom Alert Rule description: 'Creates an alert rule with a custom value. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Alert_rules_code' - $ref: '#/components/parameters/Alert_rules_parameter' requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertRules' required: true x-codegen-request-body-name: alert-rule responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlertRulesResponse' x-codegen-request-body-name: alert-rule delete: tags: - Alerts summary: Pure Storage Delete a Custom Alert Rule description: 'Deletes a custom alert rule. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Alert_rules_code' - $ref: '#/components/parameters/Alert_rules_parameter' responses: '200': description: OK content: {} patch: tags: - Alerts summary: Pure Storage Modify a Custom Alert Rule description: 'Modifies a custom alert rule to a new value. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Alert_rules_code' - $ref: '#/components/parameters/Alert_rules_parameter' requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertRules' required: true x-codegen-request-body-name: alert-rule responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlertRulesResponse' x-codegen-request-body-name: alert-rule /api/2.52/alerts/rules/catalog: get: tags: - Alerts summary: Pure Storage List Available Customizable Alert Codes description: 'Displays a list of available customizable alert codes. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Alert_rules_code_list' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlertRulesCatalogGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/AlertRulesCatalogGetResponse' /api/2.26/alerts: get: tags: - Alerts summary: Pure Storage GET Alerts description: 'Returns a list of alerts which have been generated by the array. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/AlertGetResponse_2' patch: tags: - Alerts summary: Pure Storage PATCH Alerts description: 'Make changes to an alert. This is currently limited to the alert''s `flagged` property. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/Alert_2' required: true x-codegen-request-body-name: alerts-settings responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/AlertResponse_2' x-codegen-request-body-name: alerts-settings /api/1.5/alerts: get: tags: - Alerts summary: Pure Storage Get Alerts description: 'Retrieves information about alerts generated by Pure1-monitored appliances. ' parameters: - $ref: '#/components/parameters/Authorization_2' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token_2' - $ref: '#/components/parameters/Filter_2' - $ref: '#/components/parameters/Ids_3' - $ref: '#/components/parameters/Limit_2' - $ref: '#/components/parameters/Names_2' - $ref: '#/components/parameters/Offset_3' - $ref: '#/components/parameters/Sort_3' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: integer X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: integer X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: integer X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/AlertsGetResponse' '400': $ref: '#/components/responses/Error400' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '429': $ref: '#/components/responses/Error429' '500': $ref: '#/components/responses/Error500' components: responses: Error404: description: NOT FOUND headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: object X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: object X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: object X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: object content: application/json: schema: $ref: '#/components/schemas/Error' Error500: description: INTERNAL SERVER ERROR headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: object X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: object X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: object X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: object content: application/json: schema: $ref: '#/components/schemas/Error' Error403: description: FORBIDDEN headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object content: application/json: schema: $ref: '#/components/schemas/ErrorNoContext' Error400: description: BAD REQUEST headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: object X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: object X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: object X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: object content: application/json: schema: $ref: '#/components/schemas/Error' Error429: description: TOO MANY REQUESTS headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: object X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: object X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: object X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: object content: application/json: schema: $ref: '#/components/schemas/ErrorNoContext' parameters: Sort_3: name: sort in: query description: 'Sort the response by the specified fields (in descending order if ''-'' is appended to the field name). If you provide a sort you will not get a continuation token in the response. ' style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string Filter: name: filter in: query description: 'Narrows down the results to only the response objects that satisfy the filter criteria. ' schema: type: string Offset: name: offset in: query description: 'The starting position based on the results of the query in relation to the full set of response objects returned. ' schema: type: integer format: int32 minimum: 0 example: 10 Allow_errors: name: allow_errors in: query description: 'If set to `true`, the API will allow the operation to continue even if there are errors. Any errors will be returned in the `errors` field of the response. If set to `false`, the operation will fail if there are any errors. ' schema: type: boolean default: false IdsSemiRequired: name: ids in: query description: 'Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together. ' style: form explode: false schema: type: array items: type: string Offset_3: name: offset in: query description: 'The offset of the first resource to return from a collection. ' schema: type: integer format: int32 minimum: 0 Continuation_token: name: continuation_token in: query description: 'A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters. ' schema: type: string NamesSemiRequired: name: names in: query description: 'Performs the operation on the unique name specified. For example, `name01`. Enter multiple names in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together. ' style: form explode: false schema: type: array items: type: string Offset_2: name: offset in: query description: 'The offset of the first resource to return from a collection. ' schema: type: integer format: int32 minimum: 0 example: 10 Names_2: name: names in: query description: 'A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings. ' style: form explode: false schema: type: array items: type: string x-quoted: true x-quoted: true XRequestId: name: X-Request-ID in: header description: 'Supplied by client during request or generated by server. ' schema: type: string Continuation_token_2: name: continuation_token in: query description: 'An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings. ' schema: type: string x-quoted: true x-quoted: true Limit: name: limit in: query description: 'Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. ' schema: type: integer format: int32 minimum: 0 example: 10 Limit_2: name: limit in: query description: 'Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client''s page size request. If not specified, defaults to 1000. ' schema: type: integer format: int32 Flagged: name: flagged in: query description: 'If set to `true`, lists only flagged messages. If set to `false`, lists only unflagged messages. if not specified, lists all messages. ' schema: type: boolean Authorization: name: Authorization in: header description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) ' schema: type: string Names: name: names in: query description: 'Performs the operation on the unique names specified. Enter multiple names in comma-separated format. For example, `name01,name02`. If there is not at least one resource that matches each of the elements of `names`, then an error is returned, except when creating new resources. ' style: form explode: false schema: type: array items: type: string Alert_rules_code: name: code in: query description: 'The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog. ' required: true schema: type: integer format: int32 Context_names_get: name: context_names in: query description: 'Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet or the name of the fleet itself. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. Enter multiple names in comma-separated format. For example, `name01,name02`. ' style: form explode: false schema: type: array items: type: string Alert_rules_code_list: name: code in: query description: 'The alert code to display. ' schema: type: integer format: int32 Authorization_2: name: Authorization in: header description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`) ' schema: type: string Sort_2: name: sort in: query description: 'Sort the response by the specified fields (in descending order if ''-'' is appended to the field name). NOTE: If you provide a sort you will not get a `continuation_token` in the response. ' style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string Ids: name: ids in: 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" style: form explode: false schema: type: array items: type: string Ids_3: name: ids in: query description: 'A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings. ' style: form explode: false schema: type: array items: type: string x-quoted: true x-quoted: true Alert_rules_parameter: name: parameter in: query description: 'The parameter of the custom alert rule to modify. Values include `info` and `warning`. Available parameter values can be found in the alert rules catalog. ' required: true schema: type: string Ids_2: name: ids in: query description: 'A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of `ids`, then an error is returned. This cannot be provided together with the `name` or `names` query parameters. ' style: form explode: false schema: type: array items: type: string Total_item_count: name: total_item_count in: query description: 'If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`. ' schema: type: boolean Filter_2: name: filter in: query description: 'Exclude resources that don''t match the specified criteria. Single quotes are required around all strings inside the filters. ' schema: type: string Sort: name: sort in: 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" style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string schemas: _builtIn_2: type: object properties: id: description: 'A non-modifiable, globally unique ID chosen by the system. ' type: string readOnly: true name: description: Name of the object (e.g., a file system or snapshot). type: string readOnly: true AlertEventGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AlertEventResponse' - $ref: '#/components/schemas/_errorContextResponse' AlertEventResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AlertEvent' _errorContextResponse: type: object properties: errors: description: The list of errors encountered when attempting to perform an operation. type: array readOnly: true items: $ref: '#/components/schemas/_errorcontextresponseErrors' Error: type: object properties: errors: description: The list of errors encountered. type: array items: $ref: '#/components/schemas/_errorErrors' _timeAware: type: object properties: _as_of: description: The freshness of the data (timestamp in millis since epoch). type: integer format: int64 readOnly: true example: 1502729489760 ErrorNoContext: type: object properties: message: type: string example: Something was wrong _errorErrors: type: object properties: context: type: string example: Error with ... message: type: string example: Something was wrong AlertsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Alert_3' _arrays: type: object properties: arrays: description: 'The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays. ' type: array readOnly: true items: $ref: '#/components/schemas/_fixedReferenceFqdn' x-readOnly: true _resource: description: 'An ordinary (as opposed to built-in) resource that can be created, named, renamed, or deleted by the user. This might be a virtual resource (e.g., a volume), or correspond to something in the physical environment, like a host or a server. ' allOf: - $ref: '#/components/schemas/_timeAware' - type: object properties: id: description: A non-modifiable, globally unique ID chosen by the system. type: string readOnly: true example: 2a989a09-c851-4d52-9ec6-ab728b1c04db name: description: A modifiable, locally unique name chosen by the user. type: string example: example_name Alert_2: allOf: - $ref: '#/components/schemas/_builtIn_2' - type: object properties: action: description: The action of the alert. type: string readOnly: true code: description: Alert code. type: integer format: int64 readOnly: true component_name: description: The component name of the alert. type: string readOnly: true component_type: description: The component type of the alert. type: string readOnly: true created: description: The creation timestamp of the alert. type: integer format: int64 readOnly: true description: description: The description of the alert. type: string readOnly: true duration: description: The duration of the alert. type: integer format: int64 readOnly: true flagged: description: Flagged state of the alert. type: boolean index: description: The unique index of the alert. type: integer format: int64 readOnly: true knowledge_base_url: description: URL of the relevant Knowledge Base page. type: string readOnly: true notified: description: The last notification timestamp of the alert. type: integer format: int64 readOnly: true severity: description: 'Severity of the alert. Valid values are `info`, `warning`, and `critical`. ' type: string readOnly: true state: description: 'The current state of the alert. Valid values are `open`, `closing`, `closed`, and `waiting to downgrade`. ' type: string readOnly: true summary: description: The summary of the alert. type: string readOnly: true updated: description: The last updated timestamp of the alert. type: integer format: int64 readOnly: true variables: description: Key-value pairs of additional information of the alert. type: object readOnly: true additionalProperties: type: string AlertRulesCatalog: allOf: - $ref: '#/components/schemas/_context' - description: 'Available alerts for customization ' type: object properties: allowed_values: description: 'The range of values allowed to set the custom alert rule to. ' type: string example: Range 0-100 (must be equal to or lower than Warning Threshold) code: description: 'The alert code that the rule applies to. ' type: integer format: int32 example: 25 default_value: description: 'The system default values for the alert code and parameter. ' type: string example: 80% parameter: description: 'The parameter of the custom alert rule. ' type: string example: info subject: description: 'The alert code description. ' type: string example: Storage consumption has reached {percent_usage}% of usable capacity Alert_3: allOf: - $ref: '#/components/schemas/_arraysResource' - description: 'An alert from an array. ' type: object properties: actual: description: Actual condition at the time of the alert. type: string example: empty category: description: 'Category of the alert. Valid values are `array`, `hardware`, and `software`. ' type: string example: array closed: description: 'Time when the alert was closed, in milliseconds since UNIX epoch. ' type: integer format: int64 example: 1502729489760 code: description: Code associated with the alert. type: integer example: 100 component_name: description: Name of the component alerted about. type: string example: drive1 component_type: description: Type of the component alerted about. type: string example: drive created: description: 'Time when the alert was created, in milliseconds since UNIX epoch. ' type: integer format: int64 example: 1502729489760 description: description: Short description of the alert. type: string example: Some sort of failure. expected: description: Expected state/threshold under normal conditions. type: string example: healthy knowledge_base_url: description: URL of the relevant Knowledge Base page. type: string example: https://support.purestorage.com/ notified: description: 'Time when the user was notified of the alert, in milliseconds since UNIX epoch. ' type: integer format: int64 example: 1502729489760 origin: description: Origin of the alert. Valid values are `array` and `Pure1`. type: string example: array severity: description: 'Current severity level. Valid values are `info`, `warning`, `critical`, and `hidden`. ' type: string example: critical state: description: 'Current state of the alert. Valid values are `open`, `closing`, and `closed`. ' type: string example: open summary: description: Summary of the alert. type: string example: Test alert. updated: description: 'Time when the alert was last updated, in milliseconds since UNIX epoch. ' type: integer format: int64 example: 1502729489760 AlertRulesGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AlertRulesResponse' - $ref: '#/components/schemas/_errorContextResponse' _errorcontextresponseErrors: type: object properties: context: description: 'Contains information relating to the cause of this error, or the name of the object that was being processed when the error was encountered. This may be `null` for more general errors. ' type: string location_context: description: 'Contains information relating to the context in which the request was executing when the error occurred. For example, this may be the name of an array in the same fleet. This may be `null` for more general errors, or if no explicit `context` parameter was provided with the request. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' message: description: A description of the error which occurred. type: string example: Resource does not exist. x-aliases: - _errorContextResponseErrors AlertRulesCatalogResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AlertRulesCatalog' AlertEvent: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - $ref: '#/components/schemas/_context' - description: Alert timeline event. type: object properties: actual: description: Actual condition at the time the alert is created. type: string readOnly: true example: 95% alert: $ref: '#/components/schemas/_fixedReference' code: description: The parent alert number. type: integer format: int64 readOnly: true example: 7 component_name: description: The component type of the alert. type: string readOnly: true example: vm-tom component_type: description: The component name of the alert. type: string readOnly: true example: storage created: description: The time the parent alert was created. type: integer format: int64 example: 1576275532434 expected: description: Expected state and threshold under normal conditions. type: string readOnly: true example: 90% issue: description: Information about the alert cause. type: string readOnly: true example: boot drive overutilization knowledge_base_url: description: The knowledge base URL of the alert. type: string readOnly: true example: https://support.purestorage.com/?cid=Alert_0007 severity: description: 'The severity level of the alert. Valid values include `info`, `warning`, `critical`, and `hidden`. ' type: string readOnly: true example: critical state: description: 'The state of the alert. Valid values include `open`, `closing`, and `closed`. ' type: string readOnly: true example: open summary: description: A summary of the alert. type: string readOnly: true example: boot drive overutilization time: description: The time the event occurred. type: integer format: int64 readOnly: true example: 1578440491109 AlertGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/AlertResponse_2' AlertRulesResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AlertRules' AlertsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_3' - $ref: '#/components/schemas/AlertsResponse' _fixedReferenceWithType: allOf: - $ref: '#/components/schemas/_fixedReference' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are the unique part of the resource''s REST endpoint. For example, a reference to a file system would have a `resource_type` of `file-systems`. ' type: string readOnly: true x-aliases: - _fixedReference AlertResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Alert' AlertRulesCatalogGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AlertRulesCatalogResponse' - $ref: '#/components/schemas/_errorContextResponse' _builtIn: description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support settings). Some correspond to a piece of software, like an app, or hardware, like a controller. Others are created by the system in response to some event (e.g., alerts, audit records). Typically, a user can''t create, delete or rename a built-in resource. A few can be created or deleted, but not renamed because the names are meaningful to Purity (e.g., VIFs). ' type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource. ' type: string readOnly: true name: description: 'A locally unique, system-generated name. The name cannot be modified. ' type: string readOnly: true Alert: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context' - description: Alert generated by the array when an event occurs. type: object properties: action: description: The action of the alert. type: string readOnly: true actual: description: Actual condition at the time the alert is created. type: string readOnly: true example: 95% category: description: 'The category of the alert. Valid values include `array`, `hardware` and `software`. ' type: string readOnly: true example: array closed: description: The time the alert was closed in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1578440492342 code: description: The code number of the alert. type: integer format: int64 readOnly: true example: 7 component_name: description: The name of the component that generated the alert. type: string readOnly: true example: vm-tom component_type: description: The type of component that generated the alert. type: string readOnly: true example: storage created: description: The time the alert was created in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1576275532434 description: description: A short description of the alert. type: string readOnly: true example: boot drive overutilization duration: description: The duration of the alert. type: integer format: int64 readOnly: true expected: description: Expected state or threshold under normal conditions. type: string readOnly: true example: 90% flagged: description: 'If set to `true`, the message is flagged. Important messages can can be flagged and listed separately. ' type: boolean example: true issue: description: Information about the alert cause. type: string readOnly: true example: boot drive overutilization knowledge_base_url: description: The URL of the relevant knowledge base page. type: string readOnly: true example: https://support.purestorage.com/?cid=Alert_0007 notified: description: 'The time the most recent alert notification was sent in milliseconds since the UNIX epoch. ' type: integer format: int64 readOnly: true example: 1578440491109 severity: description: 'The severity level of the alert. Valid values include `info`, `warning`, `critical`, and `hidden`. ' type: string readOnly: true example: critical state: description: 'The current state of the alert. Valid values include `open`, `closing`, and `closed`. ' type: string readOnly: true example: open summary: description: A summary of the alert. type: string readOnly: true example: boot drive overutilization updated: description: The time the alert was last updated in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1578440491109 _fixedReferenceFqdn: allOf: - $ref: '#/components/schemas/_fixedReference_2' - type: object properties: fqdn: description: 'The fully qualified domain name of the appliance when `resource_type` is `arrays`, `null` otherwise. ' type: string readOnly: true example: example_name.dc1.example.com _context: type: object properties: context: description: 'The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet or to the fleet itself. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. ' readOnly: true title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' AlertGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/AlertResponse' - $ref: '#/components/schemas/_errorContextResponse' AlertResponse_2: type: object properties: items: description: A list of alert objects. type: array items: $ref: '#/components/schemas/Alert_2' AlertRules: allOf: - $ref: '#/components/schemas/_context' - description: 'Custom rules for alerts. ' type: object properties: code: description: 'The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog. ' type: integer format: int32 readOnly: true example: 25 parameter: description: 'The parameter of the custom alert rule to modify. Values include `info` and `warning`. Available parameter values can be found in the alert rules catalog. ' type: string readOnly: true example: info value: description: 'The value to use for the custom alert rule. Valid values for an alert code and parameter combination can be found in the alert rules catalog. ' type: string example: '85' _fixedReference_2: type: object properties: id: description: The opaque and unique id of this resource. type: string readOnly: true example: 2a989a09-c851-4d52-9ec6-ab728b1c04db name: description: The name of this resource. type: string readOnly: true example: example_name resource_type: description: 'The type of this resource represented by the name of its REST endpoint. For example, "arrays", "network-interfaces", and "metrics". The value may be `null` if the resource is not represented. ' type: string readOnly: true example: example_resource_type x-readOnly: true PageInfo_2: type: object properties: continuation_token: description: 'Continuation token that can be provided in the `continuation_token` query param to get the next page of data. If you use the `continuation_token` to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The `continuation_token` is generated if the `limit` is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string total_item_count: description: Total number of items after applying `filter` params. type: integer format: int32 _fixedReference: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string readOnly: true name: description: 'The resource name, such as volume name, file system name, snapshot name, and so on. ' type: string readOnly: true x-readOnly: true x-aliases: - _fixedReferenceWithoutType _arraysResource: description: 'A built-in resource that exists on one or multiple arrays. ' allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_arrays' PageInfo_3: type: object properties: continuation_token: description: 'Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string example: MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My total_item_count: description: Total number of items after applying filter params. type: integer format: int32 example: 1 _builtInResourceNoId: description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support settings). Some correspond to a piece of software, like an app, or hardware, like a controller. Others are created by the system in response to some event (e.g., alerts, audit records). Typically, a user can''t create, delete or rename a built-in resource. A few can be created or deleted, but not renamed because the names are meaningful to Purity (e.g., VIFs, file systems, file system snapshots, volume snapshot). ' type: object properties: name: description: 'A locally unique, system-generated name. The name cannot be modified. ' type: string readOnly: true PageInfo: type: object properties: continuation_token: description: 'Continuation token that can be provided in the `continuation_token` query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string more_items_remaining: description: 'Returns a value of `true` if subsequent items can be retrieved. ' type: boolean example: false total_item_count: description: 'The total number of records after applying all filter query parameters. The `total_item_count` will be calculated if and only if the corresponding query parameter `total_item_count` is set to `true`. If this query parameter is not set or set to `false`, a value of `null` will be returned. ' type: integer format: int32