Resources API endpoints

Resources are the primary objects in ErynoaGroup. Use these endpoints to create, retrieve, update, and delete resources in your workspace.

List resources

Retrieve a paginated list of all resources in your workspace.

GET /v1/resources

Query parameters:

string

Filter by resource status. One of: active, inactive, archived.

integer

Number of results per page. Default: 20. Maximum: 100.

string

Pagination cursor from a previous response’s links.next URL.

string

Sort field. Prefix with - for descending. Example: -created_at.

Example request:

curl -X GET "https://api.erynoa.group/v1/resources?status=active&per_page=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response:

{
  "data": [
    {
      "id": "res_01HX4K9Z2QBZJMFR5T6VWYP8D",
      "type": "resource",
      "status": "active",
      "name": "My Resource",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": { "total": 1, "page": 1, "per_page": 10 },
  "links": { "next": null, "prev": null }
}

Get a resource

Retrieve a single resource by its ID.

GET /v1/resources/{id}

Path parameters:

string

required

The unique identifier of the resource (e.g., res_01HX4K9Z2QBZJMFR5T6VWYP8D).

Example request:

curl -X GET https://api.erynoa.group/v1/resources/res_01HX4K9Z2QBZJMFR5T6VWYP8D \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response:

{
  "data": {
    "id": "res_01HX4K9Z2QBZJMFR5T6VWYP8D",
    "type": "resource",
    "status": "active",
    "name": "My Resource",
    "metadata": {},
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

Create a resource

Create a new resource in your workspace.

POST /v1/resources

Request body:

string

required

A human-readable name for the resource. Maximum 255 characters.

string

Resource type. One of: standard, advanced. Defaults to standard.

object

Up to 50 key-value pairs of custom metadata. Keys and values must be strings.

Example request:

curl -X POST https://api.erynoa.group/v1/resources \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: create-my-resource-001" \
  -d '{
    "name": "My New Resource",
    "type": "standard",
    "metadata": {
      "customer_id": "cust_789",
      "region": "us-east-1"
    }
  }'

Response: 201 Created

{
  "data": {
    "id": "res_01HX9P3NXVQMJRFT8K2BWYC7E",
    "type": "resource",
    "status": "active",
    "name": "My New Resource",
    "metadata": {
      "customer_id": "cust_789",
      "region": "us-east-1"
    },
    "created_at": "2024-01-15T11:00:00Z",
    "updated_at": "2024-01-15T11:00:00Z"
  }
}

Update a resource

Update an existing resource’s attributes.

PATCH /v1/resources/{id}

Path parameters:

string

required

The unique identifier of the resource to update.

Request body: (all fields optional — only include fields you want to update)

string

Updated name for the resource.

string

Updated status. One of: active, inactive, archived.

object

Updated metadata. This fully replaces the existing metadata object.

Example request:

curl -X PATCH https://api.erynoa.group/v1/resources/res_01HX4K9Z2QBZJMFR5T6VWYP8D \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "inactive"}'

Delete a resource

Permanently delete a resource. This action cannot be undone.

DELETE /v1/resources/{id}

Deleting a resource is permanent. Associated data is removed and cannot be recovered.

Path parameters:

string

required

The unique identifier of the resource to delete.

Example request:

curl -X DELETE https://api.erynoa.group/v1/resources/res_01HX4K9Z2QBZJMFR5T6VWYP8D \
  -H "Authorization: Bearer YOUR_API_KEY"

Response: 204 No Content

Overview

Endpoints

Resources API endpoints

List resources

Get a resource

Create a resource

Update a resource

Delete a resource

​List resources

​Get a resource

​Create a resource

​Update a resource

​Delete a resource

List resources

Get a resource

Create a resource

Update a resource

Delete a resource