openapi: 3.0.1
info:
title: FlashArray REST Active Directory Lifecycle Rules 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: Lifecycle Rules
description: A life cycle rule helps manage the number of copies of a specific bucket. A lifecycle rule can be applied to a bucket with a rule indicating the retention time before it is to be deleted.
paths:
/api/2.52/lifecycle-rules:
get:
tags:
- Lifecycle Rules
summary: Pure Storage GET Lifecycle-rules
description: 'Returns a list of lifecycle rules.
When `names` is specified, list the individual rules.
When `ids` is specified, `bucket_names` or `bucket_ids` is also required.
When `bucket_names` or `bucket_ids` are specified without `ids`,
if there are at most 10 buckets with lifecycle rules in the system,
list all the rules for the bucket, else it returns an error.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Allow_errors'
- $ref: '#/components/parameters/Bucket_ids'
- $ref: '#/components/parameters/Bucket_names'
- $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'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Total_item_count'
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/LifecycleRuleGetResponse'
'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/LifecycleRuleGetResponse'
post:
tags:
- Lifecycle Rules
summary: Pure Storage POST Lifecycle-rules
description: 'Creates a lifecycle rule.
`bucket` and `keep_previous_version_for` are required.
If `rule_id` is not specified,
it will be automatically generated in the format "faRuleIdX".
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Confirm_date'
- $ref: '#/components/parameters/Context_names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_lifecycleRulePostBase'
required: true
x-codegen-request-body-name: rule
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/LifecycleRuleResponse'
x-codegen-request-body-name: rule
delete:
tags:
- Lifecycle Rules
summary: Pure Storage DELETE Lifecycle-rules
description: 'Deletes individual lifecycle rules by name or id, or deletes all rules for a bucket.
If `ids` is specified, `bucket_names` or `bucket_ids` is also required.
If `bucket_names` or `bucket_ids` are specified without `ids`,
delete all the rules for the bucket.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Bucket_ids'
- $ref: '#/components/parameters/Bucket_names'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Ids'
- $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:
- Lifecycle Rules
summary: Pure Storage PATCH Lifecycle-rules
description: 'Modify an existing lifecycle rule by name or id.
If `ids` is specified, `bucket_names` or `bucket_ids` is also required.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Bucket_ids'
- $ref: '#/components/parameters/Bucket_names'
- $ref: '#/components/parameters/Confirm_date'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_lifecycleRulePatchBase'
required: true
x-codegen-request-body-name: lifecycle
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/LifecycleRuleResponse'
x-codegen-request-body-name: lifecycle
/api/2.26/lifecycle-rules:
get:
tags:
- Lifecycle Rules
summary: Pure Storage GET Lifecycle-rules
description: 'Returns a list of lifecycle rules.
If `names` is specified, list the individual rules.
If `ids` is specified, `bucket_names` or `bucket_ids` is also required.
If `bucket_names` or `bucket_ids` are specified without `ids`,
list all the rules for the bucket.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Allow_errors'
- $ref: '#/components/parameters/Bucket_ids'
- $ref: '#/components/parameters/Bucket_names'
- $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/LifecycleRuleGetResponse_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/LifecycleRuleGetResponse_2'
post:
tags:
- Lifecycle Rules
summary: Pure Storage POST Lifecycle-rules
description: 'Creates a lifecycle rule.
`bucket` and `keep_previous_version_for` are required.
If `rule_id` is not specified,
it will be automatically generated in the format "fbRuleIdX".
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Confirm_date'
- $ref: '#/components/parameters/Context_names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LifecycleRulePost'
required: true
x-codegen-request-body-name: rule
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/LifecycleRuleResponse'
x-codegen-request-body-name: rule
delete:
tags:
- Lifecycle Rules
summary: Pure Storage DELETE Lifecycle-rules
description: 'Deletes individual lifecycle rules by name or id, or deletes all rules for a bucket.
If `ids` is specified, `bucket_names` or `bucket_ids` is also required.
If `bucket_names` or `bucket_ids` are specified without `ids`,
delete all the rules for the bucket.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Bucket_ids'
- $ref: '#/components/parameters/Bucket_names'
- $ref: '#/components/parameters/Context_names'
- $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:
- Lifecycle Rules
summary: Pure Storage PATCH Lifecycle-rules
description: 'Modify an existing lifecycle rule by name or id.
If `ids` is specified, `bucket_names` or `bucket_ids` is also required.
'
parameters:
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Bucket_ids'
- $ref: '#/components/parameters/Bucket_names'
- $ref: '#/components/parameters/Confirm_date'
- $ref: '#/components/parameters/Context_names'
- $ref: '#/components/parameters/Ids_2'
- $ref: '#/components/parameters/Names'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LifecycleRulePatch'
required: true
x-codegen-request-body-name: lifecycle
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/LifecycleRuleResponse'
x-codegen-request-body-name: lifecycle
components:
schemas:
_referenceWithoutType:
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
_lifecycleRuleBase:
allOf:
- $ref: '#/components/schemas/_context'
- $ref: '#/components/schemas/_lifecycle_rule_config_base'
- type: object
properties:
bucket:
description: 'The bucket which this lifecycle rule is targeting.
'
title: FixedReferenceWithType
allOf:
- $ref: '#/components/schemas/_fixedReferenceWithType'
cleanup_expired_object_delete_marker:
description: 'Returns a value of `true` if the expired object delete markers will be removed.
'
type: boolean
readOnly: true
example: true
enabled:
description: 'If set to `true`, this rule will be enabled.
'
type: boolean
rule_id:
description: 'The identifier for the rule. It must be unique to the bucket.
The maximum length is 255 characters.
If not specified, an ID unique to the bucket is generated in the format
`<platformName>RuleId<number>`, where `<number>` increments starting at 1.
'
type: string
_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'
_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
LifecycleRule:
allOf:
- $ref: '#/components/schemas/_builtIn'
- $ref: '#/components/schemas/_lifecycleRuleBase'
LifecycleRuleResponse:
type: object
properties:
items:
description: A list of lifecycle rule objects.
type: array
items:
$ref: '#/components/schemas/LifecycleRule'
_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'
LifecycleRulePatch:
allOf:
- $ref: '#/components/schemas/_lifecycleRuleConfigExtension'
- type: object
properties:
enabled:
description: 'If set to `true`, this rule will be enabled.
'
type: boolean
keep_previous_version_for:
description: 'Time after which previous versions will be marked expired.
Measured in milliseconds.
Must be a multiple of 86400000 to represent a whole number of days.
'
type: integer
format: int64
prefix:
description: 'Object key prefix identifying one or more objects in the bucket.
Can have a maximum length of 1024 characters.
'
type: string
_referenceWritable:
allOf:
- $ref: '#/components/schemas/_referenceWithoutType'
- 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`, `policies/snapshot`, etc.
'
type: string
x-aliases:
- _reference
_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
_lifecycleRulePatchBase:
allOf:
- $ref: '#/components/schemas/_lifecycle_rule_config_base'
- type: object
properties:
enabled:
description: 'If set to `true`, this rule will be enabled.
'
type: boolean
LifecycleRulePost:
allOf:
- $ref: '#/components/schemas/_lifecycleRuleConfigExtension'
- type: object
properties:
bucket:
description: The bucket name for lifecycle rule creation.
title: ReferenceWritable
allOf:
- $ref: '#/components/schemas/_referenceWritable'
keep_previous_version_for:
description: 'Time after which previous versions will be marked expired.
Measured in milliseconds.
Must be a multiple of 86400000 to represent a whole number of days.
'
type: integer
format: int64
prefix:
description: 'Object key prefix identifying one or more objects in the bucket.
Can have a maximum length of 1024 characters.
'
type: string
rule_id:
description: 'Identifier for the rule that is unique to the bucket
that it applies to.
Can have a maximum length of 255 characters.
If not specified, an id unique to the bucket will be generated in the
format `fbRuleId<number>` where number increments, starting at 1.
'
type: string
_lifecycle_rule_config_base:
type: object
properties:
abort_incomplete_multipart_uploads_after:
description: 'Duration of time after which incomplete multipart uploads will be aborted.
Measured in milliseconds.
Must be a multiple of 86400000 to represent a whole number of days.
'
type: integer
format: int64
example: 86400000
keep_current_version_for:
description: 'Time after which current versions will be marked expired.
Measured in milliseconds.
Must be a multiple of 86400000 to represent a whole number of days.
'
type: integer
format: int64
example: 86400000
keep_current_version_until:
description: 'Time after which current versions will be marked expired.
Measured in milliseconds, time since epoch.
Must be a valid date, accurate to day.
'
type: integer
format: int64
example: 1636588800000
keep_previous_version_for:
description: 'The time in milliseconds after which previous versions are marked expired.
Must be a multiple of 86400000 to represent a whole number of days.
'
type: integer
format: int64
prefix:
description: 'The object key prefix identifying one or more objects in the bucket.
The maximum length is 1024 characters.
'
type: string
_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
_builtIn:
description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support
settings). Some correspond to a piece of software, like an app, or hardware,
like a controller. Others are created by the system in response to some event
(e.g., alerts, audit records).
Typically, a user can''t create, delete or rename a built-in resource. A few
can be created or deleted, but not renamed because the names are meaningful
to Purity (e.g., VIFs).
'
type: object
properties:
id:
description: 'A globally unique, system-generated ID.
The ID cannot be modified and cannot refer to another resource.
'
type: string
readOnly: true
name:
description: 'A locally unique, system-generated name. The name cannot be modified.
'
type: string
readOnly: true
_lifecycleRuleConfigExtension:
type: object
properties:
abort_incomplete_multipart_uploads_after:
description: 'Duration of time after which incomplete multipart uploads will be aborted.
Measured in milliseconds.
Must be a multiple of 86400000 to represent a whole number of days.
'
type: integer
format: int64
example: 86400000
keep_current_version_for:
description: 'Time after which current versions will be marked expired.
Measured in milliseconds.
Must be a multiple of 86400000 to represent a whole number of days.
'
type: integer
format: int64
example: 86400000
keep_current_version_until:
description: 'Time after which current versions will be marked expired.
Measured in milliseconds, time since epoch.
Must be a valid date, accurate to day.
'
type: integer
format: int64
example: 1636588800000
_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'
LifecycleRuleGetResponse_2:
allOf:
- $ref: '#/components/schemas/PageInfo_2'
- $ref: '#/components/schemas/_errorContextResponse_2'
- $ref: '#/components/schemas/LifecycleRuleResponse'
_lifecycleRulePostBase:
allOf:
- $ref: '#/components/schemas/_lifecycle_rule_config_base'
- type: object
properties:
bucket:
description: 'The bucket targeted by the lifecycle rule.
'
title: ReferenceWithType
allOf:
- $ref: '#/components/schemas/_referenceWithType'
rule_id:
description: 'The identifier for the rule. It must be unique to the bucket.
The maximum length is 255 characters.
If not specified, an ID unique to the bucket is generated in the format
`<platformName>RuleId<number>`, where `<number>` increments starting at 1.
'
type: string
_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
LifecycleRuleGetResponse:
allOf:
- $ref: '#/components/schemas/_errorContextResponse'
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/LifecycleRuleResponse'
_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
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
Bucket_ids:
name: bucket_ids
in: query
description: 'A comma-separated list of bucket IDs.
If after filtering, there is not at least one resource that matches
each of the elements of `bucket_ids`, then an error is returned.
This cannot be provided together with the `bucket_names` query parameter.
This can be provided with the `ids` query parameter but not with `names`.
'
style: form
explode: false
schema:
type: array
items:
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
XRequestId:
name: X-Request-ID
in: header
description: 'Supplied by client d
# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/openapi/pure-storage-lifecycle-rules-api-openapi.yml