List entity types
GET/api/v1/catalog/definitions
List entity types
Response excludes Cortex default types of service, domain, and team.
Request
Query Parameters
includeBuiltIn boolean
When true, returns the built-in entity types that Cortex provides, such as rds
and s3
. Defaults to false.
pageSize int32required
Default value: 250
Number of results to return per page, between 1 and 1000. Default 250.
page int32required
Default value: 0
Page number to return, 0-indexed. Default 0.
Responses
- 200
Successfully found entity types
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
definitions
object[]
required
description string
name string
schema objectrequired
source stringrequired
Possible values: [CORTEX
, CUSTOM
]
type stringrequired
page int32required
Current page number, 0-indexed
total int32required
Total number of results
totalPages int32required
Total number of pages
{
"definitions": [
{
"description": "string",
"name": "string",
"schema": {},
"source": "CORTEX",
"type": "string"
}
],
"page": 0,
"total": 0,
"totalPages": 0
}
Loading...