Cancel encode for one format

POST

/wp-json/wp2/media-converter/v1/queue/{key}/formats/{format}/cancel

curl --request POST \
  --url https://example.com/wp-json/wp2/media-converter/v1/queue/example/formats/example/cancel \
  --header 'X-WP-Nonce: <X-WP-Nonce>'

Cancels encoding of one format inside a job; other formats on the same key are left alone. No request body.

Authorizations

• cookie
• applicationPassword

Parameters

Path Parameters

key

required

string

Password-reset key from email, or a queue key.

format

required

string

Encode format name.

Responses

200

Format canceled.

Media typeapplication/json

object

canceled

True if encoding of the given format was canceled.

boolean

Example^generated

{
  "canceled": true
}

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": {}
}

404

Queue_entry_not_found

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": {}
}