Skip to content
Picogrid Legion

Create feed definition

Create feed definition

Open in ChatGPT ↗Open in Claude ↗
POST
/v3/feeds/definitions
curl --request POST \
  --url https://api.hopper.west.prod.govcloud.legion.picogrid.com/v3/feeds/definitions \
  --header 'Content-Type: application/json' \
  --data '{ "category": "MESSAGE", "data_type": "application/json", "description": "Temperature readings from IoT sensors", "entity_id": "c3d4e5f6-a1b2-7890-1234-567890abcdef", "feed_name": "temperature_readings", "integration_id": "e5f6a1b2-c3d4-7890-1234-567890abcdef", "is_active": true, "is_template": false, "metadata": {}, "schema_definition": {}, "template_id": "d4e5f6a1-b2c3-7890-1234-567890abcdef" }'

Creates a new feed definition

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
category
required
string
Allowed values: MESSAGE FILE
data_type
required
string
Example
application/json
description
string
Example
Temperature readings from IoT sensors
entity_id
string format: uuid
Example
c3d4e5f6-a1b2-7890-1234-567890abcdef
feed_name
required
string
Example
temperature_readings
integration_id
string format: uuid
Example
e5f6a1b2-c3d4-7890-1234-567890abcdef
is_active
required
boolean
Example
true
is_template
required
boolean
Example
false
metadata
object
schema_definition
object
template_id
string format: uuid
Example
d4e5f6a1-b2c3-7890-1234-567890abcdef

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
category
required
string
Allowed values: MESSAGE FILE
created_at
required
string
data_type
required
string
description
string
entity_id
string format: uuid
feed_name
required
string
id
required
string format: uuid
integration_id
string format: uuid
is_active
required
boolean
is_template
required
boolean
metadata
object
organization_id
required
string format: uuid
schema_definition
object
template_id
string format: uuid
updated_at
required
string
Example
{
  "category": "MESSAGE",
  "created_at": "2023-12-15T14:30:00Z",
  "data_type": "application/json",
  "description": "Real-time sensor telemetry data from field devices",
  "entity_id": "e5f6a1b2-c3d4-7890-1234-567890abcdef",
  "feed_name": "sensor_telemetry",
  "id": "d5e6f7a8-b9c0-1d2e-3f4a-5b6c7d8e9f0a",
  "integration_id": "d4e5f6a1-b2c3-7890-1234-567890abcdef",
  "is_active": "true",
  "is_template": "false",
  "metadata": {
    "processing_pipeline": "temperature_normalization",
    "retention_policy": "30d",
    "source": "IoT Gateway",
    "update_frequency": "5s"
  },
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "schema_definition": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "properties": {
      "humidity": {
        "description": "Humidity percentage",
        "maximum": 100,
        "minimum": 0,
        "type": "number"
      },
      "temperature": {
        "description": "Temperature in Celsius",
        "maximum": 100,
        "minimum": -50,
        "type": "number"
      },
      "timestamp": {
        "description": "Measurement timestamp",
        "format": "date-time",
        "type": "string"
      }
    },
    "required": [
      "temperature",
      "humidity",
      "timestamp"
    ],
    "type": "object"
  },
  "template_id": "f47ac10b-58cc-4372-a567-0e02b2c3d480",
  "updated_at": "2023-12-15T14:30:00Z"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
  "code": 400,
  "details": [
    {
      "Field": "organization_id",
      "Issue": "must be a valid UUID format"
    }
  ],
  "message": "Request cannot be processed due to invalid input",
  "status": "error",
  "timestamp": "2026-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
  "code": 401,
  "details": [
    {
      "Field": "authorization_header",
      "Issue": "Bearer token is expired or malformed"
    }
  ],
  "message": "Authentication credentials are missing or invalid",
  "status": "error",
  "timestamp": "2026-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
  "code": 403,
  "details": [
    {
      "Field": "required_scope",
      "Issue": "requires 'orion:settings:write' scope, but token only has 'orion:settings:read'"
    }
  ],
  "message": "Access denied: insufficient permissions for this resource",
  "status": "error",
  "timestamp": "2026-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
  "code": 409,
  "details": [
    {
      "field": "email",
      "issue": "must be a valid email address"
    }
  ],
  "message": "Request conflicts with current state of the resource",
  "status": "error",
  "timestamp": "2026-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

422

Section titled “422”

Unprocessable Entity

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
  "code": 422,
  "details": [
    {
      "field": "email",
      "issue": "must be a valid email address"
    }
  ],
  "message": "Request data is well-formed but violates business rules",
  "status": "error",
  "timestamp": "2026-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
category
required

The category of the error

string
code
required

The HTTP status code

number
details

Additional details about the error

Array<object>
object
field

The field that caused the error

string
issue

The specific issue with the field

string
message
required

A human-readable error message

string
status
required

The status of the response, always ‘error’ for error responses

string
timestamp
required

The timestamp when the error occurred

string format: date-time
trace_id
required

A unique identifier for tracing the error

string format: uuid
Example
{
  "category": "server_error",
  "code": 500,
  "details": [
    {
      "field": "field_name",
      "issue": "Field validation issue"
    }
  ],
  "message": "Internal Server Error",
  "status": "error",
  "timestamp": "2024-03-15T10:30:00Z",
  "trace_id": "b7c5e4d3-a2b1-4f0e-8d9c-1a2b3c4d5e6f"
}

Version 3.14.0 · commit 0771262