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
  • 204 No Content – Default response description

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

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"
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "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
    
    {}
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

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
            }
        ]
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

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"
            }
        ]
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/commit#
Query Parameters
  • view_history (boolean) –

  • view_history_since (integer) –

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",
        "view_history": [
            "string"
        ]
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "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
    
    {}
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/constitution#

Example request:

GET /gov/kv/constitution HTTP/1.1
Host: example.com
Status Codes
  • 200 OK – Default response description

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/cose_history#

Example request:

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

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/history#

Example request:

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

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/js_runtime_options#

Example request:

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

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "max_execution_time_ms": 1,
        "max_heap_bytes": 1,
        "max_stack_bytes": 1
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/jwt/issuers#

Example request:

GET /gov/kv/jwt/issuers HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/jwt/public_signing_key_issuer#

Example request:

GET /gov/kv/jwt/public_signing_key_issuer HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/jwt/public_signing_keys#

Example request:

GET /gov/kv/jwt/public_signing_keys HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/members/acks#

Example request:

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

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/members/certs#

Example request:

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

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/members/encryption_public_keys#

Example request:

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

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/members/info#

Example request:

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

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/modules#

Example request:

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

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/modules_quickjs_bytecode#

Example request:

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

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/modules_quickjs_version#

Example request:

GET /gov/kv/modules_quickjs_version HTTP/1.1
Host: example.com
Status Codes
  • 200 OK – Default response description

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/nodes/code_ids#

Example request:

GET /gov/kv/nodes/code_ids HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    [
        [
            "string",
            "AllowedToJoin"
        ]
    ]
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/nodes/endorsed_certificates#

Example request:

GET /gov/kv/nodes/endorsed_certificates HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/nodes/info#

Example request:

GET /gov/kv/nodes/info HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/nodes/snp/host_data#

Example request:

GET /gov/kv/nodes/snp/host_data HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    [
        [
            "string",
            "string"
        ]
    ]
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/proposals#

Example request:

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

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/proposals_info#

Example request:

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

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/service/acme_certificates#

Example request:

GET /gov/kv/service/acme_certificates HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/service/config#

Example request:

GET /gov/kv/service/config HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "consensus": "CFT",
        "maximum_node_certificate_validity_days": 1,
        "maximum_service_certificate_validity_days": 1,
        "reconfiguration_type": "OneTransaction",
        "recovery_threshold": 1
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/service/info#

Example request:

GET /gov/kv/service/info HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "cert": "string",
        "current_service_create_txid": "string",
        "previous_service_identity_version": 1,
        "recovery_count": 1,
        "service_data": {},
        "status": "Opening"
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/tls/ca_cert_bundles#

Example request:

GET /gov/kv/tls/ca_cert_bundles HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/users/certs#

Example request:

GET /gov/kv/users/certs HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/kv/users/info#

Example request:

GET /gov/kv/users/info HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

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"
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "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
    
    {}
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/proposals#

Example request:

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

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

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": {}
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

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": {}
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

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"
            }
        ]
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "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": {}
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

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"
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "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": {}
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

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
    
    {}
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

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"
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "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"
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/snp/host_data#
Query Parameters
  • key (string) –

Example request:

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

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "host_data": [
            {
                "metadata": "string",
                "raw": "string"
            }
        ]
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }
    

GET /gov/snp/measurements#

Example request:

GET /gov/snp/measurements 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"
            }
        ]
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "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"
    }
    

  • default

    An error occurred

    Example response:

    HTTP/1.1 default -
    Content-Type: application/json
    
    {
        "error": {
            "code": "string",
            "message": "string"
        }
    }