Help Center/ EventGrid/ API Reference/ APIs/ Event Schema Management/ Starting Automatic Event Schema Discovery
Updated on 2025-11-07 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Starting Automatic Event Schema Discovery

Function

This API is used to start automatic discovery of event schemas.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v1/{project_id}/schema-discover

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

body

No

Object

Request for discovering event schemas through event data.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Total number of records.

size

Integer

Number of records displayed on the current page.

items

Array of CustomizeSchemaItemInfo objects

Object list.
Table 4 CustomizeSchemaItemInfo

Parameter

Type

Description

id

String

ID of the event schema.

name

String

Name of the event schema. The value must be unique under a tenant.

description

String

Description of the event schema.

compatibility

String

Compatibility of the event schema.

provider_type

String

Type of the event source provider, which can be OFFICIAL (official event source) or CUSTOM (custom event source).

format

String

Format of the event schema.

number_of_versions

Integer

Number of event schema versions.

event_type_id

String

Event type ID.

event_type_name

String

Name of the event type.

event_source_id

String

ID of the event source.

event_source_name

String

Event source name.

event_source_label

String

Event source label.

created_time

String

Time when the event schema is created.

updated_time

String

Time when the event schema is updated.

Example Requests

Start automatic schema discovery.

POST https://{endpoint}/v1/{project_id}/schema-discover

{ }

Example Responses

Status code: 200

Operation successful.

{
  "total" : 1,
  "size" : 1,
  "items" : [ { } ]
}

Status Codes

Status Code

Description

200

Operation successful.

Error Codes

See Error Codes.

Parent topic: Event Schema Management