/api/ee/remote-sync

PUT /api/ee/remote-sync/settings

Changed on

Update Remote Sync related settings. You must be a superuser to do this.

put/api/ee/remote-sync/settings

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Request body

collectionsobject nullable
remote-sync-auto-importboolean nullable
remote-sync-branchstring nullable
remote-sync-tokenstring nullable
remote-sync-transformsboolean nullable
remote-sync-type'read-only' | 'read-write' nullable
remote-sync-urlstring nullable

Response

Successful response

successboolean required
task_idinteger

Changes

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      api operation id put-api-ee-remote-sync-settings was added

    • info

      added the new optional request property

    • info

      added the new optional request property