Cancel a scheduled site transfer

DELETE

/sites/{site_id}/site_transfers/{transfer_id}

curl --request DELETE \
  --url https://api.wpengineapi.com/v1/sites/a1b2c3d4-e5f6-41b2-b3d4-e5f6a1b2c3d4/site_transfers/7c3e1a2b-4f5d-4e6c-b7a8-d9e0f1a2b3c4 \
  --header 'Authorization: Basic <credentials>'

Description

Cancels a site transfer. Only transfers that have not yet started can be cancelled; a transfer that has already started will return 409 Conflict.

Authorizations

• basicAuth

Parameters

Path Parameters

site_id

required

string format: uuid

ID of the site

Example

a1b2c3d4-e5f6-41b2-b3d4-e5f6a1b2c3d4

transfer_id

required

string format: uuid

ID of the site transfer to cancel

Example

7c3e1a2b-4f5d-4e6c-b7a8-d9e0f1a2b3c4

Responses

204

Transfer cancelled

401

Authentication Error

Media typeapplication/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

Example

{
  "message": "Bad Credentials"
}

403

Not authorized

Media typeapplication/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

Example

{
  "message": "You don't have permission to perform that action"
}

404

Not found

Media typeapplication/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

Example

{
  "message": "Not Found"
}

409

Conflict — transfer has already started and cannot be cancelled

Media typeapplication/json

object

message

required

A message regarding the conflict that occurred

string

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

errors

An array of error objects describing specific errors that arose when servicing the request

Array<object>

object

resource

required

The name of the resource that was being processed when the error occurred

string

field

required

(Optional) The specific field associated with the error

string

type

required

(Optional) A type associated with the error. invalid_value, access_error, value_unavailable

string

code

required

(Optional) A machine code relating to the error that occurred with the field and resource

string

message

required

(Optional) A human-readable message relating to the error that occurred with the field and resource

string

Example

{
  "message": "Transfer has already started and cannot be cancelled",
  "errors": [
    {
      "resource": "Site",
      "field": "name",
      "type": "invalid_value",
      "code": "too_long",
      "message": "Name is too long (maximum is 40 characters)"
    }
  ]
}

429

Too many requests

500

Internal Server Error

Media typeapplication/json

object

message

required

A message regarding the error that occurred on the server

string

Example

{
  "message": "An unexpected error occurred, please try again in a few minutes"
}

503

Service unavailable