/scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset}/afm/flushqueue: POST

Flushes all pending queued operations for an existing AFM fileset in an IBM Storage Scale file system.

Availability

Available on all IBM Storage Scale editions.

Description

The POST filesystems/{filesystem}/filesets/{fileset}/afm/flushqueue request flushes all pending queued operations for an existing AFM fileset. This operation forces the immediate processing of queued AFM operations, ensuring that pending changes are synchronized with the remote target. To run this request, you must have the RBAC permission for the post action on the /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset}/afm/flushqueue resource.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset}/afm/flushqueue
where
{filesystem}
Specifies the name of the file system.
{fileset}
Specifies the name of the AFM fileset.

Request headers

Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of parameters
Parameter name Description and applicable keywords Required/optional
filesystem The name of the filesystem. Required.
fileset The name of the AFM fileset. Required.
X-StorageScaleDomain The domain to be authorized against for the request. The default value is X-StorageScaleDomain. Optional.

Request data

No request data.

Response data

  • 200: A successful response and flushpending operation is completed.
    {
  "done": true,
  "error": {
    "details": [
      {
        "@type": "string",
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    ],
    "httpcode": 0,
    "message": "string",
    "status": "CANCELLED"
  },
  "metadata": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "name": "string",
  "response": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}
  • 202: The request has been accepted for processing, but the processing has not been completed.
    {
  "done": true,
  "error": {
    "details": [
      {
        "@type": "string",
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    ],
    "httpcode": 0,
    "message": "string",
    "status": "CANCELLED"
  },
  "metadata": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "name": "string",
  "response": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}
  • default: An unexpected error response.
    {
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example flushes the queue for the fset-sw fileset in the fs1 file system:

Request data: 
curl -X 'POST' \
  'https://localhost:46443/scalemgmt/v3/filesystems/fs1/filesets/fset-sw/afm/flushqueue' \
  -H 'accept: application/json' \
  -H 'authorization: Basic cm9vdDpXZWxjb21lMmlibTEyM0A=' \
  -d ''
Response data: 
{
	"name": "MTphZDk1Yzk2Zi0xNDgwLTQ3ZjctYmUyMi1jZTIyYzMzYjE3NWI=",
	"metadata": {
		"@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
		"job_id": "MTphZDk1Yzk2Zi0xNDgwLTQ3ZjctYmUyMi1jZTIyYzMzYjE3NWI=",
		"operation_details": {
			"@type": "type.googleapis.com/afmctl.v3.FlushAFMFilesetRequest",
			"filesystem": "fs1",
			"fileset": "fset-sw"
		},
		"status": "DONE",
		"check_point": "",
		"request_time": "2026-04-22T07:55:35.666822480Z",
		"completion_time": "2026-04-22T07:55:35.775433895Z",
		"last_update_time": "2026-04-22T07:55:35.775433895Z",
		"output": "",
		"domain_ids": [
			0
		]
	},
	"done": true,
	"response": {
		"@type": "type.googleapis.com/afmctl.v3.FlushAFMFilesetResponse",
		"response": [
			""
		]
	}
}