Member RPC API#

Member RPCs are exposed under /gov and require authentication with a valid member identity.

POST /gov/ack#

Example request:

POST /gov/ack HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "state_digest": "string"
}
Status Codes
POST /gov/ack/update_state_digest#
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "state_digest": "string"
    }
    

GET /gov/api#

Example request:

GET /gov/api HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {}
    

GET /gov/api/metrics#

Example request:

GET /gov/api/metrics HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "metrics": [
            {
                "calls": 1,
                "errors": 1,
                "failures": 1,
                "method": "string",
                "path": "string",
                "retries": 1
            }
        ]
    }
    

GET /gov/code#

Example request:

GET /gov/code HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "versions": [
            {
                "digest": "string",
                "status": "AllowedToJoin"
            }
        ]
    }
    

GET /gov/commit#

Example request:

GET /gov/commit HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "transaction_id": "string"
    }
    

GET /gov/jwt_keys/all#

Example request:

GET /gov/jwt_keys/all HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {}
    

GET /gov/local_tx#
Query Parameters
  • transaction_id (string) – (Required)

Example request:

GET /gov/local_tx?transaction_id=string HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "status": "Unknown",
        "transaction_id": "string"
    }
    

GET /gov/members#

Example request:

GET /gov/members HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {}
    

POST /gov/proposals#

Example request:

POST /gov/proposals HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "actions": [
        {
            "args": {},
            "name": "string"
        }
    ]
}
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "ballot_count": 1,
        "failure": {
            "reason": "string",
            "trace": "string"
        },
        "proposal_id": "string",
        "proposer_id": "string",
        "state": "Open",
        "vote_failures": {},
        "votes": {}
    }
    

GET /gov/proposals/{proposal_id}#
Parameters
  • proposal_id (string) –

Example request:

GET /gov/proposals/{proposal_id} HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "ballots": {},
        "failure": {
            "reason": "string",
            "trace": "string"
        },
        "final_votes": {},
        "proposer_id": "string",
        "state": "Open",
        "vote_failures": {}
    }
    

GET /gov/proposals/{proposal_id}/actions#
Parameters
  • proposal_id (string) –

Example request:

GET /gov/proposals/{proposal_id}/actions HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "actions": [
            {
                "args": {},
                "name": "string"
            }
        ]
    }
    

POST /gov/proposals/{proposal_id}/ballots#
Parameters
  • proposal_id (string) –

Example request:

POST /gov/proposals/{proposal_id}/ballots HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "ballot": "string"
}
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "ballot_count": 1,
        "failure": {
            "reason": "string",
            "trace": "string"
        },
        "proposal_id": "string",
        "proposer_id": "string",
        "state": "Open",
        "vote_failures": {},
        "votes": {}
    }
    

GET /gov/proposals/{proposal_id}/ballots/{member_id}#
Parameters
  • proposal_id (string) –

  • member_id (string) –

Example request:

GET /gov/proposals/{proposal_id}/ballots/{member_id} HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "ballot": "string"
    }
    

POST /gov/proposals/{proposal_id}/withdraw#
Parameters
  • proposal_id (string) –

Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "ballots": {},
        "failure": {
            "reason": "string",
            "trace": "string"
        },
        "final_votes": {},
        "proposer_id": "string",
        "state": "Open",
        "vote_failures": {}
    }
    

GET /gov/receipt#
Query Parameters
  • transaction_id (string) – (Required)

Example request:

GET /gov/receipt?transaction_id=string HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {}
    

GET /gov/recovery_share#

Example request:

GET /gov/recovery_share HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "encrypted_share": "string"
    }
    

POST /gov/recovery_share#

Example request:

POST /gov/recovery_share HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "share": "string"
}
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "message": "string"
    }
    

GET /gov/tx#
Query Parameters
  • transaction_id (string) – (Required)

Example request:

GET /gov/tx?transaction_id=string HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "status": "Unknown",
        "transaction_id": "string"
    }