HTTP API Reference

The Base URL used in this documentation is https://kurrent.io, you should replace it with the same url you use to view the administration UI.

Authentication

• HTTP Authentication, scheme: basic

Streams

Endpoints for Stream operations

Read a stream

Code samples

# You can also use wget
curl -X GET https://kurrent.io/streams/{stream}

GET /streams/{stream}Read a stream

Read a stream, receiving a standard AtomFeed document as a response.

Parameters

Enumerated Values

Responses

Append to a stream

Code samples

# You can also use wget
curl -X POST https://kurrent.io/streams/{stream} \
  -H 'Content-Type: application/json' \
  -H 'Kurrent-ExpectedVersion: 0' \
  -H 'Kurrent-EventType: string' \
  -H 'Kurrent-EventId: 0' \
  -H 'Kurrent-RequireLeader: true'

POST /streams/{stream}Append to a stream

Append to a stream.

Body parameter

{
  "body": {}
}

Parameters

Responses

Delete a stream

Code samples

# You can also use wget
curl -X DELETE https://kurrent.io/streams/{stream}

DELETE /streams/{stream}Deletes a stream

Delete specified stream

Parameters

Responses

Alternative stream URL

Code samples

# You can also use wget
curl -X POST https://kurrent.io/streams/{stream}/incoming/{guid}

POST /streams/{stream}/incoming/{guid}An alternative URL to post events to

A URL generated by KurrentDB if you don't supply an ID when creating a stream. You then post events to this URL.

Parameters

Responses

Read stream event

Code samples

# You can also use wget
curl -X GET https://kurrent.io/streams/{stream}/{event}

GET /streams/{stream}/{event}Read a stream event

Reads a single event from a stream.

Parameters

Enumerated Values

Responses

Get {n} events

Code samples

# You can also use wget
curl -X GET https://kurrent.io/streams/{stream}/{event}/{count}

GET /streams/{stream}/{event}/{count}Paginate backwards through stream events

Paginate backwards though stream events by a specified amount.

Parameters

Enumerated Values

Responses

Page back through events

Code samples

# You can also use wget
curl -X GET https://kurrent.io/streams/{stream}/{event}/backward/{count}

GET /streams/{stream}/{event}/backward/{count}Paginate backwards through stream events

Paginate backwards though stream events by a specified amount.

Parameters

Enumerated Values

Responses

Page forward through events

Code samples

# You can also use wget
curl -X GET https://kurrent.io/streams/{stream}/{event}/forward/{count}

GET /streams/{stream}/{event}/forward/{count}Paginate forwards through stream events

Paginate forwards though stream events by a specified amount.

Parameters

Enumerated Values

Responses

Read stream metadata

Code samples

# You can also use wget
curl -X GET https://kurrent.io/streams/{stream}/metadata

GET /streams/{stream}/metadataReads the metadata of a stream

Returns metadata of a stream, typically information associated with an event that is not part of the event.

Parameters

Enumerated Values

Responses

Update stream metadata

Code samples

# You can also use wget
curl -X POST https://kurrent.io/streams/{stream}/metadata \
  -H 'Content-Type: application/json'

POST /streams/{stream}/metadataUpdate stream metadata

Update the metadata of a stream.

Body parameter

{
  "eventId": "string",
  "eventType": "string",
  "data": {
    "maxAge": 0,
    "maxCount": 0,
    "truncateBefore": 0,
    "cacheControl": "string",
    "acl": {
      "r": "string",
      "w": "string",
      "d": "string",
      "mr": "string",
      "mw": "string"
    }
  }
}

Parameters

Responses

Get all events

Code samples

# You can also use wget
curl -X GET https://kurrent.io/streams/$all

GET /streams/$allReturns all events from all streams

Returns all events from all streams, you must provide user details.

Parameters

Enumerated Values

Responses

Subscriptions

Endpoints for Subscription operations

Get all subscriptions

Code samples

