Node

post

Authorizations

authorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Body

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

post

/gateway/v1/deserialize-nodes

POST /gateway/v1/deserialize-nodes HTTP/1.1
Host: p01-api.observo.ai
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1637

{
  "serializedNodes": [
    {
      "source": {
        "id": 1,
        "siteId": 1,
        "templateId": 1,
        "templateVersion": 1,
        "templateName": "text",
        "name": "text",
        "description": "text",
        "config": {},
        "status": "NS_DEFAULT",
        "created": "2025-11-29T17:41:58.865Z",
        "updated": "2025-11-29T17:41:58.865Z",
        "createdBy": "text",
        "updatedBy": "text",
        "type": "DEFAULT_TYPE",
        "origin": "NODE_ORIGIN_DEFAULT",
        "archivalInfo": {
          "sinkId": 1,
          "sinkName": "text",
          "sinkType": "DEFAULT_TYPE",
          "pipelineId": 1,
          "pipelineName": "text",
          "pipelineStatus": "DEFAULT"
        },
        "logFormat": "LOG_FORMAT_UNSPECIFIED",
        "preprocessorConfig": {},
        "port": 1,
        "pushBased": true,
        "pushSourceAddress": "text",
        "k8sInternalSvcUrl": "text",
        "siteFilenames": [
          "text"
        ],
        "sourceConfigs": [
          {
            "id": 1,
            "sourceId": 1,
            "templateId": 1,
            "templateName": "text",
            "category": "DEFAULT",
            "config": {},
            "position": 1,
            "templateVersion": 1
          }
        ],
        "userVisible": true
      },
      "transform": {
        "id": 1,
        "siteId": 1,
        "templateId": 1,
        "templateVersion": 1,
        "name": "text",
        "description": "text",
        "pipelineId": 1,
        "config": {},
        "status": "NS_DEFAULT",
        "created": "2025-11-29T17:41:58.865Z",
        "updated": "2025-11-29T17:41:58.865Z",
        "createdBy": "text",
        "updatedBy": "text",
        "isTransformGroup": true,
        "origin": "NODE_ORIGIN_DEFAULT",
        "templateName": "text",
        "processorType": "PROCESSOR_TYPE_UNSPECIFIED",
        "siteFilenames": [
          "text"
        ],
        "userVisible": true
      },
      "sink": {
        "id": 1,
        "siteId": 1,
        "templateId": 1,
        "templateVersion": 1,
        "templateName": "text",
        "name": "text",
        "description": "text",
        "config": {},
        "status": "NS_DEFAULT",
        "sourceId": 1,
        "created": "2025-11-29T17:41:58.865Z",
        "updated": "2025-11-29T17:41:58.865Z",
        "createdBy": "text",
        "updatedBy": "text",
        "type": "DEFAULT_TYPE",
        "origin": "NODE_ORIGIN_DEFAULT",
        "usageType": "UNSPECIFIED",
        "siteFilenames": [
          "text"
        ],
        "userVisible": true
      }
    }
  ]
}

{
  "nodes": [
    {
      "source": {
        "id": 1,
        "siteId": 1,
        "templateId": 1,
        "templateVersion": 1,
        "templateName": "text",
        "name": "text",
        "description": "text",
        "config": {},
        "status": "NS_DEFAULT",
        "created": "2025-11-29T17:41:58.865Z",
        "updated": "2025-11-29T17:41:58.865Z",
        "createdBy": "text",
        "updatedBy": "text",
        "type": "DEFAULT_TYPE",
        "origin": "NODE_ORIGIN_DEFAULT",
        "archivalInfo": {
          "sinkId": 1,
          "sinkName": "text",
          "sinkType": "DEFAULT_TYPE",
          "pipelineId": 1,
          "pipelineName": "text",
          "pipelineStatus": "DEFAULT"
        },
        "logFormat": "LOG_FORMAT_UNSPECIFIED",
        "preprocessorConfig": {},
        "port": 1,
        "pushBased": true,
        "pushSourceAddress": "text",
        "k8sInternalSvcUrl": "text",
        "siteFilenames": [
          "text"
        ],
        "sourceConfigs": [
          {
            "id": 1,
            "sourceId": 1,
            "templateId": 1,
            "templateName": "text",
            "category": "DEFAULT",
            "config": {},
            "position": 1,
            "templateVersion": 1
          }
        ],
        "userVisible": true
      },
      "transform": {
        "id": 1,
        "siteId": 1,
        "templateId": 1,
        "templateVersion": 1,
        "name": "text",
        "description": "text",
        "pipelineId": 1,
        "config": {},
        "status": "NS_DEFAULT",
        "created": "2025-11-29T17:41:58.865Z",
        "updated": "2025-11-29T17:41:58.865Z",
        "createdBy": "text",
        "updatedBy": "text",
        "isTransformGroup": true,
        "origin": "NODE_ORIGIN_DEFAULT",
        "templateName": "text",
        "processorType": "PROCESSOR_TYPE_UNSPECIFIED",
        "siteFilenames": [
          "text"
        ],
        "userVisible": true
      },
      "sink": {
        "id": 1,
        "siteId": 1,
        "templateId": 1,
        "templateVersion": 1,
        "templateName": "text",
        "name": "text",
        "description": "text",
        "config": {},
        "status": "NS_DEFAULT",
        "sourceId": 1,
        "created": "2025-11-29T17:41:58.865Z",
        "updated": "2025-11-29T17:41:58.865Z",
        "createdBy": "text",
        "updatedBy": "text",
        "type": "DEFAULT_TYPE",
        "origin": "NODE_ORIGIN_DEFAULT",
        "usageType": "UNSPECIFIED",
        "siteFilenames": [
          "text"
        ],
        "userVisible": true
      }
    }
  ],
  "status": {
    "code": "OK",
    "errorMessage": "text",
    "userMessageCode": "DEFAULT"
  }
}

