Mode

PUT /mode/{subject}

Changed on

Updates the subject-level mode. This is allowed only if Schema Registry was started with mode.mutability=true.

Request

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

Path parameters

subjectstring required

Name of the subject.

Query parameters

forceboolean

If true, forces the mode change even if schemas already exist. Useful in disaster recovery scenarios.

Headers

X-Registry-GroupIdstring

Group id in Apicurio Registry.

Request body

modestring required

The new global mode to set.

Example request

{
  "mode": "IMPORT"
}

Response

Returns the updated subject mode.

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

Current operating mode of the registry.

Example response

{
  "mode": "READWRITE"
}

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)

    • 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)