API v2: Session Data Replication πŸ†•ΒΆ

Additionally to automated session data replication, Fudo Enterprise enables on-demand replication to Fudo Enterprise instances to which the given data is not replicated automatically.


Data StructuresΒΆ

SessionReplicaModelΒΆ

Attribute

Type

Required

Description

id

string

Read-only. Unique identifier. Protected.

session_on

string

yes

Serial number of the node on which the session has been replicated. The value archive indicates that the session is stored as a backup. Immutable. Uniqueness is required in the combination of attribute session_on with attribute session_id.

session_id

string

yes

ID of the session. Immutable. Uniqueness is required in the combination of attribute session_id with attribute session_on.

fully_replicated

boolean; default value false

yes

Read-only.

backup_id

string

Backup ID, available when the session_on attribute is set to archive. Read-only.

dump_directory

string

Read-only. Protected.

external_directory

string

Directory where session backup has been saved. Read-only. Expensive to use.

node_name

string

Name of the node on which the session has been replicated. Read-only. Expensive to use.

backup_name

string

Read-only. Expensive to use.

created_at

datetime

Datetime of the record creation. Read-only.

modified_at

datetime

Datetime of the record modification. Read-only.

removed

boolean

Read-only.

Retrieve Available Attributes of the SessionReplicaModelΒΆ

Request

Method

GET

Path

/api/v2/objspec/session_replica

GET /api/v2/objspec/session_replica

Example Request

curl -s -k -X GET \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  'https://10.0.214.98/api/v2/objspec/session_replica'

Get Session Replication DetailsΒΆ

Request

Method

GET

Path

/api/v2/session/<session_id>/replica

GET /api/v2/session/<session_id>/replica

Example Request

curl -s -k -X GET \
     -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
     'https://10.31.92.108/api/v2/session/4665729213955833864/replica'

Response

{
    "result": "success",
    "session_replica": [
        {
            "session_on": "83329531",
            "session_id": "4665729213955833864",
            "fully_replicated": true,
            "created_at": "2025-05-14 06:32:04.355502-07",
            "modified_at": "2025-05-14 06:32:04.355502-07"
        }
    ]
}

Process Session ReplicationΒΆ

Request

Method

POST

Path

/api/v2/session/<session_id>/replica

Headers

Content-Type: Application/json

Body

SessionReplicaModel

POST /api/v2/session/<session_id>/replica

Example Request

curl -s -k -X POST \
  -H 'Authorization: proxycrypto' \
  -H 'Content-Type: application/json' \
  -d '{"session_on": "83329531"}' \
  'https://10.31.92.108/api/v2/session/4665729213955833858/replica'

Response

{
    "result": "success"
}