# You can also use wget
curl -X GET https://kurrent.io/subscriptions

GET /subscriptionsGet information for all subscriptions

Returns all subscriptions from all streams.

Responses

Get subscription stream information

Code samples

# You can also use wget
curl -X GET https://kurrent.io/subscriptions/{stream}

GET /subscriptions/{stream}Returns information about the subscriptions for a stream

Needed

Parameters

Responses

Get subscription information

Code samples

# You can also use wget
curl -X GET https://kurrent.io/subscriptions/{stream}/{subscription}/info

GET /subscriptions/{stream}/{subscription}/infoReads stream information via a persistent subscription

Needed

Parameters

Responses

Get a stream

Code samples

# You can also use wget
curl -X GET https://kurrent.io/subscriptions/{stream}/{subscription}

GET /subscriptions/{stream}/{subscription}Read a stream

Read a specified stream by a persistent subscription.

Parameters

Enumerated Values

Responses

Update subscription

Code samples

# You can also use wget
curl -X POST https://kurrent.io/subscriptions/{stream}/{subscription} \
  -H 'Content-Type: application/json'

POST /subscriptions/{stream}/{subscription}Update a persistant subscription

You can edit the settings of an existing subscription while it is running. This will drop the current subscribers and will reset the subscription internally.

Body parameter

{
  "minCheckPointCount": 2,
  "startFrom": 0,
  "ResolveLinkTos": true,
  "readBatchSize": 5,
  "namedConsumerStrategy": "RoundRobin",
  "extraStatistics": true,
  "maxRetryCount": 7,
  "liveBufferSize": 1,
  "messageTimeoutMilliseconds": 3,
  "maxCheckPointCount": 2,
  "maxSubscriberCount": 9,
  "checkPointAfterMilliseconds": 6,
  "bufferSize": 5
}

Parameters

Responses

Create subscription

Code samples

# You can also use wget
curl -X PUT https://kurrent.io/subscriptions/{stream}/{subscription} \
  -H 'Content-Type: application/json'

PUT /subscriptions/{stream}/{subscription}Create a persistent subscription

Before interacting with a subscription group, you need to create one. You will receive an error if you attempt to create a subscription group more than once. This requires admin permissions.

Body parameter

{
  "minCheckPointCount": 2,
  "startFrom": 0,
  "ResolveLinkTos": true,
  "readBatchSize": 5,
  "namedConsumerStrategy": "RoundRobin",
  "extraStatistics": true,
  "maxRetryCount": 7,
  "liveBufferSize": 1,
  "messageTimeoutMilliseconds": 3,
  "maxCheckPointCount": 2,
  "maxSubscriberCount": 9,
  "checkPointAfterMilliseconds": 6,
  "bufferSize": 5
}

Parameters

Responses

Delete subscription

Code samples

# You can also use wget
curl -X DELETE https://kurrent.io/subscriptions/{stream}/{subscription}

DELETE /subscriptions/{stream}/{subscription}Deletes a subscription

Deletes a subscription

Parameters

Responses

Get {n} subscription events

Code samples

# You can also use wget
curl -X GET https://kurrent.io/subscriptions/{stream}/{subscription}/{count}

GET /subscriptions/{stream}/{subscription}/{count}Reads a stream via a persistent subscription and return a specific number of events

Reads a stream via a persistent subscription and return a specific number of events

Parameters

Enumerated Values

Responses

Acknowledge a single message

Code samples

# You can also use wget
curl -X POST https://kurrent.io/subscriptions/{stream}/{subscription}/ack/{messageid}

POST /subscriptions/{stream}/{subscription}/ack/{messageid}Acknowledge a single message

Clients must acknowledge (or not acknowledge) messages in the competing consumer model. If the client fails to respond in the given timeout period, the message will be retried. You should use the rel links in the feed for acknowledgements not bookmark URIs as they are subject to change in future versions.

Parameters

Responses

Acknowledge multiple messages

