APapicurio
Mode

PUT /mode

Changed on

Updates the global mode for Schema Registry. This operation is allowed only if Schema Registry was started with mode.mutability=true.

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

forceboolean

If true, allows the mode change even if schemas are already registered. Useful in disaster recovery scenarios.

Request body

modestring required

The new global mode to set.

Example request

{
  "mode": "IMPORT"
}

Response

Returns the updated global mode.

mode'READWRITE' | 'READONLY' | 'IMPORT' required

Current operating mode of the registry.

Example response

{
  "mode": "READWRITE"
}

Changes

  • v89e42a44352e7Revision changes
    • breaking

      removed the enum value IMPORT of the request property (media type: application/json)

    • breaking

      removed the enum value IMPORT of the request property (media type: application/octet-stream)

    • breaking

      removed the enum value IMPORT of the request property (media type: application/vnd.schemaregistry.v1+json)

    • breaking

      removed the enum value IMPORT of the request property (media type: application/vnd.schemaregistry+json)

    • breaking

      removed the enum value READONLY of the request property (media type: application/json)

    • breaking

      removed the enum value READONLY of the request property (media type: application/octet-stream)

    • breaking

      removed the enum value READONLY of the request property (media type: application/vnd.schemaregistry.v1+json)

    • breaking

      removed the enum value READONLY of the request property (media type: application/vnd.schemaregistry+json)

    • breaking

      removed the enum value READWRITE of the request property (media type: application/json)

    • breaking

      removed the enum value READWRITE of the request property (media type: application/octet-stream)

    • breaking

      removed the enum value READWRITE of the request property (media type: application/vnd.schemaregistry.v1+json)

    • breaking

      removed the enum value READWRITE of the request property (media type: application/vnd.schemaregistry+json)

  • v8d015d4d95cbeRevision changes
    • breaking

      request property was restricted to a list of enum values (media type: application/json)

    • breaking

      request property was restricted to a list of enum values (media type: application/octet-stream)

    • breaking

      request property was restricted to a list of enum values (media type: application/vnd.schemaregistry.v1+json)

    • breaking

      request property was restricted to a list of enum values (media type: application/vnd.schemaregistry+json)

    • info

      added the new IMPORT enum value to the request property (media type: application/json)

    • info

      added the new IMPORT enum value to the request property (media type: application/octet-stream)

    • info

      added the new IMPORT enum value to the request property (media type: application/vnd.schemaregistry.v1+json)

    • info

      added the new IMPORT enum value to the request property (media type: application/vnd.schemaregistry+json)

    • info

      added the new READONLY enum value to the request property (media type: application/json)

    • info

      added the new READONLY enum value to the request property (media type: application/octet-stream)

    • info

      added the new READONLY enum value to the request property (media type: application/vnd.schemaregistry.v1+json)

    • info

      added the new READONLY enum value to the request property (media type: application/vnd.schemaregistry+json)

    • info

      added the new READWRITE enum value to the request property (media type: application/json)

    • info

      added the new READWRITE enum value to the request property (media type: application/octet-stream)

    • info

      added the new READWRITE enum value to the request property (media type: application/vnd.schemaregistry.v1+json)

    • info

      added the new READWRITE enum value to the request property (media type: application/vnd.schemaregistry+json)