openapi: 3.0.1
info:
title: FlashArray REST Active Directory DNS 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: DNS
description: 'DNS attributes include the domain suffix, static name servers, mode (static or DHCP), and search
domain. The configured attributes can be listed.
'
paths:
/api/2.52/dns:
get:
tags:
- DNS
summary: Pure Storage List DNS Parameters
description: 'Displays the current DNS configurations and their parameters
including domain suffix, the list of DNS name server IP addresses,
and the list of services that DNS parameters apply to.
'
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/Fqnames'
- $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/DnsGetResponse'
'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/DnsGetResponse'
post:
tags:
- DNS
summary: Pure Storage Create DNS Configuration
description: 'Creates new DNS configuration with parameters including the domain suffix,
the list of DNS name server IP addresses, and the list of services that DNS parameters
apply to.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Fqnames'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DnsPost'
required: true
x-codegen-request-body-name: dns
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DnsResponse'
x-codegen-request-body-name: dns
delete:
tags:
- DNS
summary: Pure Storage Delete DNS Configuration
description: 'Deletes DNS configuration identified by configuration name.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Fqnames'
responses:
'200':
description: OK
content: {}
patch:
tags:
- DNS
summary: Pure Storage Modify DNS Parameters
description: 'Modifies the DNS parameters of an array, including the domain suffix, the list of
DNS name server IP addresses, and the list of services that DNS parameters apply to.
If there is no DNS configuration beforehand new DNS configuration with ''default''
name is created. If more than one DNS configuration exists, `name` has to be specified
to identify the DNS configuration to be modified.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Fqnames'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DnsPatch'
required: true
x-codegen-request-body-name: dns
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DnsResponse'
x-codegen-request-body-name: dns
/api/2.26/dns:
get:
tags:
- DNS
summary: Pure Storage GET Dns
description: 'Displays the current DNS configurations and their parameters
including domain suffix, the list of DNS name server IP addresses,
and the list of services that DNS parameters apply to.
'
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'
- $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/DnsGetResponse'
'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/DnsGetResponse'
post:
tags:
- DNS
summary: Pure Storage POST Dns
description: 'Creates new DNS configuration with parameters including the domain suffix,
the list of DNS name server IP addresses, and the list of services that DNS parameters
apply to.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Names_required'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DnsPost_2'
required: true
x-codegen-request-body-name: dns
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/DnsResponse_2'
x-codegen-request-body-name: dns
delete:
tags:
- DNS
summary: Pure Storage DELETE Dns
description: 'Deletes a DNS configuration.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Names'
responses:
'200':
description: OK
content: {}
patch:
tags:
- DNS
summary: Pure Storage PATCH Dns
description: Modify a DNS configuration.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Dns_2'
required: true
x-codegen-request-body-name: dns
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/DnsResponse_2'
x-codegen-request-body-name: dns
components:
schemas:
DnsPost:
description: 'Configuration information for the domain name servers.
'
type: object
properties:
ca_certificate:
description: 'A reference to the `certificate` to use for validating nameservers
with HTTPS connections.
This property is mutually exclusive with `ca_certificate_group` property and may only
be configured when nameservers begin with HTTPS.
'
title: ReferenceWithType
allOf:
- $ref: '#/components/schemas/_referenceWithType'
ca_certificate_group:
description: 'A reference to the `certificate group` to use for validating nameservers
with HTTPS connections.
This property is mutually exclusive with `ca_certificate` property and may only
be configured when nameservers begin with HTTPS.
'
title: ReferenceWithType
allOf:
- $ref: '#/components/schemas/_referenceWithType'
domain:
description: 'The domain suffix to be appended by the appliance when performing DNS lookups.
'
type: string
example: example.com
nameservers:
description: 'The list of DNS servers either in the form of IP addresses or HTTPS endpoints.
Domain names in HTTPS endpoints are not supported. IP addresses must be used instead.
If nameservers begin with `https://`, then DNS queries will be performed over HTTPS.
Otherwise, unencrypted DNS queries will be performed.
Using a combination of nameservers that begin with `https://` and that do not begin
with `https://` is not supported.
If servers are specified with `https://` one of `ca_certificate` and `ca_certificate_group`
parameters must be set.
'
type: array
items:
type: string
example:
- 192.168.0.125
services:
description: 'The list of services utilizing the DNS configuration.
'
type: array
items:
type: string
description: 'Valid values include `management` and `file`.
'
source:
description: 'The network interface used for communication with the DNS server.
'
title: ReferenceNoId
allOf:
- $ref: '#/components/schemas/_referenceNoId'
DnsPatch:
allOf:
- $ref: '#/components/schemas/_newName'
- $ref: '#/components/schemas/DnsPost'
_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'
_referenceNoId:
type: object
properties:
name:
description: 'The resource name, such as volume name, pod name, snapshot name, and so on.
'
type: string
_newName:
type: object
properties:
name:
description: The new name for the resource.
type: string
DnsResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Dns'
_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
_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
_resourceNoId:
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 environment, like a host or a
server.
'
type: object
properties:
name:
description: 'A user-specified name.
The name must be locally unique and can be changed.
'
type: string
_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
DnsResponse_2:
type: object
properties:
items:
description: A list of dns objects.
type: array
items:
$ref: '#/components/schemas/Dns_2'
_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
Dns:
allOf:
- $ref: '#/components/schemas/_context'
- $ref: '#/components/schemas/_resourceNoId'
- $ref: '#/components/schemas/DnsPost'
Dns_2:
allOf:
- $ref: '#/components/schemas/_context_2'
- $ref: '#/components/schemas/_resource'
- $ref: '#/components/schemas/DnsPost_2'
- $ref: '#/components/schemas/_realmsReference'
DnsGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/DnsResponse'
- $ref: '#/components/schemas/_errorContextResponse'
_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'
_reference_2:
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
_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
DnsPost_2:
type: object
properties:
ca_certificate:
description: 'A reference to the `certificate` to use for validating nameservers
with https connections.
This property is mutually exclusive with `ca_certificate_group` property and may only
be configured when nameservers begin with https.
'
title: Reference
allOf:
- $ref: '#/components/schemas/_reference_2'
ca_certificate_group:
description: 'A reference to the `certificate group` to use for validating nameservers
with https connections.
This property is mutually exclusive with `ca_certificate` property and may only
be configured when nameservers begin with https.
'
title: Reference
allOf:
- $ref: '#/components/schemas/_reference_2'
domain:
description: 'Domain suffix to be appended by the appliance when performing DNS lookups.
'
type: string
example: example.com
nameservers:
description: 'The list of DNS servers either in form of IP addresses or https endpoints.
Domain names in https endpoints are not supported. IP addresses must be used instead.
If nameservers begin with `https://`, then DNS queries will be performed over HTTPS.
Otherwise, unencrypted DNS queries will be performed.
Using a combination of nameservers that begin with `https://` and that do not begin
with `https://` is not supported.
If servers are specified with `https://` one of `ca_certificate` and `ca_certificate_group`
parameters is required to be set.
'
type: array
maxItems: 3
items:
type: string
example: ''
services:
description: 'The list of services utilizing the DNS configuration.
'
type: array
items:
type: string
description: 'Valid values include `management` and `data`.
'
sources:
description: 'The network interfaces used for communication with the DNS server.
The network interfaces must have the `services` value of `data` or `egress-only`.
Clear this by setting an empty list.
'
type: array
maxItems: 1
items:
$ref: '#/components/schemas/_reference_2'
_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
_realmsReference:
type: object
properties:
realms:
description: 'Reference to the realms this resource belongs to.
The value is set to empty array when the resource
lives outside of a realm.
'
type: array
readOnly: true
items:
$ref: '#/components/schemas/_fixedReference_2'
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:
Fqnames:
name: names
in: query
description: 'Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, `name01,pod01::name01`.
'
style: form
explode: false
schema:
type: array
items:
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
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
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
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
Names_required:
name: names
in: query
description: 'A comma-separated list of resource names.
'
required: true
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
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 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
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