Code samples

# You can also use wget
curl -X POST https://kurrent.io/subscriptions/{stream}/{subscription}/ack

POST /subscriptions/{stream}/{subscription}/ackAcknowledge multiple messages

Clients must acknowledge (or not acknowledge) messages in the competing consumer model. If the client fails to respond in the given timeout period, the message will be retried. You should use the rel links in the feed for acknowledgements not bookmark URIs as they are subject to change in future versions.

Parameters

Responses

Don't acknowledge a single message

Code samples

# You can also use wget
curl -X POST https://kurrent.io/subscriptions/{stream}/{subscription}/nack/{messageid}

POST /subscriptions/{stream}/{subscription}/nack/{messageid}Negative acknowledge a single message

Clients must acknowledge (or not acknowledge) messages in the competing consumer model. If the client fails to respond in the given timeout period, the message will be retried. You should use the rel links in the feed for acknowledgements not bookmark URIs as they are subject to change in future versions.

Parameters

Enumerated Values

Responses

Don't acknowledge multiple messages

Code samples

# You can also use wget
curl -X POST https://kurrent.io/subscriptions/{stream}/{subscription}/nack

POST /subscriptions/{stream}/{subscription}/nackNegative acknowledge multiple messages

Clients must acknowledge (or not acknowledge) messages in the competing consumer model. If the client fails to respond in the given timeout period, the message will be retried. You should use the rel links in the feed for acknowledgements not bookmark URIs as they are subject to change in future versions.

Parameters

Enumerated Values

Responses

Replay previously parked messages

Code samples

# You can also use wget
curl -X POST https://kurrent.io/subscriptions/{stream}/{subscription}/replayParked

POST /subscriptions/{stream}/{subscription}/replayParkedReplay any previously parked messages in a stream

Replay any previously parked messages in a stream that were parked by a negative acknowledgement action.

Parameters

Responses

Projections

Endpoints for Projection operations

Get all projections

Code samples

# You can also use wget
curl -X GET https://kurrent.io/projections/any

GET /projections/anyGet all projections

Returns all projections defined in KurrentDB.

Responses

Get all non-transient projections

Code samples

# You can also use wget
curl -X GET https://kurrent.io/projections/all-non-transient

GET /projections/all-non-transientGet all non-transient projections

Returns all known projections except ad-hoc projections.

Responses

Get all queries

Code samples

# You can also use wget
curl -X GET https://kurrent.io/projections/onetime

GET /projections/onetimeGet all queries

Returns all queries defined in KurrentDB.

Responses

Create a onetime projection

Code samples

# You can also use wget
curl -X POST https://kurrent.io/projections/onetime

POST /projections/onetimeCreate a onetime projection

Create a new onetime projection.

Parameters

Enumerated Values

Responses

Get all continious projections

Code samples

# You can also use wget
curl -X GET https://kurrent.io/projections/continuous

GET /projections/continuousGet all continious projections

Returns all continually running projections defined in KurrentDB.

Responses

Create a continuous projection

Code samples

# You can also use wget
curl -X POST https://kurrent.io/projections/continuous

POST /projections/continuousCreate a continious projection

Create a new continious projection.

Parameters

Enumerated Values

Responses

Read projection events based on a query

Code samples

# You can also use wget
curl -X POST https://kurrent.io/projections/read-events

POST /projections/read-eventsRead events from projection based on a query definition

Read events from projection based on a query definition, i.e. fromAll, fromStream, fromStreams

Responses

Get all transient projections

Code samples

# You can also use wget
curl -X GET https://kurrent.io/projections/transient

GET /projections/transientGet all transient projections

Returns all transient projections defined in KurrentDB.

Responses

Create a transient projection

Code samples

# You can also use wget
curl -X POST https://kurrent.io/projections/transient

POST /projections/transientCreate a transient projection

Create a new transient projection.

Parameters

Enumerated Values

Responses

Get projection definition

