Clear queue entries by type

POST

/wp-json/wp2/media-converter/v1/queue/clear

curl --request POST \
  --url https://example.com/wp-json/wp2/media-converter/v1/queue/clear \
  --header 'Content-Type: application/json' \
  --header 'X-WP-Nonce: <X-WP-Nonce>' \
  --data '{ "type": "all", "scope": "site" }'

Clears finished queue entries by type: all, manual, queued, or scheduled. Returns how many were removed.

Authorizations

• cookie
• applicationPassword

Request Body

Media typeapplication/json

object

type

Type (queue clear, track kind, etc.).

string

Allowed values: all manual queued scheduled

scope

Queue scope: site or network.

string

default: site

Example

{
  "type": "all",
  "scope": "site"
}

Responses

200

Completed-queue cleanup finished.

Media typeapplication/json

object

cleared

True if completed-queue cleanup ran.

boolean

type

Clear type PHP accepted.

string

Allowed values: all manual queued scheduled

Example

{
  "type": "all"
}

400

Invalid_clear_type

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

401

Not authenticated. WordPress REST: rest_not_logged_in / rest_forbidden. Use cookie + X-WP-Nonce or Application Password.

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

403

Insufficient capability or invalid REST nonce. WordPress REST: rest_forbidden / rest_cookie_invalid_nonce.

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}