Delete a build

DELETE

/wp-json/wp2lms/static-builder/v1/builds/{id}

curl --request DELETE \
  --url 'https://example.com/wp-json/wp2lms/static-builder/v1/builds/128?blog_id=1' \
  --header 'X-WP-Nonce: <X-WP-Nonce>'

Moves the build post to the WordPress trash (wp_trash_post). This is not wp_delete_post(..., true) and does not stop generation: status building — 409 wp2lms_static_builder_busy. Pending may be trashed. Success: { id, deleted: true }. Failed trash — 500 delete_failed. Requires manage_network or edit_pages. Cookie + X-WP-Nonce or Application Password.

Authorizations

• cookie
• applicationPassword

Parameters

Path Parameters

id

required

integer

>= 1

CPT wp2lms_static_build post ID (same number as StaticBuild.id). ≤ 0 — 400 invalid_id.

Example

128

Query Parameters

blog_id

integer

>= 1

Multisite site ID to read/write builds on. Optional: PHP uses get_current_blog_id(). ≤ 0 — 400 invalid_blog. Missing or foreign-network site — 404 blog_not_found. Usually omitted on a single site.

Example

1

Responses

200

Build post is in the trash. Body is id and deleted=true.

Media typeapplication/json

object

id

Build ID that was moved to the trash.

integer

deleted

Always true on HTTP 200 (wp_trash_post succeeded).

boolean

Example

{
  "id": 128,
  "deleted": true
}

400

Wp2lms_static_builder_invalid_id — id ≤ 0; invalid_blog — blog_id ≤ 0.

Media typeapplication/json

object

code

Machine-readable WP_Error code (for example wp2lms_static_builder_busy, rest_forbidden, invalid_nonce).

string

message

Human-readable error message from PHP / WordPress REST.

string

data

Usually { status: <HTTP code> }. If status is missing, core REST often returns 500.

object

key

additional properties

any

Example

{
  "code": "wp2lms_static_builder_busy",
  "message": "Build is currently building and cannot be updated.",
  "data": {
    "status": 409
  }
}

401

Not authenticated. DualRest: rest_forbidden (status 401) when there is no cookie session. Cookie + X-WP-Nonce or Application Password.

Media typeapplication/json

object

code

Machine-readable WP_Error code (for example wp2lms_static_builder_busy, rest_forbidden, invalid_nonce).

string

message

Human-readable error message from PHP / WordPress REST.

string

data

Usually { status: <HTTP code> }. If status is missing, core REST often returns 500.

object

key

additional properties

any

Example

{
  "code": "wp2lms_static_builder_busy",
  "message": "Build is currently building and cannot be updated.",
  "data": {
    "status": 409
  }
}

403

Missing manage_network (multisite) or edit_pages (single site); invalid REST nonce rest_cookie_invalid_nonce.

Media typeapplication/json

object

code

Machine-readable WP_Error code (for example wp2lms_static_builder_busy, rest_forbidden, invalid_nonce).

string

message

Human-readable error message from PHP / WordPress REST.

string

data

Usually { status: <HTTP code> }. If status is missing, core REST often returns 500.

object

key

additional properties

any

Example

{
  "code": "wp2lms_static_builder_busy",
  "message": "Build is currently building and cannot be updated.",
  "data": {
    "status": 409
  }
}

404

Wp2lms_static_builder_not_found — no build of this CPT; blog_not_found — site missing or on another network.

Media typeapplication/json

object

code

Machine-readable WP_Error code (for example wp2lms_static_builder_busy, rest_forbidden, invalid_nonce).

string

message

Human-readable error message from PHP / WordPress REST.

string

data

Usually { status: <HTTP code> }. If status is missing, core REST often returns 500.

object

key

additional properties

any

Example

{
  "code": "wp2lms_static_builder_busy",
  "message": "Build is currently building and cannot be updated.",
  "data": {
    "status": 409
  }
}

409

Wp2lms_static_builder_busy — status is building, trash is refused.

Media typeapplication/json

object

code

Machine-readable WP_Error code (for example wp2lms_static_builder_busy, rest_forbidden, invalid_nonce).

string

message

Human-readable error message from PHP / WordPress REST.

string

data

Usually { status: <HTTP code> }. If status is missing, core REST often returns 500.

object

key

additional properties

any

Example

{
  "code": "wp2lms_static_builder_busy",
  "message": "Build is currently building and cannot be updated.",
  "data": {
    "status": 409
  }
}

500

Wp2lms_static_builder_delete_failed — wp_trash_post returned false.

Media typeapplication/json

object

code

Machine-readable WP_Error code (for example wp2lms_static_builder_busy, rest_forbidden, invalid_nonce).

string

message

Human-readable error message from PHP / WordPress REST.

string

data

Usually { status: <HTTP code> }. If status is missing, core REST often returns 500.

object

key

additional properties

any

Example

{
  "code": "wp2lms_static_builder_busy",
  "message": "Build is currently building and cannot be updated.",
  "data": {
    "status": 409
  }
}