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}/

Request

  • Base URL
    https://plagiarismcheck.org
  • Auth
    API key in header X-API-TOKEN

Request body application/x-www-form-urlencoded

urlstring required

FTP or FTPS URL of the directory that contains enrollments.csv and users.csv. Must include credentials if the server requires authentication. Maximum length: 80 characters.

enabledboolean

Whether sync is enabled. When false the record is saved with status 2 (disabled) and the connection is not tested. Defaults to true.

Example request

{
  "url": "ftps://user:password@ftp.example.com/oneroster/",
  "enabled": true
}

Response

The request succeeded and returned the OneRoster sync configuration for the group.

successboolean

Example response

{
  "success": true,
  "data": {
    "id": 7,
    "status": 3,
    "url": "ftps://user:password@ftp.example.com/oneroster/",
    "last_synced_at": 1716800000
  }
}

Changes

No recorded changes to this operation across all 12 revisions of this API.