image_account_transfers

Creates, updates, deletes, gets or lists an image_account_transfers resource.

Overview

Name	image_account_transfers
Type	Resource
Id	digitalocean.compute.image_account_transfers

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
images_post_account_transfer_create	exec	image_id, recipient_email, recipient_uuid		To initiate an account transfer for an image, send a POST request to /v2/images/$IMAGE_ID/account_transfer. Only snapshot images may be transferred by this endpoint to another account. An image account transfer always has exactly one recipient, specified in the request body. The recipient can be one of the following: * A DigitalOcean account, denoted by recipient_email in the request body. The recipient will receive an email with instructions to accept the transfer. Once the recipient accepts the transfer, the image will be moved to their account. * A DigitalOcean team, denoted by recipient_uuid in the request body. If the user has sufficient permissions in the recipient team, the transfer will be automatically accepted and the image will be moved to the recipient team's account. Otherwise, the transfer will be pending until a user with sufficient permissions in the recipient team accepts the transfer.
images_post_account_transfer_accept	exec	image_id, transfer_id, recipient_uuid		To accept an account transfer for an image, send a POST request to /v2/images/$IMAGE_ID/account_transfer/accept.
images_post_account_transfer_cancel	exec	image_id, transfer_id		To cancel an account transfer for an image, send a POST request to /v2/images/$IMAGE_ID/account_transfer/cancel. Only the sender of an image account transfer can cancel the transfer. If the transfer is canceled, the image will remain in the sender's account and will not be transferred to the recipient.
images_post_account_transfer_decline	exec	image_id, transfer_id		To decline an account transfer for an image, send a POST request to /v2/images/$IMAGE_ID/account_transfer/decline. Only the recipient of an image account transfer can decline the transfer. If the transfer is declined, the image will remain in the sender's account and will not be transferred to the recipient.

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
image_id	integer	A unique number that can be used to identify and reference a specific image. (example: 62137902)

Lifecycle Methods

images_post_account_transfer_create

To initiate an account transfer for an image, send a POST request to
/v2/images/$IMAGE_ID/account_transfer.

Only snapshot images may be transferred by this endpoint to another account.

An image account transfer always has exactly one recipient, specified in the request body.
The recipient can be one of the following:

* A DigitalOcean account, denoted by recipient_email in the request body.
The recipient will receive an email with instructions to accept the transfer.
Once the recipient accepts the transfer, the image will be moved to their
account.

* A DigitalOcean team, denoted by recipient_uuid in the request body. If the
user has sufficient permissions in the recipient team, the transfer will be
automatically accepted and the image will be moved to the recipient team's
account. Otherwise, the transfer will be pending until a user with sufficient
permissions in the recipient team accepts the transfer.

EXEC digitalocean.compute.image_account_transfers.images_post_account_transfer_create 
@image_id='{{ image_id }}' --required 
@@json=
'{
"recipient_email": "{{ recipient_email }}", 
"recipient_uuid": "{{ recipient_uuid }}"
}'
;

images_post_account_transfer_accept

To accept an account transfer for an image, send a POST request to
/v2/images/$IMAGE_ID/account_transfer/accept.

EXEC digitalocean.compute.image_account_transfers.images_post_account_transfer_accept 
@image_id='{{ image_id }}' --required 
@@json=
'{
"transfer_id": {{ transfer_id }}, 
"recipient_uuid": "{{ recipient_uuid }}"
}'
;

images_post_account_transfer_cancel

To cancel an account transfer for an image, send a POST request to
/v2/images/$IMAGE_ID/account_transfer/cancel.

Only the sender of an image account transfer can cancel the transfer.
If the transfer is canceled, the image will remain in the sender's account
and will not be transferred to the recipient.

EXEC digitalocean.compute.image_account_transfers.images_post_account_transfer_cancel 
@image_id='{{ image_id }}' --required 
@@json=
'{
"transfer_id": {{ transfer_id }}
}'
;

images_post_account_transfer_decline

To decline an account transfer for an image, send a POST request to
/v2/images/$IMAGE_ID/account_transfer/decline.

Only the recipient of an image account transfer can decline the transfer.
If the transfer is declined, the image will remain in the sender's account
and will not be transferred to the recipient.

EXEC digitalocean.compute.image_account_transfers.images_post_account_transfer_decline 
@image_id='{{ image_id }}' --required 
@@json=
'{
"transfer_id": {{ transfer_id }}
}'
;