COconfluent
Resource Preferences (notifications/v1)

Lookup a resource preference by filter (returns one)

General Availability

Make a request to read_by_filter a resource preference.

get/notifications/v1/resource-preferences:lookup

Request

  • Base URL
    https://api.confluent.cloud
  • URL
    https://api.confluent.cloud/notifications/v1/resource-preferences:lookup
  • Auth
    • HTTP basic
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.confluent.cloud/sts/v1/oauth2/token

Query parameters

resourcestring required

Confluent Cloud resource definition

resource_typestring required

Confluent Cloud resource type

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Resource Preference.

api_version'notifications/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'ResourcePreference' required

Kind defines the object this REST resource represents.

idstring required

ID 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").

resourcestring required

Denotes the Confluent Cloud resource definition.

resource_typestring required

Denotes the Confluent Cloud resource type.

current_statestring

Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not receive any notification for the resource. Note that, you will still receive notifications for REQUIRED notification type even when it is DISABLED.

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/notifications/v1/resource-preferences/rp-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/resource-preference=rp-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "resource": "environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector",
  "resource_type": "CONNECTOR",
  "current_state": "ENABLED"
}

Changes

No recorded changes to this operation across all 7 revisions of this API.