All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| DataSealingKeysGet | Get /api/2.56/data-sealing-keys | List data sealing keys |
| DataSealingKeysPatch | Patch /api/2.56/data-sealing-keys | Modify data sealing keys |
| DataSealingKeysPost | Post /api/2.56/data-sealing-keys | Create data sealing keys |
| DataSealingKeysRotatePost | Post /api/2.56/data-sealing-keys/rotate | Rotate data sealing keys |
| DataSealingKeysTestGet | Get /api/2.56/data-sealing-keys/test | Test data sealing key remote connectivity |
DataSealingKeyGetResponse DataSealingKeysGet(ctx).Authorization(authorization).XRequestID(xRequestID).AllowErrors(allowErrors).ContextNames(contextNames).ContinuationToken(continuationToken).Filter(filter).Ids(ids).Limit(limit).Names(names).Offset(offset).Sort(sort).TotalItemCount(totalItemCount).Execute()
List data sealing keys
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)
func main() {
configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
APIToken(apiToken).
Build()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
}
apiClient, err := openapiclient.NewClient(configuration)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
}
req := apiClient.DataSealingKeysAPI.DataSealingKeysGet(context.Background())
// Set request parameters ...
resp, r, err := req.Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSealingKeysAPI.DataSealingKeysGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DataSealingKeysGet`: DataSealingKeyGetResponse
fmt.Fprintf(os.Stdout, "Response from `DataSealingKeysAPI.DataSealingKeysGet`: %v\n", resp)
}Other parameters are passed through a pointer to a apiDataSealingKeysGetRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) | |
| xRequestID | string | Supplied by client during request or generated by server. | |
| allowErrors | bool | 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. | [default to false] |
| contextNames | []string | 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`. | |
| continuationToken | string | 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. | |
| filter | string | Narrows down the results to only the response objects that satisfy the filter criteria. | |
| ids | []string | A comma-separated list of unique resource IDs. At least one resource must match each specified ID, otherwise an error is returned. This parameter is required if ids or names is not provided, but it cannot be used together with name or names. | |
| limit | int32 | 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. | |
| names | []string | 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. | |
| offset | int32 | The starting position based on the results of the query in relation to the full set of response objects returned. | |
| sort | []string | Sorts the response objects by the specified fields. Sorting can be applied to any field name in the response, in ascending order by default, or in descending order by prefixing the field name with a minus sign (-). Multiple fields can be specified as a comma-separated list (e.g., sort volumes by size descending, then by name ascending). If sort is provided, the response will not include a continuation_token. | |
| totalItemCount | bool | 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`. |
Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataSealingKeyResponse DataSealingKeysPatch(ctx).DataSealingKeyPatch(dataSealingKeyPatch).Authorization(authorization).XRequestID(xRequestID).ContextNames(contextNames).Ids(ids).Names(names).Execute()
Modify data sealing keys
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)
func main() {
configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
APIToken(apiToken).
Build()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
}
apiClient, err := openapiclient.NewClient(configuration)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
}
req := apiClient.DataSealingKeysAPI.DataSealingKeysPatch(context.Background())
// Set request parameters ...
resp, r, err := req.Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSealingKeysAPI.DataSealingKeysPatch``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DataSealingKeysPatch`: DataSealingKeyResponse
fmt.Fprintf(os.Stdout, "Response from `DataSealingKeysAPI.DataSealingKeysPatch`: %v\n", resp)
}Other parameters are passed through a pointer to a apiDataSealingKeysPatchRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| dataSealingKeyPatch | DataSealingKeyPatch | ||
| authorization | string | Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) | |
| xRequestID | string | Supplied by client during request or generated by server. | |
| contextNames | []string | 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`. | |
| ids | []string | A comma-separated list of unique resource IDs. At least one resource must match each specified ID, otherwise an error is returned. This parameter is required if ids or names is not provided, but it cannot be used together with name or names. | |
| names | []string | 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. |
Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataSealingKeyResponse DataSealingKeysPost(ctx).DataSealingKey(dataSealingKey).Authorization(authorization).XRequestID(xRequestID).ContextNames(contextNames).Names(names).Execute()
Create data sealing keys
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)
func main() {
configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
APIToken(apiToken).
Build()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
}
apiClient, err := openapiclient.NewClient(configuration)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
}
req := apiClient.DataSealingKeysAPI.DataSealingKeysPost(context.Background())
// Set request parameters ...
resp, r, err := req.Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSealingKeysAPI.DataSealingKeysPost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DataSealingKeysPost`: DataSealingKeyResponse
fmt.Fprintf(os.Stdout, "Response from `DataSealingKeysAPI.DataSealingKeysPost`: %v\n", resp)
}Other parameters are passed through a pointer to a apiDataSealingKeysPostRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| dataSealingKey | DataSealingKeyPost | ||
| authorization | string | Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) | |
| xRequestID | string | Supplied by client during request or generated by server. | |
| contextNames | []string | 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`. | |
| names | []string | 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. |
Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataSealingKeyResponse DataSealingKeysRotatePost(ctx).Authorization(authorization).XRequestID(xRequestID).ContextNames(contextNames).Ids(ids).Names(names).DataSealingKey(dataSealingKey).Execute()
Rotate data sealing keys
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)
func main() {
configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
APIToken(apiToken).
Build()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
}
apiClient, err := openapiclient.NewClient(configuration)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
}
req := apiClient.DataSealingKeysAPI.DataSealingKeysRotatePost(context.Background())
// Set request parameters ...
resp, r, err := req.Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSealingKeysAPI.DataSealingKeysRotatePost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DataSealingKeysRotatePost`: DataSealingKeyResponse
fmt.Fprintf(os.Stdout, "Response from `DataSealingKeysAPI.DataSealingKeysRotatePost`: %v\n", resp)
}Other parameters are passed through a pointer to a apiDataSealingKeysRotatePostRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) | |
| xRequestID | string | Supplied by client during request or generated by server. | |
| contextNames | []string | 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`. | |
| ids | []string | A comma-separated list of unique resource IDs. At least one resource must match each specified ID, otherwise an error is returned. This parameter is required if ids or names is not provided, but it cannot be used together with name or names. | |
| names | []string | 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. | |
| dataSealingKey | DataSealingKeyRotate |
Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TestResultWithResourceAndErrorContextPartialResourceResponse DataSealingKeysTestGet(ctx).Authorization(authorization).XRequestID(xRequestID).AllowErrors(allowErrors).ContextNames(contextNames).ContinuationToken(continuationToken).Filter(filter).Ids(ids).Limit(limit).Names(names).Offset(offset).Sort(sort).TotalItemCount(totalItemCount).Execute()
Test data sealing key remote connectivity
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)
func main() {
configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
APIToken(apiToken).
Build()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
}
apiClient, err := openapiclient.NewClient(configuration)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
}
req := apiClient.DataSealingKeysAPI.DataSealingKeysTestGet(context.Background())
// Set request parameters ...
resp, r, err := req.Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSealingKeysAPI.DataSealingKeysTestGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DataSealingKeysTestGet`: TestResultWithResourceAndErrorContextPartialResourceResponse
fmt.Fprintf(os.Stdout, "Response from `DataSealingKeysAPI.DataSealingKeysTestGet`: %v\n", resp)
}Other parameters are passed through a pointer to a apiDataSealingKeysTestGetRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) | |
| xRequestID | string | Supplied by client during request or generated by server. | |
| allowErrors | bool | 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. | [default to false] |
| contextNames | []string | 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`. | |
| continuationToken | string | 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. | |
| filter | string | Narrows down the results to only the response objects that satisfy the filter criteria. | |
| ids | []string | A comma-separated list of unique resource IDs. At least one resource must match each specified ID, otherwise an error is returned. This parameter is required if ids or names is not provided, but it cannot be used together with name or names. | |
| limit | int32 | 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. | |
| names | []string | 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. | |
| offset | int32 | The starting position based on the results of the query in relation to the full set of response objects returned. | |
| sort | []string | Sorts the response objects by the specified fields. Sorting can be applied to any field name in the response, in ascending order by default, or in descending order by prefixing the field name with a minus sign (-). Multiple fields can be specified as a comma-separated list (e.g., sort volumes by size descending, then by name ascending). If sort is provided, the response will not include a continuation_token. | |
| totalItemCount | bool | 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`. |
TestResultWithResourceAndErrorContextPartialResourceResponse
Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]