HydraCore
API by router

Entity store

Internal List Definitions

GET
/internal/v1/instances/{instance_id}/entity-definitions

Path Parameters

instance_id*Instance Id
Formatuuid

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-definitions'
Example Response
null

Internal Get Definition

GET
/internal/v1/instances/{instance_id}/entity-definitions/{slug}

Path Parameters

instance_id*Instance Id
Formatuuid
slug*Slug

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-definitions/string'
Example Response
null

Internal Kv Get

GET
/internal/v1/instances/{instance_id}/entity-kv

Path Parameters

instance_id*Instance Id
Formatuuid

Query Parameters

customer_id*Customer Id
Formatuuid
namespace*Namespace
key*Key

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-kv?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&namespace=string&key=string'
Example Response
null

Internal Kv Delete

DELETE
/internal/v1/instances/{instance_id}/entity-kv

Path Parameters

instance_id*Instance Id
Formatuuid

Query Parameters

customer_id*Customer Id
Formatuuid
namespace*Namespace
key*Key

Response Body

Successful Response

Example Request
curl -X DELETE 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-kv?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&namespace=string&key=string'
Example Response
Empty

Internal Kv Set

PUT
/internal/v1/instances/{instance_id}/entity-kv

Path Parameters

instance_id*Instance Id
Formatuuid

Request Body

application/json
  1. body
customer_id*Customer Id
Formatuuid
expires_at?|null
key*Key
Length1 <= length <= 255
namespace*Namespace
Length1 <= length <= 100
value*

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X PUT 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-kv' \  -H 'Content-Type: application/json' \  -d '{  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",  "key": "string",  "namespace": "string",  "value": {}}'
Example Response
null

Internal Kv Batch Set

POST
/internal/v1/instances/{instance_id}/entity-kv/batch

Path Parameters

instance_id*Instance Id
Formatuuid

Request Body

application/json
  1. body
customer_id*Customer Id
Formatuuid
entries*array<>

List of {key, value, expires_at?}

namespace*Namespace
Length1 <= length <= 100

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-kv/batch' \  -H 'Content-Type: application/json' \  -d '{  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",  "entries": [    {}  ],  "namespace": "string"}'
Example Response
null

Internal Kv List

GET
/internal/v1/instances/{instance_id}/entity-kv/list

Path Parameters

instance_id*Instance Id
Formatuuid

Query Parameters

customer_id*Customer Id
Formatuuid
namespace*Namespace

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-kv/list?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&namespace=string'
Example Response
null

Internal List Records

GET
/internal/v1/instances/{instance_id}/entity-records

Path Parameters

instance_id*Instance Id
Formatuuid

Query Parameters

customer_id*Customer Id
Formatuuid
definition_slug?string|null
definition_id?|null
status?string|null
tag?string|null
search?|

Full-text search via tsvector (indexed, requires searchable_fields on definition)

limit?Limit
Range1 <= value <= 200
Default50
offset?Offset
Range0 <= value
Default0

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-records?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
null

Internal Create Record

POST
/internal/v1/instances/{instance_id}/entity-records

Path Parameters

instance_id*Instance Id
Formatuuid

Request Body

application/json
  1. body
created_by?|null
customer_id*Customer Id
Formatuuid
data?
definition_id?|null
definition_slug?string|null
tags?array<string>|null

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-records' \  -H 'Content-Type: application/json' \  -d '{  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e"}'
Example Response
null

Internal Get Record

GET
/internal/v1/instances/{instance_id}/entity-records/{record_id}

Path Parameters

instance_id*Instance Id
Formatuuid
record_id*Record Id
Formatuuid

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-records/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
null

Internal Update Record

PATCH
/internal/v1/instances/{instance_id}/entity-records/{record_id}

Path Parameters

instance_id*Instance Id
Formatuuid
record_id*Record Id
Formatuuid

Request Body

application/json
  1. body
data?|null
status?|null
tags?array<string>|null

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X PATCH 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-records/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
null

Internal Delete Record

DELETE
/internal/v1/instances/{instance_id}/entity-records/{record_id}

Path Parameters

instance_id*Instance Id
Formatuuid
record_id*Record Id
Formatuuid

Response Body

Successful Response

Example Request
curl -X DELETE 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-records/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
Empty

Internal List Relationships

GET
/internal/v1/instances/{instance_id}/entity-relationships

Path Parameters

instance_id*Instance Id
Formatuuid

Query Parameters

record_id*Record Id

Find relationships for this record

Formatuuid
relationship_type?string|null
direction?Direction
Match^(from|to|both)$
Default"both"

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-relationships?record_id=497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
null

Internal Create Relationship

POST
/internal/v1/instances/{instance_id}/entity-relationships

Path Parameters

instance_id*Instance Id
Formatuuid

Request Body

application/json
  1. body
from_record_id*From Record Id
Formatuuid
metadata?|null
relationship_type*Relationship Type
Length1 <= length <= 50
to_record_id*To Record Id
Formatuuid

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-relationships' \  -H 'Content-Type: application/json' \  -d '{  "from_record_id": "970e0aa8-b390-4ddc-afe1-fb4fc01a08b0",  "relationship_type": "string",  "to_record_id": "248de304-16b0-46af-b270-faee1be109a5"}'
Example Response
null

Internal Delete Relationship

DELETE
/internal/v1/instances/{instance_id}/entity-relationships/{relationship_id}

Path Parameters

instance_id*Instance Id
Formatuuid
relationship_id*Relationship Id
Formatuuid

Response Body

Successful Response

Example Request
curl -X DELETE 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-relationships/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
Empty

Tenant List Definitions

GET
/v1/entity-definitions

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X GET 'https://example.com/v1/entity-definitions'
Example Response
null

Tenant Create Definition

POST
/v1/entity-definitions

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
color?|null
description?string|null
display_name*Display Name
Length1 <= length <= 200
field_sensitivity?|

field_name → standard|sensitive|restricted

icon?|null
schema?|null
searchable_fields?array<string>|null
slug*Slug
Match^[a-z][a-z0-9_]*$
Length1 <= length <= 100

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X POST 'https://example.com/v1/entity-definitions' \  -H 'Content-Type: application/json' \  -d '{  "display_name": "string",  "slug": "string"}'
Example Response
null

Tenant Update Definition

PATCH
/v1/entity-definitions/{definition_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

definition_id*Definition Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
color?|null
description?string|null
display_name?|null
field_sensitivity?|

field_name → standard|sensitive|restricted

icon?|null
schema?|null
searchable_fields?array<string>|null

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X PATCH 'https://example.com/v1/entity-definitions/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
null

Tenant Delete Definition

DELETE
/v1/entity-definitions/{definition_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

definition_id*Definition Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

Example Request
curl -X DELETE 'https://example.com/v1/entity-definitions/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
Empty

Tenant List Kv

GET
/v1/entity-kv

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Query Parameters

customer_id*Customer Id
Formatuuid
namespace?string|null

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X GET 'https://example.com/v1/entity-kv?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
null

Tenant List Records

GET
/v1/entity-records

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Query Parameters

customer_id?|null
definition_id?|null
status?string|null
limit?Limit
Range1 <= value <= 200
Default50
offset?Offset
Range0 <= value
Default0

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X GET 'https://example.com/v1/entity-records'
Example Response
null

End user portal internal

Previous Page

Evaluations

Next Page