@akamai/openapi-ts
    Preparing search index...

    Type Alias GetEntityTransferResponses

    type GetEntityTransferResponses = {
        "200": {
            created: string;
            entities: { linodes: number[] };
            expiry: string;
            is_sender: boolean;
            status:
                | "accepted"
                | "canceled"
                | "completed"
                | "failed"
                | "pending"
                | "stale";
            token: string;
            updated: string;
        };
    }
    Index

    Properties

    Properties

    "200": {
        created: string;
        entities: { linodes: number[] };
        expiry: string;
        is_sender: boolean;
        status:
            | "accepted"
            | "canceled"
            | "completed"
            | "failed"
            | "pending"
            | "stale";
        token: string;
        updated: string;
    }

    An object representing an Entity Transfer.

    Type Declaration

    • created: string

      When this transfer was created.

    • entities: { linodes: number[] }

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

      • linodes: number[]

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

    • expiry: string

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

    • is_sender: boolean

      Filterable If the requesting account created this transfer.

    • status: "accepted" | "canceled" | "completed" | "failed" | "pending" | "stale"

      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.

    • token: string

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

    • updated: string

      When this transfer was last updated.