Skip to content

ECS Resource

GET/api/v1/ecs/{index}/resources
GET
/api/v1/ecs/{index}/resources

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

index*string

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: updated_at, name. Default: name.

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/string/resources"
{  "page": {    "has_more": true,    "next_cursor": "string",    "page": 0,    "total": 0  },  "resources": [    {      "data": null,      "name": "string",      "resource_id": "string",      "updated_at": "string",      "version": 0    }  ]}
POST/api/v1/ecs/{index}/resources
POST
/api/v1/ecs/{index}/resources

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

index*string

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/string/resources" \  -H "Content-Type: application/json" \  -d '{    "data": null,    "name": "string"  }'
{  "data": null,  "name": "string",  "resource_id": "string",  "updated_at": "string",  "version": 0}
GET/api/v1/ecs/{index}/resources/{name}
GET
/api/v1/ecs/{index}/resources/{name}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

index*string
name*string

Response Body

application/json

curl -X GET "https://example.com/api/v1/ecs/string/resources/string"
{  "data": null,  "name": "string",  "resource_id": "string",  "updated_at": "string",  "version": 0}
DELETE/api/v1/ecs/{index}/resources/{name}
DELETE
/api/v1/ecs/{index}/resources/{name}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

index*string
name*string

Response Body

curl -X DELETE "https://example.com/api/v1/ecs/string/resources/string"
Empty
PUT/api/v1/ecs/{index}/resources/{name}
PUT
/api/v1/ecs/{index}/resources/{name}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

index*string
name*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/api/v1/ecs/string/resources/string" \  -H "Content-Type: application/json" \  -d '{    "data": null  }'
{  "data": null,  "name": "string",  "resource_id": "string",  "updated_at": "string",  "version": 0}