List all node names, filtered based on site ids and node type and status. If node type and node status are empty, it will consider all possible values of these inputs. This API is not paginated.

get

Get all node names used in the pipeline graphs.

Authorizations

authorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Query parameters

siteIdinteger · uint64Optional

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

/gateway/v1/node-names

GET /gateway/v1/node-names HTTP/1.1
Host: p01-api.observo.ai
authorization: YOUR_API_KEY
Accept: */*

{
  "nodeNames": [
    {
      "id": 1,
      "name": "text",
      "nodeType": "NODE_TYPE_DEFAULT",
      "nodeStatus": "NS_DEFAULT"
    }
  ],
  "status": {
    "code": "OK",
    "errorMessage": "text",
    "userMessageCode": "DEFAULT"
  }
}

List all nodes, filtered based on node_ids. This API is paginated and returns values [offset, offset + page_size). Node ids are unique across sources, sinks and transforms. Node's config is returned if include_config is set.

get

Retrieve metadata for available pipeline nodes.

Authorizations

authorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Query parameters

nodeIdsinteger · uint64[]Optional

includeConfigbooleanOptional

Whether to include config in return value.

pagination.offsetinteger · int64Optional

pagination.limitinteger · int64Optional

pagination.totalCountinteger · int64Optional

pagination.ordering.fieldNamestringOptional

pagination.ordering.descendingbooleanOptional

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

/gateway/v1/nodes

GET /gateway/v1/nodes HTTP/1.1
Host: p01-api.observo.ai
authorization: YOUR_API_KEY
Accept: */*

{
  "status": {
    "code": "OK",
    "errorMessage": "text",
    "userMessageCode": "DEFAULT"
  },
  "nodes": {
    "ANY_ADDITIONAL_PROPERTY": {
      "source": {
        "id": 1,
        "siteId": 1,
        "templateId": 1,
        "templateVersion": 1,
        "templateName": "text",
        "name": "text",
        "description": "text",
        "config": {},
        "status": "NS_DEFAULT",
        "created": "2025-11-29T17:41:58.865Z",
        "updated": "2025-11-29T17:41:58.865Z",
        "createdBy": "text",
        "updatedBy": "text",
        "type": "DEFAULT_TYPE",
        "origin": "NODE_ORIGIN_DEFAULT",
        "archivalInfo": {
          "sinkId": 1,
          "sinkName": "text",
          "sinkType": "DEFAULT_TYPE",
          "pipelineId": 1,
          "pipelineName": "text",
          "pipelineStatus": "DEFAULT"
        },
        "logFormat": "LOG_FORMAT_UNSPECIFIED",
        "preprocessorConfig": {},
        "port": 1,
        "pushBased": true,
        "pushSourceAddress": "text",
        "k8sInternalSvcUrl": "text",
        "siteFilenames": [
          "text"
        ],
        "sourceConfigs": [
          {
            "id": 1,
            "sourceId": 1,
            "templateId": 1,
            "templateName": "text",
            "category": "DEFAULT",
            "config": {},
            "position": 1,
            "templateVersion": 1
          }
        ],
        "userVisible": true
      },
      "transform": {
        "id": 1,
        "siteId": 1,
        "templateId": 1,
        "templateVersion": 1,
        "name": "text",
        "description": "text",
        "pipelineId": 1,
        "config": {},
        "status": "NS_DEFAULT",
        "created": "2025-11-29T17:41:58.865Z",
        "updated": "2025-11-29T17:41:58.865Z",
        "createdBy": "text",
        "updatedBy": "text",
        "isTransformGroup": true,
        "origin": "NODE_ORIGIN_DEFAULT",
        "templateName": "text",
        "processorType": "PROCESSOR_TYPE_UNSPECIFIED",
        "siteFilenames": [
          "text"
        ],
        "userVisible": true
      },
      "sink": {
        "id": 1,
        "siteId": 1,
        "templateId": 1,
        "templateVersion": 1,
        "templateName": "text",
        "name": "text",
        "description": "text",
        "config": {},
        "status": "NS_DEFAULT",
        "sourceId": 1,
        "created": "2025-11-29T17:41:58.865Z",
        "updated": "2025-11-29T17:41:58.865Z",
        "createdBy": "text",
        "updatedBy": "text",
        "type": "DEFAULT_TYPE",
        "origin": "NODE_ORIGIN_DEFAULT",
        "usageType": "UNSPECIFIED",
        "siteFilenames": [
          "text"
        ],
        "userVisible": true
      }
    }
  },
  "pagination": {
    "offset": 1,
    "limit": 1,
    "totalCount": 1,
    "ordering": {
      "fieldName": "text",
      "descending": true
    }
  }
}

