Skip to content

ECS Schema

GET/api/v1/ecs/schemas
GET
/api/v1/ecs/schemas

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Query Parameters

filter?

Conditions as filter[][]=. Conditions on different fields all apply. in (any of) and all (every one of, on fields holding several values) take a comma-separated list (\, for a literal comma). exists takes true or false. Datetimes are RFC 3339, now, or a time before now such as -30m, -6h or -7d.

sort?string

Comma-separated sort keys, - for descending, at most 1. Keys: version, component_type. Default: component_type.

limit?integer

Rows per page, 1 to 100 (default 25).

Range1 <= value <= 100
cursor?string

The page.next_cursor of the previous page. Cannot be combined with page.

page?integer

A 1-based page number, for jumping. Cannot be combined with cursor.

Range1 <= value
total?boolean

Set to true to include the number of matching rows in page.total.

Response Body

application/json

curl -X GET "https://example.com/api/v1/ecs/schemas"
{  "page": {    "has_more": true,    "next_cursor": "string",    "page": 0,    "total": 0  },  "schemas": [    {      "component_type": "string",      "schema_id": "string",      "version": 0    }  ]}
POST/api/v1/ecs/schemas
POST
/api/v1/ecs/schemas

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/ecs/schemas" \  -H "Content-Type: application/json" \  -d '{    "component_type": "string",    "schema": null,    "version": 0  }'
{  "component_type": "string",  "created_at": "string",  "dependencies": [    "string"  ],  "incompatible_with": [    "string"  ],  "metadata": null,  "schema": null,  "schema_id": "string",  "version": 0}
GET/api/v1/ecs/schemas/{component_type}
GET
/api/v1/ecs/schemas/{component_type}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

component_type*string

Query Parameters

version?integer
Formatint32
Range0 <= value

Response Body

application/json

curl -X GET "https://example.com/api/v1/ecs/schemas/string"
{  "component_type": "string",  "created_at": "string",  "dependencies": [    "string"  ],  "incompatible_with": [    "string"  ],  "metadata": null,  "schema": null,  "schema_id": "string",  "version": 0}
DELETE/api/v1/ecs/schemas/{component_type}/{version}
DELETE
/api/v1/ecs/schemas/{component_type}/{version}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

component_type*string
version*integer
Formatint32
Range0 <= value

Response Body

curl -X DELETE "https://example.com/api/v1/ecs/schemas/string/0"
Empty