openapi: 3.0.1
info:
title: FlashArray REST Active Directory Servers 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: Servers
paths:
/api/2.52/servers:
get:
tags:
- Servers
summary: Pure Storage List Servers
description: 'Displays a list of servers.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $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/Fqnames'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
- $ref: '#/components/parameters/Total_only'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ServerGetResponse'
post:
tags:
- Servers
summary: Pure Storage Create Server
description: 'Creates a server on the local array.
The server must be given a unique name.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Create_local_directory_service'
- $ref: '#/components/parameters/Fqnames'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServerPost'
required: false
x-codegen-request-body-name: server
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ServerResponse'
x-codegen-request-body-name: server
delete:
tags:
- Servers
summary: Pure Storage Delete Server
description: 'Deletes a server.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Cascade_delete'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Fqnames'
responses:
'200':
description: OK
content: {}
patch:
tags:
- Servers
summary: Pure Storage Modify Server
description: 'Modifies server details.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Fqnames'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServerPatch'
required: true
x-codegen-request-body-name: server
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ServerResponse'
x-codegen-request-body-name: server
/api/2.26/servers:
get:
tags:
- Servers
summary: Pure Storage GET Servers
description: List 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_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/ServerGetResponse_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/ServerGetResponse_2'
post:
tags:
- Servers
summary: Pure Storage POST Servers
description: Add a server.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Create_ds'
- $ref: '#/components/parameters/Create_local_directory_service'
- $ref: '#/components/parameters/Names_required'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServerPost_2'
required: true
x-codegen-request-body-name: server
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/ServerResponse_2'
x-codegen-request-body-name: server
delete:
tags:
- Servers
summary: Pure Storage DELETE Servers
description: Delete a server.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Cascade_delete_2'
- $ref: '#/components/parameters/Ids_2'
- $ref: '#/components/parameters/Names'
responses:
'200':
description: OK
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
content: {}
patch:
tags:
- Servers
summary: Pure Storage PATCH Servers
description: Modify the server attributes.
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Ids_2'
- $ref: '#/components/parameters/Names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServerPatch_2'
required: true
x-codegen-request-body-name: server
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/ServerResponse_2'
x-codegen-request-body-name: server
components:
schemas:
ServerPatch_2:
allOf:
- $ref: '#/components/schemas/ServerPost_2'
ServerContext:
allOf:
- $ref: '#/components/schemas/Server_2'
- $ref: '#/components/schemas/_context_2'
ServerPatch:
allOf:
- $ref: '#/components/schemas/_newName'
- $ref: '#/components/schemas/ServerPost'
_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'
ServerPost:
type: object
properties:
directory_services:
description: 'The directory service configuration to be used by this server.
'
type: array
maxItems: 1
items:
$ref: '#/components/schemas/_reference'
dns:
description: 'The DNS configuration to be used by this server.
'
type: array
maxItems: 1
items:
$ref: '#/components/schemas/_reference'
local_directory_service:
description: 'The Local Directory Service to be associated to the server.
'
title: Reference
allOf:
- $ref: '#/components/schemas/_reference'
ServerGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/ServerResponse'
- $ref: '#/components/schemas/_errorContextResponse'
_newName:
type: object
properties:
name:
description: The new name for the resource.
type: string
_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
_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
_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
_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'
_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
ServerPost_2:
type: object
properties:
dns:
description: 'The DNS config to be used by this server.
'
type: array
maxItems: 1
items:
$ref: '#/components/schemas/_reference_2'
local_directory_service:
description: 'The Local Directory Service to be associated to the server.
'
title: Reference
allOf:
- $ref: '#/components/schemas/_reference_2'
ServerResponse_2:
type: object
properties:
items:
description: A list of server objects.
type: array
items:
$ref: '#/components/schemas/Server_2'
ServerGetResponse_2:
allOf:
- $ref: '#/components/schemas/PageInfo_2'
- $ref: '#/components/schemas/ServerResponseContext'
- $ref: '#/components/schemas/_errorContextResponse_2'
_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'
Server:
allOf:
- $ref: '#/components/schemas/_resource'
- $ref: '#/components/schemas/_context'
- description: 'Server represents a logical configuration scope, which enables
utilizing array resources with different authentication providers
- Active Directory or Directory Services.
'
type: object
properties:
created:
description: 'Creation timestamp of the server.
'
type: integer
format: int64
readOnly: true
directory_services:
description: 'The directory service configuration to be used by this server.
'
type: array
maxItems: 1
items:
$ref: '#/components/schemas/_fixedReferenceWithType'
dns:
description: 'The DNS configuration to be used by this server.
'
type: array
maxItems: 1
items:
$ref: '#/components/schemas/_fixedReferenceWithType'
local_directory_service:
description: 'The Local Directory Service associated to the server.
'
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'
ServerResponseContext:
type: object
properties:
items:
description: A list of server objects.
type: array
items:
$ref: '#/components/schemas/ServerContext'
_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
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
ServerResponse:
type: object
properties:
items:
description: 'The aggregate value of all items after filtering.
When applicable, the average value is displayed instead.
The values are displayed for each field, if meaningful.
'
type: array
items:
$ref: '#/components/schemas/Server'
Server_2:
allOf:
- $ref: '#/components/schemas/_resource'
- $ref: '#/components/schemas/ServerPost_2'
- type: object
properties:
created:
description: Creation timestamp of the server.
type: integer
format: int64
readOnly: true
directory_services:
description: 'The directory service config to be used by this server.
'
type: array
maxItems: 1
readOnly: true
items:
$ref: '#/components/schemas/_reference_2'
realms:
description: 'The realms containing this server.
'
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
Cascade_delete_2:
name: cascade_delete
in: query
description: 'The resource types to delete when deleting this object. It will fail if the resources are
referenced by other objects.
Valid values include `directory-services`.
'
required: true
style: form
explode: false
schema:
type: array
items:
type: string
example: directory-services
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
Total_only:
name: total_only
in: query
description: 'If set to `true`, returns the aggregate value of all items after filtering.
Where it makes more sense, the average value is displayed instead.
The values are displayed for each name where meaningful.
If `total_only=true`, the `items` list will be empty.
'
schema:
type: boolean
Create_local_directory_service:
name: create_local_directory_service
in: query
description: 'The name of the local directory service object to be created and associated to the server.
This parameter cannot be used together with `local_directory_service` property in the request
entity.
'
schema:
type: string
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
Create_ds:
name: create_ds
in: query
description: 'The name of the directory service object to create used for NFS access to this server.
The name must be the server `name` followed by _nfs.
'
required: true
schema:
type: string
example: server1_nfs
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 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_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
Cascade_delete:
name: cascade_delete
in: query
description: 'The resource types to delete when deleting the object.
It will fail if the resources are referenced by other objects.
Valid values include `directory-services`.
'
style: form
explode: false
schema:
type: array
items:
type: string
example: directory-services
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
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