get

Download the serialized node structure.

Authorizations

authorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Query parameters

siteIdinteger · uint64Optional

nodeIdsinteger · uint64[]Optional

ID here represents the ID of the component in DB.

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

/gateway/v1/serialize-nodes

GET /gateway/v1/serialize-nodes HTTP/1.1
Host: p01-api.observo.ai
authorization: YOUR_API_KEY
Accept: */*

{
  "serializedNodes": [
    {
      "source": {
        "id": 1,
        "siteId": 1,
        "templateId": 1,
        "templateVersion": 1,
        "templateName": "text",
        "name": "text",
        "description": "text",
        "config": {},
        "status": "NS_DEFAULT",
        "created": "2025-11-29T17:41:58.865Z",
        "updated": "2025-11-29T17:41:58.865Z",
        "createdBy": "text",
        "updatedBy": "text",
        "type": "DEFAULT_TYPE",
        "origin": "NODE_ORIGIN_DEFAULT",
        "archivalInfo": {
          "sinkId": 1,
          "sinkName": "text",
          "sinkType": "DEFAULT_TYPE",
          "pipelineId": 1,
          "pipelineName": "text",
          "pipelineStatus": "DEFAULT"
        },
        "logFormat": "LOG_FORMAT_UNSPECIFIED",
        "preprocessorConfig": {},
        "port": 1,
        "pushBased": true,
        "pushSourceAddress": "text",
        "k8sInternalSvcUrl": "text",
        "siteFilenames": [
          "text"
        ],
        "sourceConfigs": [
          {
            "id": 1,
            "sourceId": 1,
            "templateId": 1,
            "templateName": "text",
            "category": "DEFAULT",
            "config": {},
            "position": 1,
            "templateVersion": 1
          }
        ],
        "userVisible": true
      },
      "transform": {
        "id": 1,
        "siteId": 1,
        "templateId": 1,
        "templateVersion": 1,
        "name": "text",
        "description": "text",
        "pipelineId": 1,
        "config": {},
        "status": "NS_DEFAULT",
        "created": "2025-11-29T17:41:58.865Z",
        "updated": "2025-11-29T17:41:58.865Z",
        "createdBy": "text",
        "updatedBy": "text",
        "isTransformGroup": true,
        "origin": "NODE_ORIGIN_DEFAULT",
        "templateName": "text",
        "processorType": "PROCESSOR_TYPE_UNSPECIFIED",
        "siteFilenames": [
          "text"
        ],
        "userVisible": true
      },
      "sink": {
        "id": 1,
        "siteId": 1,
        "templateId": 1,
        "templateVersion": 1,
        "templateName": "text",
        "name": "text",
        "description": "text",
        "config": {},
        "status": "NS_DEFAULT",
        "sourceId": 1,
        "created": "2025-11-29T17:41:58.865Z",
        "updated": "2025-11-29T17:41:58.865Z",
        "createdBy": "text",
        "updatedBy": "text",
        "type": "DEFAULT_TYPE",
        "origin": "NODE_ORIGIN_DEFAULT",
        "usageType": "UNSPECIFIED",
        "siteFilenames": [
          "text"
        ],
        "userVisible": true
      }
    }
  ],
  "status": {
    "code": "OK",
    "errorMessage": "text",
    "userMessageCode": "DEFAULT"
  }
}

PreviousRelease Notes NextPipeline

Last updated 4 months ago

Was this helpful?