OneRoster
Save OneRoster sync configuration
Create or update the OneRoster FTP sync configuration for a group. The authenticated user must be an owner of the group.
The supplied url must be a valid ftp:// or ftps:// URL. When enabled is true (the default), the server tests the connection immediately and returns 400 if it cannot connect. When enabled is false the record is saved with status 2 (disabled) without attempting a connection test.
Status values returned in the response:
- 1 — error (last sync failed or connection test failed)
- 2 — disabled
- 3 — ok / enabled
post/api/v1/groups/oneroster-sync-data/{id}/
Response
The request succeeded and returned the OneRoster sync configuration for the group.
Example response
{
"success": true,
"data": {
"id": 7,
"status": 3,
"url": "ftps://user:password@ftp.example.com/oneroster/",
"last_synced_at": 1716800000
}
}