openapi: 3.0.1
info:
title: FlashArray REST Active Directory Log Targets 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: Log Targets
description: 'Log Targets to be used to send management or data audit logs.
'
paths:
/api/2.52/log-targets:
get:
tags:
- Log Targets
summary: Pure Storage List Log Targets
description: Displays a list of configured log targets.
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/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/LogTargetsGetResponse'
'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/LogTargetsGetResponse'
/api/2.52/log-targets/file:
get:
tags:
- Log Targets
summary: Pure Storage List File Log Targets
description: Displays a list of configured file log targets.
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/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/LogTargetFileGetResponse'
'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/LogTargetFileGetResponse'
post:
tags:
- Log Targets
summary: Pure Storage Create File Log Target
description: 'Creates a new file log target.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogTargetFile'
required: true
x-codegen-request-body-name: log-target-file
responses:
'200':
description: Displays the newly configured file log target.
content:
application/json:
schema:
$ref: '#/components/schemas/LogTargetFileResponse'
x-codegen-request-body-name: log-target-file
delete:
tags:
- Log Targets
summary: Pure Storage Delete File Log Target
description: Deletes a configured file log target.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Names'
responses:
'200':
description: OK
content: {}
patch:
tags:
- Log Targets
summary: Pure Storage Modify File Log Target
description: Modifies the URI of a configured file log target.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogTargetFile'
required: true
x-codegen-request-body-name: log-target-file
responses:
'200':
description: Displays the newly updated file log target.
content:
application/json:
schema:
$ref: '#/components/schemas/LogTargetFileResponse'
x-codegen-request-body-name: log-target-file
/api/2.52/log-targets/syslog:
get:
tags:
- Log Targets
summary: Pure Storage List Syslog Servers
description: 'Displays a list of configured syslog servers.
'
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/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/SyslogServerGetResponse'
'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/SyslogServerGetResponse'
post:
tags:
- Log Targets
summary: Pure Storage Create Syslog Server
description: 'Creates a new syslog server.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SyslogServer'
required: true
x-codegen-request-body-name: syslog-server
responses:
'200':
description: Displays the newly configured syslog server.
content:
application/json:
schema:
$ref: '#/components/schemas/SyslogServerResponse'
x-codegen-request-body-name: syslog-server
delete:
tags:
- Log Targets
summary: Pure Storage Delete Syslog Server
description: 'Deletes a configured syslog server and stop forwarding syslog messages.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Names'
responses:
'200':
description: OK
content: {}
patch:
tags:
- Log Targets
summary: Pure Storage Modify Syslog Server
description: 'Modifies the URI and services of a configured syslog server.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SyslogServer'
required: true
x-codegen-request-body-name: syslog-server
responses:
'200':
description: Displays the newly updated syslog server.
content:
application/json:
schema:
$ref: '#/components/schemas/SyslogServerResponse'
x-codegen-request-body-name: syslog-server
/api/2.52/log-targets/syslog/settings:
get:
tags:
- Log Targets
summary: Pure Storage List Syslog Settings
description: 'Displays syslog settings. Values include `continuation_token`, `items`,
`more_items_remaining`, and `total_item_count`.
'
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/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/SyslogServerSettingsGetResponse'
'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/SyslogServerSettingsGetResponse'
patch:
tags:
- Log Targets
summary: Pure Storage Modify Syslog Settings
description: 'Modifies syslog settings. Values include `continuation_token`, `items`,
`more_items_remaining`, and `total_item_count`.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SyslogServerSettings'
required: true
x-codegen-request-body-name: syslog-server-settings
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SyslogServerSettingsResponse'
x-codegen-request-body-name: syslog-server-settings
/api/2.52/log-targets/syslog/test:
get:
tags:
- Log Targets
summary: Pure Storage List Syslog Server Test Results
description: Displays syslog server test results, which indicate whether the syslog is working and configured correctly.
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/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/TestResultWithResourceGetResponse'
'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/TestResultWithResourceGetResponse'
components:
schemas:
_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'
LogTargetFileGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/LogTargetFileResponse'
- $ref: '#/components/schemas/_errorContextResponse'
TestResult:
type: object
properties:
component_address:
description: Address of the component running the test.
type: string
example: 10.230.94.21
component_name:
description: Name of the component running the test.
type: string
example: CT0
description:
description: What the test is doing.
type: string
example: Testing phonehome connectivity
destination:
description: The URI of the target server being tested.
type: string
example: ra.cloud-support.purestorage.com
enabled:
description: 'Whether the object being tested is enabled or not.
Returns a value of `true` if the the service is enabled.
Returns a value of `false` if the service is disabled.
'
type: boolean
example: true
result_details:
description: Additional information about the test result.
type: string
example: Timeout connecting to phonehome endpoint
success:
description: 'Whether the object being tested passed the test or not.
Returns a value of `true` if the specified test has succeeded.
Returns a value of `false` if the specified test has failed.
'
type: boolean
test_type:
description: 'Displays the type of test being performed. The returned values are determined
by the `resource` being tested and its configuration.
Values include `array-admin-group-searching`, `binding`, `connecting`, `phonehome`,
`phonehome-ping`, `remote-assist`, `rootdse-searching`, `read-only-group-searching`,
`storage-admin-group-searching`, and `validate-ntp-configuration`.
'
type: string
example: phonehome
_reference:
type: object
properties:
id:
description: 'A globally unique, system-generated ID.
The ID cannot be modified.
'
type: string
name:
description: 'The resource name, such as volume name, pod name,
snapshot name, and so on.
'
type: string
x-aliases:
- _referenceWithoutType
_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
TestResultWithResource:
allOf:
- $ref: '#/components/schemas/TestResult'
- $ref: '#/components/schemas/_context'
- type: object
properties:
resource:
description: A reference to the object being tested.
title: FixedReferenceNoId
allOf:
- $ref: '#/components/schemas/_fixedReferenceNoId'
_referenceWithType:
allOf:
- $ref: '#/components/schemas/_reference'
- type: object
properties:
resource_type:
description: 'Type of the object (full name of the endpoint).
Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`,
`ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`,
`volume-groups`, `directories`, `policies/nfs`, `policies/smb`, and
`policies/snapshot`, etc.
'
type: string
x-aliases:
- _reference
SyslogServer:
allOf:
- $ref: '#/components/schemas/LogTarget'
- description: A syslog server
type: object
properties:
services:
description: 'Valid values are `data-audit` and `management`.
If not specified, defaults to `management`.
'
type: array
items:
type: string
uri:
description: 'The URI of the syslog server in the format `PROTOCOL://HOSTNAME:PORT`.
'
type: string
example: tcp://my.syslogserver.com
_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
_fixedReferenceNoId:
type: object
properties:
name:
description: 'The resource name,
such as volume name, pod name, snapshot name, and so on.
'
type: string
readOnly: true
x-readOnly: true
LogTarget:
allOf:
- $ref: '#/components/schemas/_fixedNameResourceNoId'
- $ref: '#/components/schemas/_context'
- type: object
properties:
target_type:
description: 'The type of log target. Valid values include `file`, and `syslog`.
'
type: string
readOnly: true
example: syslog
LogTargetsGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/LogTargetsResponse'
- $ref: '#/components/schemas/_errorContextResponse'
LogTargetFile:
allOf:
- $ref: '#/components/schemas/LogTarget'
- description: A file log target
type: object
properties:
directory:
description: 'Directory name to be used as log target.
'
title: ReferenceWithType
allOf:
- $ref: '#/components/schemas/_referenceWithType'
keep_for:
description: 'Specifies the period that audit logs are retained before they are deleted,
in milliseconds.
Default value is `null` which means size based retention does not apply.
Use 0 to reset the value to `null`.
At least one of the `keep_for` or `keep_size` parameters is required,
and they can be set together.
'
type: integer
format: int64
minimum: 86400000
example: 86400000
keep_size:
description: 'Specifies the maximum size of audit logs to be retained.
Measured in bytes. When exceeded, older logs will be deleted.
Default value is `null` which means size-based retention does not apply.
Use 0 to reset the value to `null`.
'
type: integer
format: int64
minimum: 1000000
example: 1000000
TestResultWithResourceGetResponse:
allOf:
- $ref: '#/components/schemas/TotalItemCountResponse'
- $ref: '#/components/schemas/_errorContextResponse'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/TestResultWithResource'
_fixedNameResourceNoId:
description: 'An ordinary (as opposed to built-in) resource that can be created, named, or
deleted by the user. This might be a virtual resource (e.g., a
volume) or correspond to something in the environment, like a host or server.
'
type: object
properties:
name:
description: 'A user-specified name.
The name must be locally unique and cannot be changed.
'
type: string
readOnly: true
LogTargetsResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/LogTarget'
_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'
SyslogServerSettingsResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SyslogServerSettings'
SyslogServerSettings:
description: Global settings for syslog servers.
allOf:
- $ref: '#/components/schemas/_context'
- type: object
properties:
ca_certificate:
description: 'The certificate of the certificate authority (CA) that signed the directory servers''
certificate(s), which is used to validate the authenticity of the configured servers.
'
type: string
logging_severity:
description: 'Returns the configured logging severity threshold for which events will
be forwarded to the configured syslog servers. Default configuration is
info level severity.
Valid values are `debug`, `info`, and `notice`.
'
type: string
tls_audit_enabled:
description: 'Returns a value of `true` if messages that are necessary in order to
audit TLS negotiations performed by the array are forwarded to the
configured syslog servers.
'
type: boolean
TotalItemCountResponse:
type: object
properties:
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
SyslogServerGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/SyslogServerResponse'
- $ref: '#/components/schemas/_errorContextResponse'
_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
LogTargetFileResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/LogTargetFile'
SyslogServerSettingsGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/SyslogServerSettingsResponse'
- $ref: '#/components/schemas/_errorContextResponse'
SyslogServerResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SyslogServer'
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
parameters:
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
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
Context_names:
name: context_names
in: query
description: 'Performs the operation on the context specified.
If specified, the context names must be an array of size 1, and the single element
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`.
'
style: form
explode: false
schema:
type: array
items:
type: string
XRequestId:
name: X-Request-ID
in: header
description: 'Supplied by client during request or generated by server.
'
schema:
type: string
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
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
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
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
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