Account

Service Transfer View

get
https://api.linode.com/v4/account/service-transfers/{token}

Returns the details of the Service Transfer for the provided token.

While a transfer is pending, any unrestricted user of any account can access this command. After a transfer has been accepted, it can only be viewed by unrestricted users of the accounts that created and accepted the transfer. If canceled or expired, only unrestricted users of the account that created the transfer can view it.

Path Parameters

token
Required
string

The UUID of the Service Transfer.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
  https://api.linode.com/v4/account/service-transfers/123E4567-E89B-12D3-A456-426614174000

Response Samples

{
  "token": "123E4567-E89B-12D3-A456-426614174000",
  "status": "pending",
  "created": "2021-02-11T16:37:03",
  "updated": "2021-02-11T16:37:03",
  "is_sender": true,
  "expiry": "2021-02-12T16:37:03",
  "entities": {
    "linodes": [
      111,
      222
    ]
  }
}

Responses

200: Returns a Service Transfer object containing the details of the transfer for the specified token.

token
string <uuid>

The token used to identify and accept or cancel this transfer.

status
Filterable
string
Enum: "accepted""canceled""completed""failed""pending""stale"

The status of the transfer request.

accepted: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete.

canceled: The transfer has been canceled by the sender.

completed: The transfer has completed successfully.

failed: The transfer has failed after initiation.

pending: The transfer is ready to be accepted.

stale: The transfer has exceeded its expiration date. It can no longer be accepted or canceled.

created
string <date-time>

When this transfer was created.

updated
string <date-time>

When this transfer was last updated.

is_sender
Filterable
boolean

If the requesting account created this transfer.

expiry
string <date-time>

When this transfer expires. Transfers will automatically expire 24 hours after creation.

entities
object

A collection of the services to include in this transfer request, separated by type.

linodes
array

An array containing the IDs of each of the Linodes included in this transfer.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.

Service Transfer Cancel

delete
https://api.linode.com/v4/account/service-transfers/{token}

Cancels the Service Transfer for the provided token. Once canceled, a transfer cannot be accepted or otherwise acted on in any way. If canceled in error, the transfer must be created again.

When canceled, an email notification for the cancellation is sent to the account that created this transfer. Transfers can not be canceled if they are expired or have been accepted.

This command can only be accessed by the unrestricted users of the account that created this transfer.

Path Parameters

token
Required
string

The UUID of the Service Transfer.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
  -X DELETE \
  https://api.linode.com/v4/account/service-transfers/123E4567-E89B-12D3-A456-426614174000

Response Samples

{}

Responses

200: Service Transfer canceled.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.