{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Realm Connections API", "version": "2.52" }, "items": [ { "info": { "name": "Realm Connections", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Realm Connections.", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/realm-connections", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "ids", "value": "", "type": "query", "description": "Performs the operation on the unique resource IDs specified.\nEnter multiple resource IDs in comma-separated format.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "local_realm_ids", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource IDs.\nEnter multiple resource IDs in comma-separated format.\nThe local_realm_ids and local_realm_names parameters cannot be set together.\n" }, { "name": "local_realm_names", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource names.\nEnter multiple resource names in comma-separated format.\nThe local_realm_names and local_realm_ids parameters cannot be set together.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "remote_realm_ids", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource IDs.\nEnter multiple resource IDs in comma-separated format.\nThe remote_realm_ids and remote_realm_names parameters cannot be set together.\n" }, { "name": "remote_realm_names", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource IDs.\nEnter multiple resource IDs in comma-separated format.\nThe remote_realm_ids and remote_realm_names parameters cannot be set together.\n" }, { "name": "sort", "value": "", "type": "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" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays a list of configured realm connections.\n\n" }, { "info": { "name": "Pure Storage Create Realm Connection.", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/realm-connections", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n" }, { "name": "local_realm_ids", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource IDs.\nEnter multiple resource IDs in comma-separated format.\nThe local_realm_ids and local_realm_names parameters cannot be set together.\n" }, { "name": "local_realm_names", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource names.\nEnter multiple resource names in comma-separated format.\nThe local_realm_names and local_realm_ids parameters cannot be set together.\n" }, { "name": "remote_realm_ids", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource IDs.\nEnter multiple resource IDs in comma-separated format.\nThe remote_realm_ids and remote_realm_names parameters cannot be set together.\n" }, { "name": "remote_realm_names", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource IDs.\nEnter multiple resource IDs in comma-separated format.\nThe remote_realm_ids and remote_realm_names parameters cannot be set together.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new connection between two realms.\n" }, { "info": { "name": "Pure Storage Modify Realm Connections.", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/realm-connections", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n" }, { "name": "ids", "value": "", "type": "query", "description": "Performs the operation on the unique resource IDs specified.\nEnter multiple resource IDs in comma-separated format.\n" }, { "name": "local_realm_ids", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource IDs.\nEnter multiple resource IDs in comma-separated format.\nThe local_realm_ids and local_realm_names parameters cannot be set together.\n" }, { "name": "local_realm_names", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource names.\nEnter multiple resource names in comma-separated format.\nThe local_realm_names and local_realm_ids parameters cannot be set together.\n" }, { "name": "remote_realm_ids", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource IDs.\nEnter multiple resource IDs in comma-separated format.\nThe remote_realm_ids and remote_realm_names parameters cannot be set together.\n" }, { "name": "remote_realm_names", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource IDs.\nEnter multiple resource IDs in comma-separated format.\nThe remote_realm_ids and remote_realm_names parameters cannot be set together.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies the connection type between realms.\n" }, { "info": { "name": "Pure Storage Delete Realm Connections.", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/realm-connections", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n" }, { "name": "ids", "value": "", "type": "query", "description": "Performs the operation on the unique resource IDs specified.\nEnter multiple resource IDs in comma-separated format.\n" }, { "name": "local_realm_ids", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource IDs.\nEnter multiple resource IDs in comma-separated format.\nThe local_realm_ids and local_realm_names parameters cannot be set together.\n" }, { "name": "local_realm_names", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource names.\nEnter multiple resource names in comma-separated format.\nThe local_realm_names and local_realm_ids parameters cannot be set together.\n" }, { "name": "remote_realm_ids", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource IDs.\nEnter multiple resource IDs in comma-separated format.\nThe remote_realm_ids and remote_realm_names parameters cannot be set together.\n" }, { "name": "remote_realm_names", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource IDs.\nEnter multiple resource IDs in comma-separated format.\nThe remote_realm_ids and remote_realm_names parameters cannot be set together.\n" } ] }, "docs": "Deletes connections between realms.\n" }, { "info": { "name": "Pure Storage Get Realm Connection Key Information", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/realm-connections/connection-keys", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n" }, { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "realm_ids", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource IDs.\nEnter multiple resource IDs in comma-separated format.\nThe realm_ids and realm_names parameters cannot be set together.\n" }, { "name": "realm_names", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource names.\nEnter multiple resource names in comma-separated format.\nThe realm_names and realm_ids parameters cannot be set together.\n" }, { "name": "sort", "value": "", "type": "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" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays information about existing realm connection keys.\nSecret keys are not displayed, as they are only available at the time of key creation.\n\n" }, { "info": { "name": "Pure Storage Create Realm Connection Key", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/realm-connections/connection-keys", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n" }, { "name": "realm_ids", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource IDs.\nEnter multiple resource IDs in comma-separated format.\nThe realm_ids and realm_names parameters cannot be set together.\n" }, { "name": "realm_names", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource names.\nEnter multiple resource names in comma-separated format.\nThe realm_names and realm_ids parameters cannot be set together.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new one-time connection key to allow establishing a connection to the specified realm.\nThe key is valid until a successful connection is established or its expiration time is reached.\nNote that this is the only time the connection key is displayed; it cannot be retrieved subsequently.\n\n" }, { "info": { "name": "Pure Storage Delete Realm Connection Keys", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/realm-connections/connection-keys", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n" }, { "name": "realm_ids", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource IDs.\nEnter multiple resource IDs in comma-separated format.\nThe realm_ids and realm_names parameters cannot be set together.\n" }, { "name": "realm_names", "value": "", "type": "query", "description": "Performs the operation on the specified unique resource names.\nEnter multiple resource names in comma-separated format.\nThe realm_names and realm_ids parameters cannot be set together.\n" } ] }, "docs": "Deletes all connection keys for a given realm.\nNote that every realm connection key is a one-time key\nand is deleted automatically upon a successful connection or once it expires.\n\n" }, { "info": { "name": "Pure Storage GET Realm-connections", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/realm-connections", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `ids`, then an error is returned.\nThis cannot be provided together with the `name` or `names` query parameters.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "local_realm_ids", "value": "", "type": "query", "description": "A comma-separated list of local realm IDs. If, after filtering,\nthere is not at least one resource that matches each of the elements,\nthen an error is returned. This cannot be provided together with the\n`local_realm_names` query parameter.\n" }, { "name": "local_realm_names", "value": "", "type": "query", "description": "A comma-separated list of local realm names. If there is not\nat least one resource that matches each of the elements, then an error\nis returned. This cannot be provided together with `local_realm_ids`\nquery parameter.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "remote_realm_ids", "value": "", "type": "query", "description": "A comma-separated list of remote realm IDs. If, after filtering,\nthere is not at least one resource that matches each of the elements,\nthen an error is returned. This cannot be provided together with the\n`remote_realm_names` query parameter.\n" }, { "name": "remote_realm_names", "value": "", "type": "query", "description": "A comma-separated list of remote realm names. If there is not\nat least one resource that matches each of the elements, then an error\nis returned. This cannot be provided together with `remote_realm_ids`\nquery parameter.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nNOTE: If you provide a sort you will not get a `continuation_token` in\nthe response.\n" } ] }, "docs": "List realm connections." }, { "info": { "name": "Pure Storage POST Realm-connections", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/realm-connections", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "local_realm_ids", "value": "", "type": "query", "description": "A comma-separated list of local realm IDs. If, after filtering,\nthere is not at least one resource that matches each of the elements,\nthen an error is returned. This cannot be provided together with the\n`local_realm_names` query parameter.\n" }, { "name": "local_realm_names", "value": "", "type": "query", "description": "A comma-separated list of local realm names. If there is not\nat least one resource that matches each of the elements, then an error\nis returned. This cannot be provided together with `local_realm_ids`\nquery parameter.\n" }, { "name": "remote_realm_ids", "value": "", "type": "query", "description": "A comma-separated list of remote realm IDs. If, after filtering,\nthere is not at least one resource that matches each of the elements,\nthen an error is returned. This cannot be provided together with the\n`remote_realm_names` query parameter.\n" }, { "name": "remote_realm_names", "value": "", "type": "query", "description": "A comma-separated list of remote realm names. If there is not\nat least one resource that matches each of the elements, then an error\nis returned. This cannot be provided together with `remote_realm_ids`\nquery parameter.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a realm connection." }, { "info": { "name": "Pure Storage DELETE Realm-connections", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/realm-connections", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "local_realm_ids", "value": "", "type": "query", "description": "A comma-separated list of local realm IDs. If, after filtering,\nthere is not at least one resource that matches each of the elements,\nthen an error is returned. This cannot be provided together with the\n`local_realm_names` query parameter.\n" }, { "name": "local_realm_names", "value": "", "type": "query", "description": "A comma-separated list of local realm names. If there is not\nat least one resource that matches each of the elements, then an error\nis returned. This cannot be provided together with `local_realm_ids`\nquery parameter.\n" }, { "name": "remote_realm_ids", "value": "", "type": "query", "description": "A comma-separated list of remote realm IDs. If, after filtering,\nthere is not at least one resource that matches each of the elements,\nthen an error is returned. This cannot be provided together with the\n`remote_realm_names` query parameter.\n" }, { "name": "remote_realm_names", "value": "", "type": "query", "description": "A comma-separated list of remote realm names. If there is not\nat least one resource that matches each of the elements, then an error\nis returned. This cannot be provided together with `remote_realm_ids`\nquery parameter.\n" } ] }, "docs": "Delete realm connection." }, { "info": { "name": "Pure Storage GET Realm-connections/connection-key", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/realm-connections/connection-key", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "realm_ids", "value": "", "type": "query", "description": "A comma-separated list of realm IDs. If, after filtering,\nthere is not at least one resource that matches each of the elements,\nthen an error is returned. This cannot be provided together with the\n`realm_names` query parameter.\n" }, { "name": "realm_names", "value": "", "type": "query", "description": "A comma-separated list of realm names. If there is not\nat least one resource that matches each of the elements, then an error\nis returned. This cannot be provided together with `realm_ids`\nquery parameter.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nNOTE: If you provide a sort you will not get a `continuation_token` in\nthe response.\n" } ] }, "docs": "List realm connection keys." }, { "info": { "name": "Pure Storage POST Realm-connections/connection-key", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/realm-connections/connection-key", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "realm_ids", "value": "", "type": "query", "description": "A comma-separated list of realm IDs. If, after filtering,\nthere is not at least one resource that matches each of the elements,\nthen an error is returned. This cannot be provided together with the\n`realm_names` query parameter.\n" }, { "name": "realm_names", "value": "", "type": "query", "description": "A comma-separated list of realm names. If there is not\nat least one resource that matches each of the elements, then an error\nis returned. This cannot be provided together with `realm_ids`\nquery parameter.\n" } ] }, "docs": "Create a realm connection key." }, { "info": { "name": "Pure Storage DELETE Realm-connections/connection-key", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/realm-connections/connection-key", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "realm_ids", "value": "", "type": "query", "description": "A comma-separated list of realm IDs. If, after filtering,\nthere is not at least one resource that matches each of the elements,\nthen an error is returned. This cannot be provided together with the\n`realm_names` query parameter.\n" }, { "name": "realm_names", "value": "", "type": "query", "description": "A comma-separated list of realm names. If there is not\nat least one resource that matches each of the elements, then an error\nis returned. This cannot be provided together with `realm_ids`\nquery parameter.\n" } ] }, "docs": "Delete a realm connection key." } ] } ], "bundled": true }