Get core resources schema
GET /api/schema/core
GET /api/schema/coreInteractive request editor loads with JavaScript.
X-API-KEY<token>
In: header
Response Body
application/json
application/json
curl -X GET "$API_BASE_URL/api/schema/core"Successfully retrieved the core APISIX resource schemas.
{
"value": {
"service": {},
"route": {},
"stream_service": {},
"stream_route": {},
"upstream": {},
"consumer": {},
"consumer_credential": {},
"global_rule": {},
"ssl": {},
"aws_secret": {},
"vault_secret": {},
"kubernetes_secret": {},
"plugin_metadata": {}
}
}Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
{
"value": {},
"error_msg": "error message"
}Complete operation details and schema variants
GET /api/schema/core
Get core resources schema
Retrieve schema definitions for core gateway resources. Use these schemas to validate payload structures and build configuration tooling.
Parameters
Responses
200: Successfully retrieved the core APISIX resource schemas.- allOf variant 1
value(object, optional): The specific resource.- allOf variant 2
value(object, optional):value.service(object, optional): Service(L7) schema.value.route(object, optional): Route(L7) schema.value.stream_service(object, optional): Stream service(L4) schema.value.stream_route(object, optional): Stream route(L4) schema.value.upstream(object, optional): Upstream schema.value.consumer(object, optional): Consumer schema.value.consumer_credential(object, optional): Consumer credential schema.value.global_rule(object, optional): Global rule schema.value.ssl(object, optional): SSL schema.value.aws_secret(object, optional): AWS secret schema.value.vault_secret(object, optional): Vault secret schema.value.kubernetes_secret(object, optional): Kubernetes secret schema.value.plugin_metadata(object, optional): Plugin metadata schema.400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.value(object, optional): The specific resource.error_msg(string, optional): The error message.
cURL
curl -X GET '$API_BASE_URL/api/schema/core'