Code samples

# You can also use wget
curl -X GET https://kurrent.io/projection/{name}/query

GET /projection/{name}/queryGet projection definition

Returns definition of the specified projection.

Parameters

Responses

Update projection definition

Code samples

# You can also use wget
curl -X PUT https://kurrent.io/projection/{name}/query

PUT /projection/{name}/queryUpdate projection definition

Update the specified projection definition.

Parameters

Enumerated Values

Responses

Get the projection state

Code samples

# You can also use wget
curl -X GET https://kurrent.io/projection/{name}/state

GET /projection/{name}/stateGet the projection state

Return the current state of the specified projection.

Parameters

Responses

Get result of projection

Code samples

# You can also use wget
curl -X GET https://kurrent.io/projection/{name}/result

GET /projection/{name}/resultGet result of projection

Get the final result of a projection.

Parameters

Responses

Get projection statistics

Code samples

# You can also use wget
curl -X GET https://kurrent.io/projection/{name}/statistics

GET /projection/{name}/statisticsGet projection statistics

Returns the statistics for a projection, such as how many events, the status etc.

Parameters

Responses

Disable projection

Code samples

# You can also use wget
curl -X POST https://kurrent.io/projection/{name}/command/disable

POST /projection/{name}/command/disableDisable projection

Disable the specified projection.

Parameters

Responses

Enable projection

Code samples

# You can also use wget
curl -X POST https://kurrent.io/projection/{name}/command/enable

POST /projection/{name}/command/enableEnable projection

Enable the specified projection.

Parameters

Responses

Reset projection

Code samples

# You can also use wget
curl -X POST https://kurrent.io/projection/{name}/command/reset

POST /projection/{name}/command/resetReset projection

Reset the specified projection.

Parameters

Responses

Abort projection

Code samples

# You can also use wget
curl -X POST https://kurrent.io/projection/{name}/command/abort

POST /projection/{name}/command/abortAbort projection

Abort the specified projection.

Parameters

Responses

Get projection config

Code samples

# You can also use wget
curl -X GET https://kurrent.io/projection/{name}/config

GET /projection/{name}/configGet the config of a projection

Returns the performance configuration of the specified projection.

Parameters

Responses

Update projection config

Code samples

# You can also use wget
curl -X PUT https://kurrent.io/projection/{name}/config

PUT /projection/{name}/configUpdate the config of a projection

Update the performance configuration of the specified projection.

Parameters

Responses

Get a projection

Code samples

# You can also use wget
curl -X GET https://kurrent.io/projection/{name}

GET /projection/{name}Get a projection

Returns a specific projection.

Parameters

Responses

Delete a projection

Code samples

# You can also use wget
curl -X DELETE https://kurrent.io/projection/{name}

DELETE /projection/{name}Deletes a projection

Deletes a projection

Parameters

Responses

Admin

Endpoints for Admin operations

Shutdown a node

Code samples

# You can also use wget
curl -X POST https://kurrent.io/admin/shutdown

POST /admin/shutdownShutdown a node

Issues a shut down command to a node.

Responses

Resigning a leader

Issue a resign command to the Leader node which will explicitly start a round of elections:

curl -X POST -d {} https://{leader_address}:2113/admin/node/resign -u admin:changeit

Note: The resigned leader node automatically has reduced priority in the elections, but it is still possible that the same node will be elected leader again.

Scavenge a node

Code samples

# You can also use wget
curl -X POST https://kurrent.io/admin/scavenge

POST /admin/scavengeScavenge a node

Scavenge reclaims disk space by rewriting database chunks, minus the events to delete, and then deleting the old chunks.

Parameters

Responses

Stop a scavenge

Code samples

# You can also use wget
curl -X DELETE https://kurrent.io/admin/scavenge/{scavengeId}

DELETE /admin/scavenge/{scavengeId}Stop a scavenge operation

Stop a running scavenge operation.

Parameters

Responses

Merge Indexes

