Stardog

Stardog Cluster Admin API

Cluster administration operations

GitHub OpenAPI

Operations 15

GET /admin/cluster/standby/registry List standby nodes #
GET /admin/cluster/standby/pause Get standby pause status #
PUT /admin/cluster/standby/pause Pause/Unpause standby node #
DELETE /admin/cluster/standby/registry/{standbyid} Revoke standby access #
PUT /admin/cluster/repairZk Repair ZK transaction IDs if they don't match all Stardog nodes. #
GET /admin/cluster/readreplica Read replica check #
GET /admin/cluster Get cluster info #
POST /admin/cluster/diagnostics Get cluster diagnostics report #
PUT /admin/cluster/readonly Start read only mode #
DELETE /admin/cluster/readonly Stop read only mode #
POST /admin/shutdownAll Shutdown all nodes #
GET /admin/cluster/coordinator Coordinator check #
PUT /admin/cluster/standby/attemptSync Attempt to sync a standby or read replica node with the cluster #
GET /admin/cluster/standby/status Get standby node status #
GET /admin/cluster/status Get cluster status #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/stardog/refs/heads/main/openapi/stardog-cluster-admin-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/stardog-cluster-admin-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

stardog-cluster-admin-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Stardog HTTP Cluster Admin API
  description: '# Overview

    Stardog supports the standard SPARQL Protocol HTTP bindings, as well as additional functionality via HTTP.'
  contact:
    url: https://stardog.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0
  version: 12.0.3
  x-logo:
    url: https://d33wubrfki0l68.cloudfront.net/66e9dcff51317cfc11b9f3d4ce2917a11ba81681/543c1/img/stardog-logo-optimized.svg
servers:
- url: http://localhost:5820
tags:
- name: Cluster Admin
  description: Cluster administration operations
paths:
  /admin/cluster/standby/registry:
    get:
      tags:
      - Cluster Admin
      summary: List standby nodes
      operationId: getStandbyNodes
      responses:
        '200':
          description: Operation successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/STANDBY_NODE_LIST'
      x-sort-order:
        group: '1'
        order: '1'
  /admin/cluster/standby/pause:
    get:
      tags:
      - Cluster Admin
      summary: Get standby pause status
      description: Get the pause status of a standby node
      operationId: getPauseState
      responses:
        '200':
          description: Operation successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/STANDBY_PAUSED'
        '400':
          description: Node is not a standby node
      x-sort-order:
        group: '1'
        order: '4'
    put:
      tags:
      - Cluster Admin
      summary: Pause/Unpause standby node
      operationId: standbyPause
      parameters:
      - name: pause
        in: query
        required: true
        schema:
          type: boolean
      responses:
        '200':
          description: Pause/Unpause requested
        '400':
          description: Node is not a standby node
      x-sort-order:
        group: '1'
        order: '3'
  /admin/cluster/standby/registry/{standbyid}:
    delete:
      tags:
      - Cluster Admin
      summary: Revoke standby access
      description: Instruct a standby node to leave its cluster
      operationId: standbyRevokeAccess
      parameters:
      - name: standbyid
        $ref: '#/components/parameters/standbyid'
      responses:
        '200':
          description: Node has been instructed to leave
        '400':
          description: Node is not a standby node
      x-sort-order:
        group: '1'
        order: '5'
  /admin/cluster/repairZk:
    put:
      tags:
      - Cluster Admin
      summary: Repair ZK transaction IDs if they don't match all Stardog nodes.
      operationId: repairZk
      responses:
        '200':
          description: ZooKeeper repaired
  /admin/cluster/readreplica:
    get:
      tags:
      - Cluster Admin
      summary: Read replica check
      description: Determine if a specific standby node is read replica
      operationId: isReadReplica
      responses:
        '200':
          description: Node is read replica
        '400':
          description: Node is not a read replica
  /admin/cluster:
    get:
      tags:
      - Cluster Admin
      summary: Get cluster info
      operationId: clusterInfo
      responses:
        '200':
          description: Operation successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NODE_LIST'
        '404':
          description: Not part of a cluster
  /admin/cluster/diagnostics:
    post:
      tags:
      - Cluster Admin
      summary: Get cluster diagnostics report
      operationId: generateClusterDiagnosticsReport
      responses:
        '200':
          description: Cluster diagnostics report zip created
  /admin/cluster/readonly:
    put:
      tags:
      - Cluster Admin
      summary: Start read only mode
      operationId: readOnlyStart
      responses:
        '200':
          description: Read only mode started
    delete:
      tags:
      - Cluster Admin
      summary: Stop read only mode
      operationId: readOnlyStop
      responses:
        '200':
          description: Read only mode stopped
  /admin/shutdownAll:
    post:
      tags:
      - Cluster Admin
      summary: Shutdown all nodes
      operationId: shutdownAll
      responses:
        '200':
          description: Shutdown request received
        '405':
          description: Remote shutdown not supported
  /admin/cluster/coordinator:
    get:
      tags:
      - Cluster Admin
      summary: Coordinator check
      description: Determine if a specific cluster node is the cluster coordinator
      operationId: isCoordinator
      responses:
        '200':
          description: Node is coordinator
        '503':
          description: Node is not coordinator
  /admin/cluster/standby/attemptSync:
    put:
      tags:
      - Cluster Admin
      summary: Attempt to sync a standby or read replica node with the cluster
      operationId: attemptSync
      responses:
        '200':
          description: A sync attempt for a standby or read replica node has been initiated
  /admin/cluster/standby/status:
    get:
      tags:
      - Cluster Admin
      summary: Get standby node status
      operationId: getStandbyStatus
      responses:
        '200':
          description: Operation successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/STANDBY_STATUS'
  /admin/cluster/status:
    get:
      tags:
      - Cluster Admin
      summary: Get cluster status
      operationId: packStatus
      responses:
        '200':
          description: Operation successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CLUSTER_STATUS'
