---
title: "Save OneRoster sync configuration"
method: POST
path: "/api/v1/groups/oneroster-sync-data/{id}/"
tags: ["OneRoster"]
---

# Save OneRoster sync configuration

`POST /api/v1/groups/oneroster-sync-data/{id}/`

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

## Response `200`

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

- object
  - `success` boolean
  - `data` OneRosterSyncData — OneRoster FTP sync configuration record for a group.
    - `id` integer, nullable — Record ID, or `null` when no configuration has been saved yet.
    - `status` 1 | 2 | 3, nullable — Sync status: - `1` — error (last sync or connection test failed; see `message` for details) - `2` — disabled - `3` — ok / enabled
    - `url` string, nullable — Configured FTP/FTPS URL, or `null` when no configuration has been saved yet.
    - `last_synced_at` integer, nullable — Unix timestamp (seconds) of the last successful synchronisation, or `null` if the group has never been synced.
    - `message` string, nullable — Error message from the last failed sync or connection test, or `null` when there is no error.

## Other responses

- `400` — The request is invalid. Check required fields, field formats, and resource ownership.
- `403` — Authentication or authorization failed because the token is missing, invalid, blocked, or not allowed to access the resource.
- `404` — The requested resource was not found.

---

[API](https://skmtc.net/plagiarismcheck/apis/plagiarismcheck-org-api.md) · [All operations](https://skmtc.net/plagiarismcheck/apis/plagiarismcheck-org-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plagiarismcheck/plagiarismcheck-org-api/versions/034b4999350e/schema)