Code samples

# You can also use wget
curl -X POST -d{} https://kurrent.io/admin/mergeindexes

POST /admin/mergeindexesMerge indexes

Manually merge indexes after a scavenge operation

Responses

Info

Endpoints for Info operations

Get info for node

Code samples

# You can also use wget
curl -X GET https://kurrent.io/info

GET /infoGet info for node

Returns information about node.

Responses

Get configuration for node

Code samples

# You can also use wget
curl -X GET https://kurrent.io/info/options

GET /info/optionsGet configuration for node

Returns configuration details about node.

Responses

Users

Endpoints for User operations

Get all users

Code samples

# You can also use wget
curl -X GET https://kurrent.io/users/

GET /users/Get all users

Returns all users defined in KurrentDB.

Responses

Create a user

Code samples

# You can also use wget
curl -X POST https://kurrent.io/users/ \
  -H 'Content-Type: application/json'

POST /users/Create a User

Create a new user.

Body parameter

{
  "LoginName": "admin",
  "FullName": "KurrentDB Admin",
  "Groups": [
    "Admin",
    "DataScience"
  ],
  "Password": "aVerySecurePassword"
}

Parameters

Responses

Get a user

Code samples

# You can also use wget
curl -X GET https://kurrent.io/users/{login}

GET /users/{login}Get user

Returns the user currently authenticated with the API, or the user specified.

Parameters

Responses

Update a user

Code samples

# You can also use wget
curl -X PUT https://kurrent.io/users/{login} \
  -H 'Content-Type: application/json'

PUT /users/{login}Update specified user

Update the FullName of Groups of the specified user.

Body parameter

{
  "FullName": "KurrentDB Admin",
  "Groups": [
    "Admin",
    "DataScience"
  ]
}

Parameters

Responses

Delete a user

Code samples

# You can also use wget
curl -X DELETE https://kurrent.io/users/{login}

DELETE /users/{login}Deletes a user

Delete specified user.

Parameters

Responses

Enable a user

Code samples

# You can also use wget
curl -X PUT https://kurrent.io/users/{login}/command/enable

PUT /users/{login}/command/enableEnable the specified user

Enable the acount of the specified user.

Parameters

Responses

Disable a user

Code samples

# You can also use wget
curl -X PUT https://kurrent.io/users/{login}/command/disable

PUT /users/{login}/command/disableDisable the specified user

Disable the acount of the specified user.

Parameters

Responses

Reset password

Code samples

# You can also use wget
curl -X POST https://kurrent.io/users/{login}/command/reset-password \
  -H 'Content-Type: application/json'

POST /users/{login}/command/reset-passwordReset user password

Reset the password of the specified user.

Body parameter

{
  "NewPassword": "aNewSecurePassword"
}

Parameters

Responses

Change password

Code samples

# You can also use wget
curl -X POST https://kurrent.io/users/{login}/command/change-password \
  -H 'Content-Type: application/json'

POST /users/{login}/command/change-passwordChange user password

Change the password of the specified user.

Body parameter

{
  "CurrentPassword": "anOldSecurePassword",
  "NewPassword": "aNewSecurePassword"
}

Parameters

Responses

Stats

Endpoints for Statistics operations.

Get all stats

Code samples

# You can also use wget
curl -X GET https://kurrent.io/stats \
  -H 'Accept: application/json'

GET /statsGet all stats

Returns all stats enabled for KurrentDB.

Example responses

200 Response

