Update subject mode
PUT/mode/:subject
Update mode for the specified subject. On success, echoes the original request back to the client.
Request
Responses
- 200
- 400
- 401
- 403
- 422
- 429
- 500
The original request.
Bad Request
Unauthorized
Forbidden
Unprocessable Entity. Error code 42204 indicates an invalid mode. Error code 42205 indicates operation not permitted.
Rate Limit Exceeded
Response Headers
X-Request-Id
The unique identifier for the API request.
X-RateLimit-Limit
The maximum number of requests you're permitted to make per time period.
X-RateLimit-Remaining
The number of requests remaining in the current rate limit window.
X-RateLimit-Reset
The relative time in seconds until the current rate-limit window resets.
Important: This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues.
Retry-After
The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached.
Internal Server Error. Error code 50001 indicates a failure in the backend data store. Error code 50003 indicates a failure forwarding the request to the primary. Error code 50004 indicates unknown leader.
OpenAPI definition (YAML)
paths:
/mode/{subject}:
put:
tags:
- Modes (v1)
description: Update mode for the specified subject. On success, echoes the original request back
to the client.
operationId: updateMode
parameters:
- name: subject
in: path
description: Name of the subject
required: true
schema:
type: string
- name: force
in: query
description: Whether to force update if setting mode to IMPORT and schemas currently exist
schema:
type: boolean
requestBody:
description: Update Request
content:
application/vnd.schemaregistry.v1+json:
schema:
type: object
properties:
mode:
type: string
description: Schema Registry operating mode
example: READWRITE
enum:
- READWRITE
- READONLY
- READONLY_OVERRIDE
- IMPORT
description: Mode update request
title: ModeUpdateRequest
application/vnd.schemaregistry+json:
schema:
type: object
properties:
mode:
type: string
description: Schema Registry operating mode
example: READWRITE
enum:
- READWRITE
- READONLY
- READONLY_OVERRIDE
- IMPORT
description: Mode update request
title: ModeUpdateRequest
application/json:
schema:
type: object
properties:
mode:
type: string
description: Schema Registry operating mode
example: READWRITE
enum:
- READWRITE
- READONLY
- READONLY_OVERRIDE
- IMPORT
description: Mode update request
title: ModeUpdateRequest
application/octet-stream:
schema:
type: object
properties:
mode:
type: string
description: Schema Registry operating mode
example: READWRITE
enum:
- READWRITE
- READONLY
- READONLY_OVERRIDE
- IMPORT
description: Mode update request
title: ModeUpdateRequest
required: true
responses:
'200':
description: The original request.
content:
application/vnd.schemaregistry.v1+json:
schema:
type: object
properties:
mode:
type: string
description: Schema Registry operating mode
example: READWRITE
enum:
- READWRITE
- READONLY
- READONLY_OVERRIDE
- IMPORT
description: Mode update request
title: ModeUpdateRequest
application/vnd.schemaregistry+json; qs=0.9:
schema:
type: object
properties:
mode:
type: string
description: Schema Registry operating mode
example: READWRITE
enum:
- READWRITE
- READONLY
- READONLY_OVERRIDE
- IMPORT
description: Mode update request
title: ModeUpdateRequest
application/json; qs=0.5:
schema:
type: object
properties:
mode:
type: string
description: Schema Registry operating mode
example: READWRITE
enum:
- READWRITE
- READONLY
- READONLY_OVERRIDE
- IMPORT
description: Mode update request
title: ModeUpdateRequest
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
error_code:
type: integer
description: The error code
format: int32
message:
type: string
description: The error message
description: Error message of this operation
title: ErrorMessage
example:
error_code: 400
message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error_code:
type: integer
description: The error code
format: int32
message:
type: string
description: The error message
description: Error message of this operation
title: ErrorMessage
example:
error_code: 401
message: Unauthorized
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
error_code:
type: integer
description: The error code
format: int32
message:
type: string
description: The error message
description: Error message of this operation
title: ErrorMessage
example:
error_code: 403
message: Forbidden
'422':
description: Unprocessable Entity. Error code 42204 indicates an invalid mode. Error code 42205
indicates operation not permitted.
content:
application/vnd.schemaregistry.v1+json:
schema:
type: object
properties:
error_code:
type: integer
description: The error code
format: int32
message:
type: string
description: The error message
description: Error message of this operation
title: ErrorMessage
application/vnd.schemaregistry+json; qs=0.9:
schema:
type: object
properties:
error_code:
type: integer
description: The error code
format: int32
message:
type: string
description: The error message
description: Error message of this operation
title: ErrorMessage
application/json; qs=0.5:
schema:
type: object
properties:
error_code:
type: integer
description: The error code
format: int32
message:
type: string
description: The error message
description: Error message of this operation
title: ErrorMessage
'429':
description: Rate Limit Exceeded
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
X-RateLimit-Limit:
schema:
type: integer
description: The maximum number of requests you're permitted to make per time period.
X-RateLimit-Remaining:
schema:
type: integer
description: The number of requests remaining in the current rate limit window.
X-RateLimit-Reset:
schema:
type: integer
description: "The relative time in seconds until the current rate-limit window resets. \
\ \n \n**Important:** This differs from Github and Twitter's same-named header which\
\ uses UTC epoch seconds. We use relative time to avoid client/server time synchronization\
\ issues."
Retry-After:
schema:
type: integer
description: The number of seconds to wait until the rate limit window resets. Only sent
when the rate limit is reached.
'500':
description: Internal Server Error. Error code 50001 indicates a failure in the backend data
store. Error code 50003 indicates a failure forwarding the request to the primary. Error code
50004 indicates unknown leader.
content:
application/vnd.schemaregistry.v1+json:
schema:
type: object
properties:
error_code:
type: integer
description: The error code
format: int32
message:
type: string
description: The error message
description: Error message of this operation
title: ErrorMessage
application/vnd.schemaregistry+json; qs=0.9:
schema:
type: object
properties:
error_code:
type: integer
description: The error code
format: int32
message:
type: string
description: The error message
description: Error message of this operation
title: ErrorMessage
application/json; qs=0.5:
schema:
type: object
properties:
error_code:
type: integer
description: The error code
format: int32
message:
type: string
description: The error message
description: Error message of this operation
title: ErrorMessage
security:
- resource-api-key: []
- external-access-token: []
servers:
- url: https://psrc-00000.region.provider.confluent.cloud
description: Confluent Cloud Schema Registry Endpoint.
jsonRequestBodyExample:
mode: READWRITE