openapi: 3.0.1
info:
title: FlashArray REST Active Directory Syslog 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: Syslog
description: 'Copied to Log Targets/Syslog for more organized way to handle all log targets.
Both endpoints are identical. We encourage our users to use Log Targets/Syslog.
'
paths:
/api/2.52/syslog-servers:
get:
tags:
- Syslog
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:
- Syslog
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:
- Syslog
summary: Pure Storage Delete Syslog Server
description: 'Deletes a configured syslog server and stops 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:
- Syslog
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/syslog-servers/settings:
get:
tags:
- Syslog
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:
- Syslog
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/syslog-servers/test:
get:
tags:
- Syslog
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'
/api/2.26/syslog-servers:
get:
tags:
- Syslog
summary: Pure Storage GET Syslog-servers
description: Return a list of configured syslog servers.
parameters:
- $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/Ids'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Names_for_syslog'
- $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/SyslogServerGetResponse_2'
'207':
description: 'Partial success. Some resources were returned, but there
were also errors possibly preventing some resources from
being returned.
'
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/SyslogServerGetResponse_2'
post:
tags:
- Syslog
summary: Pure Storage POST Syslog-servers
description: 'Configure a new syslog server.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Names_for_syslog'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SyslogServerPost'
required: true
x-codegen-request-body-name: syslog-server
responses:
'200':
description: Returns the newly configured syslog server.
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/SyslogServerResponse'
x-codegen-request-body-name: syslog-server
delete:
tags:
- Syslog
summary: Pure Storage DELETE Syslog-servers
description: 'Delete a configured syslog server and stop forwarding syslog messages.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Names_for_syslog'
responses:
'200':
description: OK
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
content: {}
patch:
tags:
- Syslog
summary: Pure Storage PATCH Syslog-servers
description: Modify the URI or services of a configured syslog server.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Names_for_syslog'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SyslogServerPatch'
required: true
x-codegen-request-body-name: syslog-server
responses:
'200':
description: Returns the newly updated syslog server.
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/SyslogServerResponse'
x-codegen-request-body-name: syslog-server
/api/2.26/syslog-servers/settings:
get:
tags:
- Syslog
summary: Pure Storage GET Syslog-servers/settings
description: List the certificate or certificate group associated with the syslog servers.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids'
- $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/SyslogServerSettingsGetResponse_2'
patch:
tags:
- Syslog
summary: Pure Storage PATCH Syslog-servers/settings
description: Modify the certificate or certificate group associated with the syslog servers.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SyslogServerSettings_2'
required: true
x-codegen-request-body-name: syslog-server-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/SyslogServerSettingsResponse'
x-codegen-request-body-name: syslog-server-settings
/api/2.26/syslog-servers/test:
get:
tags:
- Syslog
summary: Pure Storage GET Syslog-servers/test
description: Send test messages to conifgured remote syslog servers.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
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/TestResultGetResponse'
components:
schemas:
SyslogServerGetResponse_2:
allOf:
- $ref: '#/components/schemas/PageInfo_2'
- $ref: '#/components/schemas/SyslogServerContextResponse'
- $ref: '#/components/schemas/_errorContextResponse_2'
_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: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference_2'
message:
description: A description of the error which occurred.
type: string
example: Resource does not exist.
_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'
SyslogServerPost:
allOf:
- $ref: '#/components/schemas/SyslogServerPostOrPatch'
- type: object
properties:
services:
description: 'Valid values are `data-audit` and `management`.
If not specified, defaults to `management`.
'
type: array
items:
type: string
sources:
description: 'The network interfaces used for communication with the syslog server.
The network interfaces must have the `services` value of `data`.
Only network interfaces within default array realm are supported.
'
type: array
maxItems: 1
items:
$ref: '#/components/schemas/_reference'
SyslogServerContextResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SyslogServerContext'
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
TestResultResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/TestResult_2'
_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
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
readOnly: true
x-aliases:
- _referenceWithFixedType
_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
file system), or correspond to something in the environment, like a host or a
server.
'
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 user-specified name.
The name must be locally unique and can be changed.
'
type: string
_fixedReferenceWithoutType:
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
_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'
SyslogServerPostOrPatch:
description: A syslog server
type: object
properties:
uri:
description: 'The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.
'
type: string
example: tcp://my.syslogserver.com
_errorContextResponse_2:
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'
SyslogServer_2:
allOf:
- $ref: '#/components/schemas/SyslogServerPost'
- $ref: '#/components/schemas/_resource'
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
SyslogServerPatch:
allOf:
- $ref: '#/components/schemas/SyslogServerPostOrPatch'
- type: object
properties:
services:
description: 'Valid values are `data-audit` and `management`.
'
type: array
items:
type: string
sources:
description: 'The network interfaces used for communication with the syslog server.
The network interfaces must have the `services` value of `data`.
Only network interfaces within default array realm are supported.
Clear this by setting an empty list.
'
type: array
maxItems: 1
items:
$ref: '#/components/schemas/_reference'
SyslogServerSettings_2:
allOf:
- $ref: '#/components/schemas/_builtIn'
- description: Global settings for syslog servers.
type: object
properties:
ca_certificate:
type: object
allOf:
- $ref: '#/components/schemas/_reference'
- description: 'CA certificate used to validate the authenticity of the configured
servers.
'
type: object
ca_certificate_group:
type: object
allOf:
- $ref: '#/components/schemas/_reference'
- description: 'A certificate group containing CA certificates that can be used to
validate the authenticity of the configured servers.
'
type: object
TestResultGetResponse:
allOf:
- $ref: '#/components/schemas/TestResultResponse'
- type: object
properties:
total_item_count:
description: Total number of items after applying `filter` params.
type: integer
format: int32
_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
_builtIn:
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
SyslogServerSettingsGetResponse_2:
allOf:
- $ref: '#/components/schemas/PageInfo_2'
- $ref: '#/components/schemas/SyslogServerSettingsResponse'
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
_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'
_context_2:
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: FixedReference
allOf:
- $ref: '#/components/schemas/_fixedReference_2'
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
SyslogServerContext:
allOf:
- $ref: '#/components/schemas/SyslogServer_2'
- $ref: '#/components/schemas/_context_2'
_fixedReference_2:
allOf:
- $ref: '#/components/schemas/_fixedReferenceWithoutType'
- 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
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'
PageInfo_2:
type: object
properties:
continuation_token:
description: 'Continuation token that can be provided in the `continuation_token` quer
# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/openapi/pure-storage-syslog-api-openapi.yml