Skip to main content

Transfer Node to Project

Transfers an existing node from one project to another inside the same account. The destination project must belong to the same customer and the node must be in a transferable state (powered off or running, not locked).

POST/api/v1/resource-transfer/

Query parameters

  • project_idQuerystringoptional

    Identifier of the project to scope the request to. Optional; if omitted, the account's default project is used.

    • optional
    • if omitted, the request is applied to the default project
    example{{project_id}}
  • apikeyQuerystringoptional

    API key used for authenticating the request

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringoptional

    The region of the node being transferred.

    • required
    • must be a valid location identifier (e.g., region code)
    example{{location}}

Request body

application/json

object
current_project_idintegerrequired

ID of the project the node currently belongs to.

example12345
  • required
  • positive integer
target_project_idintegerrequired

ID of the destination project. Must belong to the same customer as the source project.

example12345
  • required
  • positive integer
  • must differ from `current_project_id`
resource_typestringrequirednode

Resource type identifier. Always node for this endpoint.

examplenode
  • required
  • must be the literal string `node`
resource_idintegerrequired

ID of the node being transferred.

example12345
  • required
  • positive integer
  • must reference a node owned by `current_project_id`

Responses

200Successful response
object
codeinteger

HTTP status code of the transfer operation.

example200
  • integer between 100 and 599
datastring

Identifier of the transferred resource. May be an empty string when the platform does not return an ID for transfer operations.

example
  • string (may be empty)
errorsobject
messagestring

Status message indicating the result of the transfer.

exampleResource is transferred successfully.
  • non-empty string
  • maximum length 200 characters