Example app RPC API#

DELETE /app/log/private#
Query Parameters
  • id (integer) – (Required)

Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    true
    

  • default

    An error occurred

    Example response:

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

GET /app/log/private#
Query Parameters
  • id (integer) – (Required)

Example request:

GET /app/log/private?id=1 HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

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

POST /app/log/private#

Example request:

POST /app/log/private HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "msg": "string",
    "record_claim": true
}
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    true
    

  • default

    An error occurred

    Example response:

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

POST /app/log/private/admin_only#

Example request:

POST /app/log/private/admin_only HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "msg": "string",
    "record_claim": true
}
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    true
    

  • default

    An error occurred

    Example response:

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

DELETE /app/log/private/all#
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    true
    

  • default

    An error occurred

    Example response:

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

POST /app/log/private/anonymous#

Example request:

POST /app/log/private/anonymous HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "msg": "string",
    "record_claim": true
}
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    true
    

  • default

    An error occurred

    Example response:

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

GET /app/log/private/count#

Example request:

GET /app/log/private/count HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    1
    

  • default

    An error occurred

    Example response:

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

GET /app/log/private/historical#
Query Parameters
  • id (integer) – (Required)

Example request:

GET /app/log/private/historical?id=1 HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

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

GET /app/log/private/historical/sparse#
Query Parameters
  • seqnos (string) – (Required)

  • id (integer) – (Required)

Example request:

GET /app/log/private/historical/sparse?seqnos=string&id=1 HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "@nextLink": "string",
        "entries": [
            {
                "id": 1,
                "msg": "string",
                "seqno": 1
            }
        ]
    }
    

  • default

    An error occurred

    Example response:

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

GET /app/log/private/historical_receipt#
Query Parameters
  • id (integer) – (Required)

Example request:

GET /app/log/private/historical_receipt?id=1 HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "msg": "string",
        "receipt": {}
    }
    

  • default

    An error occurred

    Example response:

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

POST /app/log/private/prefix_cert#

Example request:

POST /app/log/private/prefix_cert HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "msg": "string",
    "record_claim": true
}
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    true
    

  • default

    An error occurred

    Example response:

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

POST /app/log/private/raw_text/{id}#
Parameters
  • id (string) –

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

DELETE /app/log/public#
Query Parameters
  • id (integer) – (Required)

Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    true
    

  • default

    An error occurred

    Example response:

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

GET /app/log/public#
Query Parameters
  • id (integer) – (Required)

Example request:

GET /app/log/public?id=1 HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

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

  • default

    An error occurred

    Example response:

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

POST /app/log/public#

Example request:

POST /app/log/public HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "id": 1,
    "msg": "string",
    "record_claim": true
}
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    true
    

  • default

    An error occurred

    Example response:

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

DELETE /app/log/public/all#
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    true
    

  • default

    An error occurred

    Example response:

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

GET /app/log/public/count#

Example request:

GET /app/log/public/count HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    1
    

  • default

    An error occurred

    Example response:

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

GET /app/log/public/historical/range#
Query Parameters
  • from_seqno (integer) –

  • to_seqno (integer) –

  • id (integer) – (Required)

Example request:

GET /app/log/public/historical/range?id=1 HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "@nextLink": "string",
        "entries": [
            {
                "id": 1,
                "msg": "string",
                "seqno": 1
            }
        ]
    }
    

  • default

    An error occurred

    Example response:

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

GET /app/log/public/historical_receipt#
Query Parameters
  • id (integer) – (Required)

Example request:

GET /app/log/public/historical_receipt?id=1 HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Default response description

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "msg": "string",
        "receipt": {}
    }
    

  • default

    An error occurred

    Example response:

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

GET /app/log/request_query#

Example request:

GET /app/log/request_query 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 /app/log/signed_request_query#

Example request:

GET /app/log/signed_request_query 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"
        }
    }
    

There are also built-in endpoints added by CCF which are described in RPC API.