Skip to main content

environments

Overview

Nameenvironments
TypeResource
Idconfluent.org.environments

Fields

NameDatatypeDescription
idstringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").
api_versionstringAPIVersion defines the schema version of this representation of a resource.
display_namestringA human-readable name for the Environment
kindstringKind defines the object this REST resource represents.
metadata``ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stream_governance_configobjectStream Governance configurations for the environment

Methods

NameAccessible byRequired ParamsDescription
get_org_v2environmentSELECTidGeneral Availability

Make a request to read an environment.
list_org_v2environmentsSELECTGeneral Availability

Retrieve a sorted, filtered, paginated list of all environments.
create_org_v2environmentINSERTGeneral Availability

Make a request to create an environment.
delete_org_v2environmentDELETEidGeneral Availability

Make a request to delete an environment.

If successful, this request will also recursively delete all of the environment's associated resources,
including all Kafka clusters, connectors, etc.
update_org_v2environmentUPDATEidGeneral Availability

Make a request to update an environment.