service_transfers
Creates, updates, deletes, gets or lists a service_transfers
resource.
Overview
Name | service_transfers |
Type | Resource |
Id | linode.account.service_transfers |
Fields
The following fields are returned by SELECT
queries:
- get_service_transfer
- get_service_transfers
Returns a Service Transfer object containing the details of the transfer for the specified token.
Name | Datatype | Description |
---|---|---|
created | string (date-time) | When this transfer was created. (example: 2021-02-11T16:37:03) |
entities | object | A collection of the services to include in this transfer request, separated by type. |
expiry | string (date-time) | When this transfer expires. Transfers will automatically expire 24 hours after creation. (example: 2021-02-12T16:37:03) |
is_sender | boolean | Filterable If the requesting account created this transfer. |
status | string | Filterable 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. (example: pending) |
token | string (uuid) | The token used to identify and accept or cancel this transfer. (example: 123E4567-E89B-12D3-A456-426614174000) |
updated | string (date-time) | When this transfer was last updated. (example: 2021-02-11T16:37:03) |
Returns a paginated list of Service Transfer objects containing the details of all transfers that have been created and accepted by this account.
Name | Datatype | Description |
---|---|---|
data | array | |
page | integer | Read-only The current page. |
pages | integer | Read-only The total number of pages. |
results | integer | Read-only The total number of results. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_service_transfer | select | 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 operation. 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. Learn more... Learn more... | ||
get_service_transfers | select | page , page_size | Returns a collection of all created and accepted Service Transfers for this account, regardless of the user that created or accepted the transfer. This operation can only be accessed by the unrestricted users of an account. Learn more... Learn more... | |
post_service_transfer | insert | data__entities | Creates a transfer request for the specified services. A request can contain any of the specified service types and any number of each service type. At this time, only Linodes can be transferred. When created successfully, a confirmation email is sent to the account that created this transfer containing a transfer token and instructions on completing the transfer. When a transfer is accepted, the requested services are moved to the receiving account. Linode services will not experience interruptions due to the transfer process. Backups for Linodes are transferred as well. DNS records that are associated with requested services will not be transferred or updated. Please ensure that associated DNS records have been updated or communicated to the recipient prior to the transfer. A transfer can take up to three hours to complete once accepted. When a transfer is completed, billing for transferred services ends for the sending account and begins for the receiving account. This operation can only be accessed by the unrestricted users of an account. There are several conditions that you need to meet to successfully create a transfer request: 1. The account creating the transfer can't have a past due balance or active Terms of Service violation. 1. The service needs to be owned by the account that is creating the transfer. 1. The service can't be assigned to another Service Transfer that is pending or that's been accepted and is incomplete. 1. Linodes can't: - be assigned to a NodeBalancer, Firewall, VLAN, VPC, or Managed Service. - have any attached Block Storage Volumes. - have any shared IP addresses. - have any assigned /32, /56, /64, or /116 IPv6 ranges. Learn more... Learn more... | |
delete_service_transfer | delete | 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 operation can only be accessed by the unrestricted users of the account that created this transfer. Learn more... Learn more... | ||
post_accept_service_transfer | exec | Accept a Service Transfer for the provided token to receive the services included in the transfer to your account. At this time, only Linodes can be transferred. When accepted, email confirmations are sent to the accounts that created and accepted the transfer. A transfer can take up to three hours to complete once accepted. Once a transfer is completed, billing for transferred services ends for the sending account and begins for the receiving account. This operation can only be accessed by the unrestricted users of the account that receives the transfer. Users of the same account that created a transfer cannot accept the transfer. There are several conditions that must be met in order to accept a transfer request: 1. Only transfers with a pending status can be accepted.1. The account accepting the transfer must have a registered payment method and must not have a past due balance or other account limitations for the services to be transferred. 1. Both the account that created the transfer and the account that is accepting the transfer must not have any active Terms of Service violations. 1. The service must still be owned by the account that created the transfer. 1. Linodes must not: - be assigned to a NodeBalancer, Firewall, VLAN, or Managed Service. - have any attached Block Storage Volumes. - have any shared IP addresses. - have any assigned /56, /64, or /116 IPv6 ranges. Any and all of the above conditions must be cured and maintained by the relevant account prior to the transfer's expiration to allow the transfer to be accepted by the receiving account. Learn more... Learn more... |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
page | integer | The page of a collection to return. |
page_size | integer | The number of items to return per page. |
SELECT
examples
- get_service_transfer
- get_service_transfers
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 operation. 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.
Learn more...
Learn more...
SELECT
created,
entities,
expiry,
is_sender,
status,
token,
updated
FROM linode.account.service_transfers;
Returns a collection of all created and accepted Service Transfers for this account, regardless of the user that created or accepted the transfer.
This operation can only be accessed by the unrestricted users of an account.
Learn more...
Learn more...
SELECT
data,
page,
pages,
results
FROM linode.account.service_transfers
WHERE page = '{{ page }}'
AND page_size = '{{ page_size }}';
INSERT
examples
- post_service_transfer
- Manifest
Creates a transfer request for the specified services. A request can contain any of the specified service types and any number of each service type. At this time, only Linodes can be transferred.
When created successfully, a confirmation email is sent to the account that created this transfer containing a transfer token and instructions on completing the transfer.
When a transfer is accepted, the requested services are moved to the receiving account. Linode services will not experience interruptions due to the transfer process. Backups for Linodes are transferred as well.
DNS records that are associated with requested services will not be transferred or updated. Please ensure that associated DNS records have been updated or communicated to the recipient prior to the transfer.
A transfer can take up to three hours to complete once accepted. When a transfer is completed, billing for transferred services ends for the sending account and begins for the receiving account.
This operation can only be accessed by the unrestricted users of an account.
There are several conditions that you need to meet to successfully create a transfer request:
1. The account creating the transfer can't have a past due balance or active Terms of Service violation.
1. The service needs to be owned by the account that is creating the transfer.
1. The service can't be assigned to another Service Transfer that is pending or that's been accepted and is incomplete.
1. Linodes can't:
- be assigned to a NodeBalancer, Firewall, VLAN, VPC, or Managed Service.
- have any attached Block Storage Volumes.
- have any shared IP addresses.
- have any assigned /32, /56, /64, or /116 IPv6 ranges.
Learn more...
Learn more...
INSERT INTO linode.account.service_transfers (
data__entities
)
SELECT
'{{ entities }}' --required
RETURNING
created,
entities,
expiry,
is_sender,
status,
token,
updated
;
# Description fields are for documentation purposes
- name: service_transfers
props:
- name: entities
value: object
description: >
A collection of the services to include in this transfer request, separated by type.
DELETE
examples
- delete_service_transfer
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 operation can only be accessed by the unrestricted users of the account that created this transfer.
Learn more...
Learn more...
DELETE FROM linode.account.service_transfers;
Lifecycle Methods
- post_accept_service_transfer
Accept a Service Transfer for the provided token to receive the services included in the transfer to your account. At this time, only Linodes can be transferred.
When accepted, email confirmations are sent to the accounts that created and accepted the transfer. A transfer can take up to three hours to complete once accepted. Once a transfer is completed, billing for transferred services ends for the sending account and begins for the receiving account.
This operation can only be accessed by the unrestricted users of the account that receives the transfer. Users of the same account that created a transfer cannot accept the transfer.
There are several conditions that must be met in order to accept a transfer request:
1. Only transfers with a pending
status can be accepted.
1. The account accepting the transfer must have a registered payment method and must not have a past due balance or other account limitations for the services to be transferred.
1. Both the account that created the transfer and the account that is accepting the transfer must not have any active Terms of Service violations.
1. The service must still be owned by the account that created the transfer.
1. Linodes must not:
- be assigned to a NodeBalancer, Firewall, VLAN, or Managed Service.
- have any attached Block Storage Volumes.
- have any shared IP addresses.
- have any assigned /56, /64, or /116 IPv6 ranges.
Any and all of the above conditions must be cured and maintained by the relevant account prior to the transfer's expiration to allow the transfer to be accepted by the receiving account.
Learn more...
Learn more...
EXEC linode.account.service_transfers.post_accept_service_transfer
;