Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Indykite Capture API

Capture REST API represents the service interface for data capture.

Indykite Capture API is one of 21 APIs that Indykite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Capture. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 7 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against 2 base URLs: https://eu.api.indykite.com/configs/v1, https://us.api.indykite.com/configs/v1.

7 operations 7 paths 22 schemas 7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
https://us.api.indykite.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Indykite Capture API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerToken). By default, every request must be authenticated.

  • BearerToken — Bearer token generated from Service Account credentials.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 POST. Each is listed below with its method, path, parameters, and response codes.

Capture 7

Capture REST API represents the service interface for data capture.

POST
/capture/v1/nodes
Batch node upsert endpoint
createCaptureV1Node body → 200400422500
POST
/capture/v1/nodes/delete
Batch node delete endpoint
createCaptureV1NodesDelete body → 200400422500
POST
/capture/v1/nodes/properties/delete
Batch node properties delete endpoint
createCaptureV1NodesPropertiesDelete body → 200400422500
POST
/capture/v1/nodes/properties/metadata/delete
Batch node properties metadata delete endpoint
createCaptureV1NodesPropertiesMetadataDelete body → 200400422500
POST
/capture/v1/relationships
Batch relationship upsert endpoint
createCaptureV1Relationship body → 200400422500
POST
/capture/v1/relationships/delete
Batch relationship delete endpoint
createCaptureV1RelationshipsDelete body → 200400422500
POST
/capture/v1/relationships/properties/delete
Batch relationship properties delete endpoint
createCaptureV1RelationshipsPropertiesDelete body → 200400422500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are capture.UpsertNode (6 properties), capture.DeleteRelationshipProperties (5 properties), capture.DeleteNodePropertyMetadata (5 properties), capture.Relationship (4 properties). Each schema is shown below with its type and property counts.

capture.DeleteNodePropertyMetadata
object
5 properties 4 required
capture.DeleteNode
object
3 properties 2 required
capture.DeleteNodePropertiesRequest
object
1 property 1 required
capture.Property
object
4 properties 1 required
capture.Result
object
1 property
capture.DeleteNodePropertyMetadataRequest
object
1 property 1 required
capture.DeleteNodesRequest
object
1 property 1 required
capture.PropertyValue
Value can be either string, integer, float, boolean, or an array of any of those types
capture.Metadata
object
4 properties
capture.DeleteNodeProperties
object
4 properties 3 required
capture.BatchResults
object
1 property
capture.UpsertRelationshipsRequest
object
2 properties 1 required
capture.DeleteRelationshipProperties
object
5 properties 4 required
capture.UpsertNode
object
6 properties 2 required
capture.DeleteRelationshipPropertiesRequest
object
2 properties 1 required
capture.DeleteRelationshipsRequest
object
2 properties 1 required
capture.Relationship
object
4 properties 3 required
capture.BaseProperty
object
3 properties 1 required
restapi.DetailedError
object
2 properties
restapi.ErrorResponse
object
1 property
capture.Node
object
3 properties 2 required
capture.UpsertNodesRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

indykite-capture-api-openapi.yml Raw ↑

Other APIs Indykite publishes across the network.

Indykite Application Agent Credentials API
Indykite Application Agents API
Indykite Applications API
Indykite Authorization Policies API
Indykite AuthZEN API
Indykite ContX IQ API
Indykite DataSchema API
Indykite Deprecated API
Indykite Entity Matching API
Indykite EntityMatching API
Indykite Event Sinks API
Indykite External Data Resolver API