console.redhat.com CloudEvents v1

Messages

• #1Event

  Payload

  Expand all

  object oneOf

  uid: https://console.redhat.com/api/schemas/events/v1/events.json

  See https://raw.githubusercontent.com/cloudevents/spec/main/cloudevents/formats/cloudevents.json for base CloudEvents schema. NOTE: this schema inlines and further constrains some CloudEvents properties

  id

  required

  string

  format: uuid

  Identifies the event. Unique for this source.

  Examples values:
  • "afebabe-cafe-babe-cafe-babecafebabe"

  source

  required

  string

  must match: ^urn:redhat:source:[a-z0-9][a-z0-9-_]+[a-z0-9](:[a-z0-9][a-z0-9-_]+[a-z0-9])*$

  Describes the source (or app) that generated the event.

  Examples values:
  • "urn:redhat:source:insights:advisor"
  • "urn:redhat:source:rhosak"
  • "urn:redhat:source:crc:notifications"

  subject

  string

  must match: ^urn:redhat:subject:([a-z0-9][a-z0-9-_]+[a-z0-9]:[a-z0-9A-Z-_]*)+$

  Describes the subject of the event. URN in format urn:redhat:subject:$instance_type:$id. The urn may be longer to accommodate hierarchies

  Examples values:
  • "urn:redhat:subject:rhel_system:2356aad8-de45-4ba0-80bd-4637763ad115"
  • "urn:redhat:subject:rhel_system:2356aad8-de45-4ba0-80bd-4637763ad115:mssql_instance:b24c269d-33d6-410e-8808-c71c9635e84f"
  • "urn:redhat:subject:ansible_cluster:2356aad8-de45-4ba0-80bd-4637763ad115"
  • "urn:redhat:subject:cve:CVE-2014-0160"

  specversion

  required

  string

  Specifies the version of the CloudEvents spec targeted.

  Allowed values:
  • "1.0"

  type

  required

  string

  must match: ^com\.[a-z0-9][a-z0-9-_]+[a-z0-9](\.[a-z0-9][a-z0-9-_]+[a-z0-9])*$

  The type of the event.

  Examples values:
  • "com.redhat.console.advisor.new-recommendations"
  • "com.redhat.console.subscriptions.vdc-misconfiguration"

  dataschema

  required

  string

  must match: https://console.redhat.com/api/schemas/.*

  Identifies the schema that data adheres to.

  data

  Expand all

  object

  Additional properties are allowed.

  time

  required

  string

  format: date-timenon-empty

  redhataccount

  string

  non-empty

  redhatorgid

  required

  string

  non-empty

  Adheres to:

  Expand all

  restricted any

  dataschema

  string

  Const:"https://console.redhat.com/api/schemas/apps/policies/v1/policy-triggered.json"

  data

  Expand all

  required

  object

  uid: https://console.redhat.com/api/schemas/apps/policies/v1/policy-triggered.json

  Event data for triggered policies.

  policies

  Expand all

  required

  array<object>

  Triggered policies for a system

  id

  required

  string

  format: uuid

  name

  required

  string

  non-empty

  description

  required

  string

  condition

  required

  string

  non-empty

  url

  required

  string

  format: uri

  system

  Expand all

  required

  object

  A RHEL system managed by console.redhat.com

  inventory_id

  required

  string

  non-empty

  hostname

  string

  non-empty

  display_name

  string

  non-empty

  rhel_version

  string

  non-empty

  Examples values:
  • "8.4"

  host_url

  string

  format: urimust match: https://console.redhat.com/insights/inventory/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

  tags

  Expand all

  array<object>

  namespace

  required

  string

  non-empty

  key

  required

  string

  non-empty

  value

  string

  check_in

  string

  format: date-timenon-empty

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  Expand all

  restricted any

  dataschema

  string

  Const:"https://console.redhat.com/api/schemas/apps/advisor/v1/advisor-recommendations.json"

  data

  Expand all

  required

  object

  uid: https://console.redhat.com/api/schemas/apps/advisor/v1/advisor-recommendations.json

  Event data for Advisor Recommendations.

  advisor_recommendations

  Expand all

  required

  array<object>

  Advisor recommendations for a system

  rule_id

  required

  string

  non-empty

  rule_description

  required

  string

  non-empty

  total_risk

  required

  string

  non-empty

  rule_url

  required

  string

  must match: https://.*

  publish_date

  required

  string

  format: date-time

  reboot_required

  required

  boolean

  system

  Expand all

  required

  object

  A RHEL system managed by console.redhat.com

  inventory_id

  required

  string

  non-empty

  hostname

  string

  non-empty

  display_name

  string

  non-empty

  rhel_version

  string

  non-empty

  Examples values:
  • "8.4"

  host_url

  string

  format: urimust match: https://console.redhat.com/insights/inventory/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

  tags

  Expand all

  array<object>

  namespace

  required

  string

  non-empty

  key

  required

  string

  non-empty

  value

  string

  check_in

  string

  format: date-timenon-empty

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  Expand all

  restricted any

  dataschema

  string

  Const:"https://console.redhat.com/api/schemas/core/v1/empty.json"

  data

  null

  uid: https://console.redhat.com/api/schemas/core/v1/empty.json

  Schema that indicates an event does not have any data. Useful when the subject and type are sufficient. The producer is still allowed to explicitly emit null in the data field if desired.

  Or to:

  Expand all

  restricted any

  dataschema

  string

  Const:"https://console.redhat.com/api/schemas/core/v1/error.json"

  data

  Expand all

  required

  object

  uid: https://console.redhat.com/api/schemas/core/v1/error.json

  Event data for an application error.

  error

  Expand all

  required

  object

  An error reported by an application.

  code

  required

  string

  non-empty

  Machine-readable error code that identifies the error.

  Examples values:
  • "401"
  • "AMQ022272"

  message

  required

  string

  non-empty

  Human readable description of the error.

  stack_trace

  string

  non-empty

  The stack trace/traceback (optional)

  severity

  required

  string

  non-empty

  The severity of the error.

  Allowed values:
  • "warning"
  • "error"
  • "critical"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  Expand all

  restricted any

  dataschema

  string

  Const:"https://console.redhat.com/api/schemas/core/v1/notification.json"

  data

  Expand all

  required

  object

  uid: https://console.redhat.com/api/schemas/core/v1/notification.json

  Notification event. Appropriate when an event has no data aside from recipient settings. If the event requires data, then it should reference the Recipient object definition in a separate schema.

  notification_recipients

  Expand all

  object

  Notification recipients. Should be in a top-level field named "notification_recipients"

  only_admins

  boolean

  Setting to true sends an email to the administrators of the account. Setting to false sends an email to all users of the account.

  ignore_user_preferences

  boolean

  Setting to true ignores all the user preferences on this Recipient setting (It doesn’t affect other configuration that an Administrator sets on their Notification settings). Setting to false honors the user preferences.

  users

  Expand all

  array<string>

  List of users to direct the notification to. This won’t override notification's administrators settings. Users list will be merged with other settings.

  Items:

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  Expand all

  restricted any

  dataschema

  string

  Const:"https://console.redhat.com/api/schemas/core/v1/rhel_system.json"

  data

  Expand all

  required

  object

  uid: https://console.redhat.com/api/schemas/core/v1/rhel_system.json

  Event data for a RHEL system.

  system

  Expand all

  required

  object

  A RHEL system managed by console.redhat.com

  inventory_id

  required

  string

  non-empty

  hostname

  string

  non-empty

  display_name

  string

  non-empty

  rhel_version

  string

  non-empty

  Examples values:
  • "8.4"

  host_url

  string

  format: urimust match: https://console.redhat.com/insights/inventory/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

  tags

  Expand all

  array<object>

  namespace

  required

  string

  non-empty

  key

  required

  string

  non-empty

  value

  string

  check_in

  string

  format: date-timenon-empty

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  Expand all

  restricted any

  dataschema

  string

  Const:"https://console.redhat.com/api/schemas/apps/repositories/v1/repository-events.json"

  data

  Expand all

  required

  object

  uid: https://console.redhat.com/api/schemas/apps/repositories/v1/repository-events.json

  Event data for Repository Events.

  repositories

  Expand all

  required

  array<object>

  List of repositories affected by the event

  uuid

  required

  string

  non-empty

  name

  required

  string

  non-empty

  url

  required

  string

  non-empty

  distribution_versions

  Expand all

  array<string>

  Items:

  string

  distribution_arch

  string

  last_introspection_time

  string

  format: date-time

  last_success_introspection_time

  string

  format: date-time

  last_update_introspection_time

  string

  format: date-time

  last_introspection_error

  string

  failed_introspections_count

  integer

  package_count

  integer

  status

  string

  gpg_key

  string

  metadata_verification

  boolean

  Additional properties are NOT allowed.

  Or to:

  Expand all

  restricted any

  dataschema

  string

  Const:"https://console.redhat.com/api/schemas/apps/export-service/v1/resource-request.json"

  data

  Expand all

  required

  object

  uid: https://console.redhat.com/api/schemas/apps/export-service/v1/resource-request.json

  Event data for data export requests

  resource_request

  Expand all

  required

  object

  A request for data to be exported

  uuid

  required

  string

  format: uuid

  A unique identifier for the resource request

  export_request_uuid

  required

  string

  format: uuid

  The unique identifier of the export request that triggered the resource request

  application

  required

  string

  The application being requested

  format

  required

  string

  The format of the data to be exported

  Allowed values:
  • "csv"
  • "json"

  resource

  required

  string

  The resource to be exported

  x-rh-identity

  required

  string

  encoding: base64

  The Base64-encoded JSON identity header of the user making the request

  filters

  Expand all

  object

  The filters to be applied to the data

  Additional properties are allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are allowed.