Google

Managed Service for Apache Kafka API

Manage Apache Kafka clusters and resources.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Manage Apache Kafka clusters and resources.

Endpoints 35

projects.locations.schemaRegistries.subjects.versions

  • GETGet a versioned schema (schema with subject/version) of a subject./v1/:name?deleted=trueGet a versioned schema (schema with subject/version) of a subject.
  • DELETEDelete a version of a subject/v1/:name?permanent=trueDelete a version of a subject. The response will be the deleted version id.
  • GETGet the schema string only for a version of a subject/v1/:name/schema?deleted=trueGet the schema string only for a version of a subject. The response will be the schema string.
  • GETGet all versions of a subject/v1/:parent/versions?deleted=trueGet all versions of a subject. The response will be an array of versions of the subject.
  • POSTRegister a new version under a given subject with the given schema./v1/:parent/versionsRegister a new version under a given subject with the given schema.

projects.locations.schemaRegistries.mode

  • PUTUpdate mode at global level or for a subject./v1/:nameUpdate mode at global level or for a subject.

projects.locations.schemaRegistries.contexts.compatibility

  • POSTCheck compatibility of a schema with all versions or a specific version of a subject./v1/:nameCheck compatibility of a schema with all versions or a specific version of a subject.

projects.locations.connectClusters.connectors

  • PATCHUpdates the properties of a connector./v1/:name?updateMask=stringUpdates the properties of a connector.
  • GETLists the connectors in a given Connect cluster./v1/:parent/connectors?pageSize=0&pageToken=stringLists the connectors in a given Connect cluster.
  • POSTCreates a new connector in a given Connect cluster./v1/:parent/connectors?connectorId=stringCreates a new connector in a given Connect cluster.
  • POSTPauses the connector and its tasks./v1/:name:pausePauses the connector and its tasks.
  • POSTRestarts the connector./v1/:name:restartRestarts the connector.
  • POSTResumes the connector and its tasks./v1/:name:resumeResumes the connector and its tasks.
  • POSTStops the connector./v1/:name:stopStops the connector.

projects.locations

  • GETLists information about the supported locations for this service/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…

projects.locations.clusters

  • GETLists the clusters in a given project and location./v1/:parent/clusters?filter=string&orderBy=string&pageSize=0&pageToken=stringLists the clusters in a given project and location.
  • POSTCreates a new cluster in a given project and location./v1/:parent/clusters?clusterId=string&requestId=stringCreates a new cluster in a given project and location.

projects.locations.clusters.acls

  • POSTIncremental update: Adds an acl entry to an acl/v1/:acl:addAclEntryIncremental update: Adds an acl entry to an acl. Creates the acl if it does not exist yet.
  • GETLists the acls in a given cluster./v1/:parent/acls?pageSize=0&pageToken=stringLists the acls in a given cluster.
  • POSTCreates a new acl in the given project, location, and cluster./v1/:parent/acls?aclId=stringCreates a new acl in the given project, location, and cluster.
  • POSTIncremental update: Removes an acl entry from an acl/v1/:acl:removeAclEntryIncremental update: Removes an acl entry from an acl. Deletes the acl if its acl entries become empty (i.e. if the removed entry was the last one in the acl).

projects.locations.clusters.consumerGroups

  • GETLists the consumer groups in a given cluster./v1/:parent/consumerGroups?filter=string&pageSize=0&pageToken=string&view=CONSUMER_GROUP_VIEW_UNSPECIFIEDLists the consumer groups in a given cluster.

projects.locations.clusters.topics

  • GETLists the topics in a given cluster./v1/:parent/topics?pageSize=0&pageToken=stringLists the topics in a given cluster.
  • POSTCreates a new topic in a given project and location./v1/:parent/topics?topicId=stringCreates a new topic in a given project and location.

projects.locations.connectClusters

  • GETLists the Kafka Connect clusters in a given project and location./v1/:parent/connectClusters?filter=string&orderBy=string&pageSize=0&pageToken=stringLists the Kafka Connect clusters in a given project and location.
  • POSTCreates a new Kafka Connect cluster in a given project and location./v1/:parent/connectClusters?connectClusterId=string&requestId=stringCreates a new Kafka Connect cluster in a given project and location.

projects.locations.operations

  • POSTStarts asynchronous cancellation on a long-running operation/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…
  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

projects.locations.schemaRegistries

  • GETList schema registries./v1/:parent/schemaRegistries?view=SCHEMA_REGISTRY_VIEW_UNSPECIFIEDList schema registries.
  • POSTCreate a schema registry instance./v1/:parent/schemaRegistriesCreate a schema registry instance.

projects.locations.schemaRegistries.contexts

  • GETList contexts for a schema registry./v1/:parent/contextsList contexts for a schema registry.

projects.locations.schemaRegistries.subjects

  • GETList subjects in the schema registry/v1/:parent/subjects?deleted=true&subjectPrefix=stringList subjects in the schema registry. The response will be an array of subject names.
  • POSTLookup a schema under the specified subject./v1/:parentLookup a schema under the specified subject.

projects.locations.schemaRegistries.schemas.types

  • GETList the supported schema types/v1/:parent/schemas/typesList the supported schema types. The response will be an array of schema types.

projects.locations.schemaRegistries.subjects.versions.referencedby

  • GETGet a list of IDs of schemas that reference the schema with the given subject and version./v1/:parent/referencedbyGet a list of IDs of schemas that reference the schema with the given subject and version.

API details

Base URL
https://managedkafka.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
35 operations on 24 pathsGET 16POST 16PUT 1PATCH 1DELETE 1
Main resources
projects.locations.connectClusters.connectors 7projects.locations.schemaRegistries.subjects.versions 5projects.locations.clusters.acls 4projects.locations.clusters 2projects.locations.clusters.topics 2projects.locations.connectClusters 2projects.locations.operations 2projects.locations.schemaRegistries 2projects.locations.schemaRegistries.subjects 2projects.locations 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Managed Service for Apache Kafka API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Managed Service for Apache Kafka API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get a versioned schema (schema with subject/version) of a subject.” (GET /v1/:name?deleted=true), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Managed Service for Apache Kafka API?

Manage Apache Kafka clusters and resources. It is listed under Developer tools and has 35 endpoints.

Who publishes the Managed Service for Apache Kafka API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Managed Service for Apache Kafka API?

Requests go to https://managedkafka.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Managed Service for Apache Kafka API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the Managed Service for Apache Kafka API have?

35 operations on 24 paths (16 GET, 16 POST, 1 PUT, 1 PATCH, 1 DELETE). The largest groups are projects.locations.connectClusters.connectors, projects.locations.schemaRegistries.subjects.versions, projects.locations.clusters.acls, projects.locations.clusters.

Is forking the Managed Service for Apache Kafka API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.