{
  "proc": {
    "startTime": "string",
    "id": 0,
    "mem": 0,
    "cpu": 0,
    "cpuScaled": 0,
    "threadsCount": 0,
    "contentionsRate": 0,
    "thrownExceptionsRate": 0,
    "gc": {
      "allocationSpeed": 0,
      "gen0ItemsCount": 0,
      "gen0Size": 0,
      "gen1ItemsCount": 0,
      "gen1Size": 0,
      "gen2ItemsCount": 0,
      "gen2Size": 0,
      "largeHeapSize": 0,
      "timeInGc": 0,
      "totalBytesInHeaps": 0
    },
    "diskIo": {
      "readBytes": 0,
      "writtenBytes": 0,
      "readOps": 0,
      "writeOps": 0
    },
    "tcp": {
      "connections": 0,
      "receivingSpeed": "string",
      "sendingSpeed": 0,
      "inSend": 0,
      "measureTime": 0,
      "pendingReceived": 0,
      "pendingSend": 0,
      "receivedBytesSinceLastRun": 0,
      "receivedBytesTotal": 0,
      "sentBytesSinceLastRun": 0,
      "sentBytesTotal": 0
    }
  },
  "sys": {
    "cpu": 0,
    "freeMem": 0,
    "drive": {
      "driveName": {
        "availableBytes": 0,
        "totalBytes": 0,
        "usage": 0,
        "usedBytes": 0
      }
    }
  },
  "es": {
    "checksum": 0,
    "checksumNonFlushed": 0,
    "queue": {
      "queueName": "string",
      "groupName": "string",
      "avgItemsPerSecond": 0,
      "avgProcessingTime": 0,
      "currentIdleTime": "string",
      "currentItemProcessingTime": "string",
      "idleTimePercent": 0,
      "length": 0,
      "lengthCurrentTryPeak": 0,
      "lengthLifetimePeak": 0,
      "totalItemsProcessed": 0,
      "inProgressMessage": "string",
      "lastProcessedMessage": "string"
    },
    "writer": {
      "lastFlushSize": 0,
      "lastFlushDelayMs": 0,
      "meanFlushSize": 0,
      "meanFlushDelayMs": 0,
      "maxFlushSize": 0,
      "maxFlushDelayMs": 0,
      "queuedFlushMessages": 0
    },
    "readIndex": {
      "cachedRecord": 0,
      "notCachedRecord": 0,
      "cachedStreamInfo": 0,
      "notCachedStreamInfo": 0,
      "cachedTransInfo": 0,
      "notCachedTransInfo": 0,
      "hashCollisions": 0
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<Stats>
  <proc>
    <startTime>string</startTime>
    <id>0</id>
    <mem>0</mem>
    <cpu>0</cpu>
    <cpuScaled>0</cpuScaled>
    <threadsCount>0</threadsCount>
    <contentionsRate>0</contentionsRate>
    <thrownExceptionsRate>0</thrownExceptionsRate>
    <gc>
      <allocationSpeed>0</allocationSpeed>
      <gen0ItemsCount>0</gen0ItemsCount>
      <gen0Size>0</gen0Size>
      <gen1ItemsCount>0</gen1ItemsCount>
      <gen1Size>0</gen1Size>
      <gen2ItemsCount>0</gen2ItemsCount>
      <gen2Size>0</gen2Size>
      <largeHeapSize>0</largeHeapSize>
      <timeInGc>0</timeInGc>
      <totalBytesInHeaps>0</totalBytesInHeaps>
    </gc>
    <diskIo>
      <readBytes>0</readBytes>
      <writtenBytes>0</writtenBytes>
      <readOps>0</readOps>
      <writeOps>0</writeOps>
    </diskIo>
    <tcp>
      <connections>0</connections>
      <receivingSpeed>string</receivingSpeed>
      <sendingSpeed>0</sendingSpeed>
      <inSend>0</inSend>
      <measureTime>0</measureTime>
      <pendingReceived>0</pendingReceived>
      <pendingSend>0</pendingSend>
      <receivedBytesSinceLastRun>0</receivedBytesSinceLastRun>
      <receivedBytesTotal>0</receivedBytesTotal>
      <sentBytesSinceLastRun>0</sentBytesSinceLastRun>
      <sentBytesTotal>0</sentBytesTotal>
    </tcp>
  </proc>
  <sys>
    <cpu>0</cpu>
    <freeMem>0</freeMem>
    <drive>
      <driveName>
        <availableBytes>0</availableBytes>
        <totalBytes>0</totalBytes>
        <usage>0</usage>
        <usedBytes>0</usedBytes>
      </driveName>
    </drive>
  </sys>
  <es>
    <checksum>0</checksum>
    <checksumNonFlushed>0</checksumNonFlushed>
    <queue>
      <queueName>string</queueName>
      <groupName>string</groupName>
      <avgItemsPerSecond>0</avgItemsPerSecond>
      <avgProcessingTime>0</avgProcessingTime>
      <currentIdleTime>string</currentIdleTime>
      <currentItemProcessingTime>string</currentItemProcessingTime>
      <idleTimePercent>0</idleTimePercent>
      <length>0</length>
      <lengthCurrentTryPeak>0</lengthCurrentTryPeak>
      <lengthLifetimePeak>0</lengthLifetimePeak>
      <totalItemsProcessed>0</totalItemsProcessed>
      <inProgressMessage>string</inProgressMessage>
      <lastProcessedMessage>string</lastProcessedMessage>
    </queue>
    <writer>
      <lastFlushSize>0</lastFlushSize>
      <lastFlushDelayMs>0</lastFlushDelayMs>
      <meanFlushSize>0</meanFlushSize>
      <meanFlushDelayMs>0</meanFlushDelayMs>
      <maxFlushSize>0</maxFlushSize>
      <maxFlushDelayMs>0</maxFlushDelayMs>
      <queuedFlushMessages>0</queuedFlushMessages>
    </writer>
    <readIndex>
      <cachedRecord>0</cachedRecord>
      <notCachedRecord>0</notCachedRecord>
      <cachedStreamInfo>0</cachedStreamInfo>
      <notCachedStreamInfo>0</notCachedStreamInfo>
      <cachedTransInfo>0</cachedTransInfo>
      <notCachedTransInfo>0</notCachedTransInfo>
      <hashCollisions>0</hashCollisions>
    </readIndex>
  </es>
</Stats>

Responses

Get specified stat

Code samples

# You can also use wget
curl -X GET https://kurrent.io/stats/{statPath}

GET /stats/{statPath}Get stats sub path

Returns the sub path of the KurrentDB statistics available.

Parameters

Responses

Gossip

Return Gossip details

Code samples

# You can also use wget
curl -X GET https://kurrent.io/gossip

GET /gossipReturn Gossip details for cluster

Return Gossip details for nodes in cluster.

Responses

Update Gossip details

Code samples

# You can also use wget
curl -X POST https://kurrent.io/gossip

POST /gossipUpdate Gossip details for cluster

Update Gossip details for nodes in a cluster.

Responses

Schemas

UserItem

{
  "LoginName": "admin",
  "FullName": "KurrentDB Admin",
  "Groups": [
    "Admin",
    "DataScience"
  ],
  "Password": "aVerySecurePassword"
}

Properties

UserUpdateItem

{
  "FullName": "KurrentDB Admin",
  "Groups": [
    "Admin",
    "DataScience"
  ]
}

Properties

PasswordResetItem

{
  "NewPassword": "aNewSecurePassword"
}

Properties

PasswordChangeItem

{
  "CurrentPassword": "anOldSecurePassword",
  "NewPassword": "aNewSecurePassword"
}

Properties

streamData

{
  "body": {}
}

Properties

StreamItem

{
  "minCheckPointCount": 2,
  "startFrom": 0,
  "ResolveLinkTos": true,
  "readBatchSize": 5,
  "namedConsumerStrategy": "RoundRobin",
  "extraStatistics": true,
  "maxRetryCount": 7,
  "liveBufferSize": 1,
  "messageTimeoutMilliseconds": 3,
  "maxCheckPointCount": 2,
  "maxSubscriberCount": 9,
  "checkPointAfterMilliseconds": 6,
  "bufferSize": 5
}

Properties

Enumerated Values

StreamMetadataItem

{
  "eventId": "string",
  "eventType": "string",
  "data": {
    "maxAge": 0,
    "maxCount": 0,
    "truncateBefore": 0,
    "cacheControl": "string",
    "acl": {
      "r": "string",
      "w": "string",
      "d": "string",
      "mr": "string",
      "mw": "string"
    }
  }
}

Properties

SubscriptionItem

{
  "minCheckPointCount": 2,
  "startFrom": 0,
  "ResolveLinkTos": true,
  "readBatchSize": 5,
  "namedConsumerStrategy": "RoundRobin",
  "extraStatistics": true,
  "maxRetryCount": 7,
  "liveBufferSize": 1,
  "messageTimeoutMilliseconds": 3,
  "maxCheckPointCount": 2,
  "maxSubscriberCount": 9,
  "checkPointAfterMilliseconds": 6,
  "bufferSize": 5
}

Properties

Enumerated Values

StreamMetadataItem_data

{
  "maxAge": 0,
  "maxCount": 0,
  "truncateBefore": 0,
  "cacheControl": "string",
  "acl": {
    "r": "string",
    "w": "string",
    "d": "string",
    "mr": "string",
    "mw": "string"
  }
}

Properties

Stats

{
  "proc": {
    "startTime": "string",
    "id": 0,
    "mem": 0,
    "cpu": 0,
    "cpuScaled": 0,
    "threadsCount": 0,
    "contentionsRate": 0,
    "thrownExceptionsRate": 0,
    "gc": {
      "allocationSpeed": 0,
      "gen0ItemsCount": 0,
      "gen0Size": 0,
      "gen1ItemsCount": 0,
      "gen1Size": 0,
      "gen2ItemsCount": 0,
      "gen2Size": 0,
      "largeHeapSize": 0,
      "timeInGc": 0,
      "totalBytesInHeaps": 0
    },
    "diskIo": {
      "readBytes": 0,
      "writtenBytes": 0,
      "readOps": 0,
      "writeOps": 0
    },
    "tcp": {
      "connections": 0,
      "receivingSpeed": "string",
      "sendingSpeed": 0,
      "inSend": 0,
      "measureTime": 0,
      "pendingReceived": 0,
      "pendingSend": 0,
      "receivedBytesSinceLastRun": 0,
      "receivedBytesTotal": 0,
      "sentBytesSinceLastRun": 0,
      "sentBytesTotal": 0
    }
  },
  "sys": {
    "cpu": 0,
    "freeMem": 0,
    "drive": {
      "driveName": {
        "availableBytes": 0,
        "totalBytes": 0,
        "usage": 0,
        "usedBytes": 0
      }
    }
  },
  "es": {
    "checksum": 0,
    "checksumNonFlushed": 0,
    "queue": {
      "queueName": "string",
      "groupName": "string",
      "avgItemsPerSecond": 0,
      "avgProcessingTime": 0,
      "currentIdleTime": "string",
      "currentItemProcessingTime": "string",
      "idleTimePercent": 0,
      "length": 0,
      "lengthCurrentTryPeak": 0,
      "lengthLifetimePeak": 0,
      "totalItemsProcessed": 0,
      "inProgressMessage": "string",
      "lastProcessedMessage": "string"
    },
    "writer": {
      "lastFlushSize": 0,
      "lastFlushDelayMs": 0,
      "meanFlushSize": 0,
      "meanFlushDelayMs": 0,
      "maxFlushSize": 0,
      "maxFlushDelayMs": 0,
      "queuedFlushMessages": 0
    },
    "readIndex": {
      "cachedRecord": 0,
      "notCachedRecord": 0,
      "cachedStreamInfo": 0,
      "notCachedStreamInfo": 0,
      "cachedTransInfo": 0,
      "notCachedTransInfo": 0,
      "hashCollisions": 0
    }
  }
}

Properties