Operations

This section describes the RPC methods supported by the Dydra API.

Note

The example requests and responses in this section are shown using the JSON-RPC protocol. The RPC endpoint supports both the JSON-RPC and XML-RPC protocols, with the former being strongly preferred due to its relative efficiency, simplicity, and brevity.

DescribeService

DescribeService()

Returns information regarding current service status and availability.

Example JSON-RPC request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "DescribeService",
  "params": []
}

Example JSON-RPC response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "version": "2012-06-01",
    "status": "nominal",
    "readable": true,
    "writable": true
  }
}

Table Of Contents

Previous topic

HTTP Endpoint

Next topic

Error Conditions