components:
  schemas:
    CLUSTER_STATUS:
      properties:
        nodes:
          required:
          - nodes
          type: array
          items:
            required:
            - address
            - metadata
            - type
            - role
            properties:
              address:
                pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}(:[0-9]{3,5})?$
                type: string
                example: 165.7.29.42:5820
              metadata:
                type: object
              type:
                type: string
                enum:
                - FULL
                - STANDBY
              role:
                type: string
                enum:
                - COORDINATOR
                - PARTICIPANT
                - STANDBY
    STANDBY_NODE_LIST:
      required:
      - standbynodes
      properties:
        standbynodes:
          type: array
          items:
            pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}(:[0-9]{3,5})?$
            type: string
            example: 165.7.29.42:5820
    NODE_LIST:
      required:
      - nodes
      properties:
        nodes:
          type: array
          items:
            pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}(:[0-9]{3,5})?$
            type: string
            example: 165.7.29.42:5820
    STANDBY_PAUSED:
      required:
      - STATE
      properties:
        STATE:
          type: string
          enum:
          - WAITING
          - SYNCING
          - PAUSING
          - PAUSED
    STANDBY_STATUS:
      required:
      - address
      - state
      - readReplica
      - geoReplica
      - totalBytesToSync
      - syncCount
      - stardogVersion
      - syncIntervalMs
      - lastClusterAdminTx
      - lastStandbyNodeAdminTx
      - dbSyncBytes
      properties:
        address:
          type: string
        state:
          type: string
        readReplica:
          type: boolean
          description: Whether this is a read replica
          default: false
        geoReplica:
          type: boolean
          description: Whether this is a geo replica
          default: false
        totalBytesToSync:
          type: integer
          description: The total bytes estimated to sync
          format: int64
        syncCount:
          type: integer
          description: The number of times the standby has sync'd
          format: int64
        stardogVersion:
          type: string
        syncIntervalMs:
          type: integer
          description: The interval the standby node syncs (ms)
          format: int64
        lastClusterAdminTx:
          type: string
        lastStandbyNodeAdminTx:
          type: string
        dbSyncBytes:
          additionalProperties:
            type: integer
            format: int64
            example: 42
  parameters:
    standbyid:
      name: standbyid
      in: path
      description: The UUID of the standby node
      required: true
      schema:
        type: string
        format: uuid
        example: 4ea1ebac-48f0-459c-a9a7-6cad7189403d
externalDocs:
  url: https://docs.stardog.com
x-tagGroups:
- name: Data Unification
  tags:
  - Data Sources
  - Virtual Graphs
- name: Virtual Graphs External Compute
  tags:
  - Virtual Graphs External Compute
- name: Server
  tags:
  - Monitoring
  - Stored Functions
  - Server Status/Metrics
  - Server Admin
  - Queries
  - Cluster Admin
- name: Database
  tags:
  - Checkpoints
  - DB Admin
  - Integrity Constraints / SHACL
  - Data Caching
  - Graph Store Protocol
  - Matcher, aligning schemas from various data sources
  - Reasoning
  - Transactions
  - GraphQL
  - SPARQL
  - EntityResolution
- name: Security
  tags:
  - Roles
  - Permissions
  - Users
- name: Knowledge Catalog
  tags:
  - Knowledge Catalog