Managed Service for Apache Kafka API

Manage Apache Kafka clusters and resources.

Service: managedkafka.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://managedkafka.googleapis.com

REST Resource: v1.projects.locations

Methods
get GET /v1/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1.projects.locations.clusters

Methods
create POST /v1/{parent=projects/*/locations/*}/clusters
Creates a new cluster in a given project and location.
delete DELETE /v1/{name=projects/*/locations/*/clusters/*}
Deletes a single cluster.
get GET /v1/{name=projects/*/locations/*/clusters/*}
Returns the properties of a single cluster.
list GET /v1/{parent=projects/*/locations/*}/clusters
Lists the clusters in a given project and location.
patch PATCH /v1/{cluster.name=projects/*/locations/*/clusters/*}
Updates the properties of a single cluster.

REST Resource: v1.projects.locations.clusters.acls

Methods
addAclEntry POST /v1/{acl=projects/*/locations/*/clusters/*/acls/**}:addAclEntry
Incremental update: Adds an acl entry to an acl.
create POST /v1/{parent=projects/*/locations/*/clusters/*}/acls
Creates a new acl in the given project, location, and cluster.
delete DELETE /v1/{name=projects/*/locations/*/clusters/*/acls/**}
Deletes an acl.
get GET /v1/{name=projects/*/locations/*/clusters/*/acls/**}
Returns the properties of a single acl.
list GET /v1/{parent=projects/*/locations/*/clusters/*}/acls
Lists the acls in a given cluster.
patch PATCH /v1/{acl.name=projects/*/locations/*/clusters/*/acls/**}
Updates the properties of a single acl.
removeAclEntry POST /v1/{acl=projects/*/locations/*/clusters/*/acls/**}:removeAclEntry
Incremental update: Removes an acl entry from an acl.

REST Resource: v1.projects.locations.clusters.consumerGroups

Methods
delete DELETE /v1/{name=projects/*/locations/*/clusters/*/consumerGroups/**}
Deletes a single consumer group.
get GET /v1/{name=projects/*/locations/*/clusters/*/consumerGroups/**}
Returns the properties of a single consumer group.
list GET /v1/{parent=projects/*/locations/*/clusters/*}/consumerGroups
Lists the consumer groups in a given cluster.
patch PATCH /v1/{consumerGroup.name=projects/*/locations/*/clusters/*/consumerGroups/**}
Updates the properties of a single consumer group.

REST Resource: v1.projects.locations.clusters.topics

Methods
create POST /v1/{parent=projects/*/locations/*/clusters/*}/topics
Creates a new topic in a given project and location.
delete DELETE /v1/{name=projects/*/locations/*/clusters/*/topics/*}
Deletes a single topic.
get GET /v1/{name=projects/*/locations/*/clusters/*/topics/*}
Returns the properties of a single topic.
list GET /v1/{parent=projects/*/locations/*/clusters/*}/topics
Lists the topics in a given cluster.
patch PATCH /v1/{topic.name=projects/*/locations/*/clusters/*/topics/*}
Updates the properties of a single topic.

REST Resource: v1.projects.locations.connectClusters

Methods
create POST /v1/{parent=projects/*/locations/*}/connectClusters
Creates a new Kafka Connect cluster in a given project and location.
delete DELETE /v1/{name=projects/*/locations/*/connectClusters/*}
Deletes a single Connect cluster.
get GET /v1/{name=projects/*/locations/*/connectClusters/*}
Returns the properties of a single Kafka Connect cluster.
list GET /v1/{parent=projects/*/locations/*}/connectClusters
Lists the Kafka Connect clusters in a given project and location.
patch PATCH /v1/{connectCluster.name=projects/*/locations/*/connectClusters/*}
Updates the properties of a single Kafka Connect cluster.

REST Resource: v1.projects.locations.connectClusters.connectors

Methods
create POST /v1/{parent=projects/*/locations/*/connectClusters/*}/connectors
Creates a new connector in a given Connect cluster.
delete DELETE /v1/{name=projects/*/locations/*/connectClusters/*/connectors/*}
Deletes a connector.
get GET /v1/{name=projects/*/locations/*/connectClusters/*/connectors/*}
Returns the properties of a single connector.
list GET /v1/{parent=projects/*/locations/*/connectClusters/*}/connectors
Lists the connectors in a given Connect cluster.
patch PATCH /v1/{connector.name=projects/*/locations/*/connectClusters/*/connectors/*}
Updates the properties of a connector.
pause POST /v1/{name=projects/*/locations/*/connectClusters/*/connectors/*}:pause
Pauses the connector and its tasks.
restart POST /v1/{name=projects/*/locations/*/connectClusters/*/connectors/*}:restart
Restarts the connector.
resume POST /v1/{name=projects/*/locations/*/connectClusters/*/connectors/*}:resume
Resumes the connector and its tasks.
stop POST /v1/{name=projects/*/locations/*/connectClusters/*/connectors/*}:stop
Stops the connector.

REST Resource: v1.projects.locations.operations

Methods
cancel POST /v1/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.locations.schemaRegistries

Methods
create POST /v1/{parent=projects/*/locations/*}/schemaRegistries
Create a schema registry instance.
delete DELETE /v1/{name=projects/*/locations/*/schemaRegistries/*}
Delete a schema registry instance.
get GET /v1/{name=projects/*/locations/*/schemaRegistries/*}
Get the schema registry instance.
list GET /v1/{parent=projects/*/locations/*}/schemaRegistries
List schema registries.

REST Resource: v1.projects.locations.schemaRegistries.compatibility

Methods
checkCompatibility POST /v1/{name=projects/*/locations/*/schemaRegistries/*/compatibility/**}
Check compatibility of a schema with all versions or a specific version of a subject.

REST Resource: v1.projects.locations.schemaRegistries.config

Methods
delete DELETE /v1/{name=projects/*/locations/*/schemaRegistries/*/config/**}
Delete schema config for a subject.
get GET /v1/{name=projects/*/locations/*/schemaRegistries/*/config/**}
Get schema config at global level or for a subject.
update PUT /v1/{name=projects/*/locations/*/schemaRegistries/*/config/**}
Update config at global level or for a subject.

REST Resource: v1.projects.locations.schemaRegistries.contexts

Methods
get GET /v1/{name=projects/*/locations/*/schemaRegistries/*/contexts/*}
Get the context.
list GET /v1/{parent=projects/*/locations/*/schemaRegistries/*}/contexts
List contexts for a schema registry.

REST Resource: v1.projects.locations.schemaRegistries.contexts.compatibility

Methods
checkCompatibility POST /v1/{name=projects/*/locations/*/schemaRegistries/*/contexts/*/compatibility/**}
Check compatibility of a schema with all versions or a specific version of a subject.

REST Resource: v1.projects.locations.schemaRegistries.contexts.config

Methods
delete DELETE /v1/{name=projects/*/locations/*/schemaRegistries/*/contexts/*/config/**}
Delete schema config for a subject.
get GET /v1/{name=projects/*/locations/*/schemaRegistries/*/contexts/*/config/**}
Get schema config at global level or for a subject.
update PUT /v1/{name=projects/*/locations/*/schemaRegistries/*/contexts/*/config/**}
Update config at global level or for a subject.

REST Resource: v1.projects.locations.schemaRegistries.contexts.mode

Methods
delete DELETE /v1/{name=projects/*/locations/*/schemaRegistries/*/contexts/*/mode/**}
Delete schema mode for a subject.
get GET /v1/{name=projects/*/locations/*/schemaRegistries/*/contexts/*/mode/**}
Get mode at global level or for a subject.
update PUT /v1/{name=projects/*/locations/*/schemaRegistries/*/contexts/*/mode/**}
Update mode at global level or for a subject.

REST Resource: v1.projects.locations.schemaRegistries.contexts.schemas

Methods
get GET /v1/{name=projects/*/locations/*/schemaRegistries/*/contexts/*/schemas/**}
Get the schema for the given schema id.
getSchema GET /v1/{name=projects/*/locations/*/schemaRegistries/*/contexts/*/schemas/**}/schema
Get the schema string for the given schema id.

REST Resource: v1.projects.locations.schemaRegistries.contexts.schemas.subjects

Methods
list GET /v1/{parent=projects/*/locations/*/schemaRegistries/*/contexts/*/schemas/**}/subjects
List subjects which reference a particular schema id.

REST Resource: v1.projects.locations.schemaRegistries.contexts.schemas.types

Methods
list GET /v1/{parent=projects/*/locations/*/schemaRegistries/*/contexts/*}/schemas/types
List the supported schema types.

REST Resource: v1.projects.locations.schemaRegistries.contexts.schemas.versions

Methods
list GET /v1/{parent=projects/*/locations/*/schemaRegistries/*/contexts/*/schemas/**}/versions
List the schema versions for the given schema id.

REST Resource: v1.projects.locations.schemaRegistries.contexts.subjects

Methods
delete DELETE /v1/{name=projects/*/locations/*/schemaRegistries/*/contexts/*/subjects/*}
Delete a subject.
list GET /v1/{parent=projects/*/locations/*/schemaRegistries/*/contexts/*}/subjects
List subjects in the schema registry.
lookupVersion POST /v1/{parent=projects/*/locations/*/schemaRegistries/*/contexts/*/subjects/*}
Lookup a schema under the specified subject.

REST Resource: v1.projects.locations.schemaRegistries.contexts.subjects.versions

Methods
create POST /v1/{parent=projects/*/locations/*/schemaRegistries/*/contexts/*/subjects/*}/versions
Register a new version under a given subject with the given schema.
delete DELETE /v1/{name=projects/*/locations/*/schemaRegistries/*/contexts/*/subjects/*/versions/*}
Delete a version of a subject.
get GET /v1/{name=projects/*/locations/*/schemaRegistries/*/contexts/*/subjects/*/versions/*}
Get a versioned schema (schema with subject/version) of a subject.
getSchema GET /v1/{name=projects/*/locations/*/schemaRegistries/*/contexts/*/subjects/*/versions/*}/schema
Get the schema string only for a version of a subject.
list GET /v1/{parent=projects/*/locations/*/schemaRegistries/*/contexts/*/subjects/*}/versions
Get all versions of a subject.

REST Resource: v1.projects.locations.schemaRegistries.contexts.subjects.versions.referencedby

Methods
list GET /v1/{parent=projects/*/locations/*/schemaRegistries/*/contexts/*/subjects/*/versions/*}/referencedby
Get a list of IDs of schemas that reference the schema with the given subject and version.

REST Resource: v1.projects.locations.schemaRegistries.mode

Methods
delete DELETE /v1/{name=projects/*/locations/*/schemaRegistries/*/mode/**}
Delete schema mode for a subject.
get GET /v1/{name=projects/*/locations/*/schemaRegistries/*/mode/**}
Get mode at global level or for a subject.
update PUT /v1/{name=projects/*/locations/*/schemaRegistries/*/mode/**}
Update mode at global level or for a subject.

REST Resource: v1.projects.locations.schemaRegistries.schemas

Methods
get GET /v1/{name=projects/*/locations/*/schemaRegistries/*/schemas/**}
Get the schema for the given schema id.
getSchema GET /v1/{name=projects/*/locations/*/schemaRegistries/*/schemas/**}/schema
Get the schema string for the given schema id.

REST Resource: v1.projects.locations.schemaRegistries.schemas.subjects

Methods
list GET /v1/{parent=projects/*/locations/*/schemaRegistries/*/schemas/**}/subjects
List subjects which reference a particular schema id.

REST Resource: v1.projects.locations.schemaRegistries.schemas.types

Methods
list GET /v1/{parent=projects/*/locations/*/schemaRegistries/*}/schemas/types
List the supported schema types.

REST Resource: v1.projects.locations.schemaRegistries.schemas.versions

Methods
list GET /v1/{parent=projects/*/locations/*/schemaRegistries/*/schemas/**}/versions
List the schema versions for the given schema id.

REST Resource: v1.projects.locations.schemaRegistries.subjects

Methods
delete DELETE /v1/{name=projects/*/locations/*/schemaRegistries/*/subjects/*}
Delete a subject.
list GET /v1/{parent=projects/*/locations/*/schemaRegistries/*}/subjects
List subjects in the schema registry.
lookupVersion POST /v1/{parent=projects/*/locations/*/schemaRegistries/*/subjects/*}
Lookup a schema under the specified subject.

REST Resource: v1.projects.locations.schemaRegistries.subjects.versions

Methods
create POST /v1/{parent=projects/*/locations/*/schemaRegistries/*/subjects/*}/versions
Register a new version under a given subject with the given schema.
delete DELETE /v1/{name=projects/*/locations/*/schemaRegistries/*/subjects/*/versions/*}
Delete a version of a subject.
get GET /v1/{name=projects/*/locations/*/schemaRegistries/*/subjects/*/versions/*}
Get a versioned schema (schema with subject/version) of a subject.
getSchema GET /v1/{name=projects/*/locations/*/schemaRegistries/*/subjects/*/versions/*}/schema
Get the schema string only for a version of a subject.
list GET /v1/{parent=projects/*/locations/*/schemaRegistries/*/subjects/*}/versions
Get all versions of a subject.

REST Resource: v1.projects.locations.schemaRegistries.subjects.versions.referencedby

Methods
list GET /v1/{parent=projects/*/locations/*/schemaRegistries/*/subjects/*/versions/*}/referencedby
Get a list of IDs of schemas that reference the schema with the given subject and version.