Classic API (Deprecated)¶
Available in CCF versions before 5.0.0.
Any request calling a path with a /gov
prefix which does not include the api-version
query parameter is calling the classic API.
Warning
This API is deprecated, and will be removed in a future release. See Upgrading From Classic API for a guide to upgrading to a more recent version.
- POST /gov/ack¶
Provide a member endorsement of a service state digest
This endpoint is deprecated from 5.0.0. It is replaced by POST /gov/members/state-digests/{memberId}:ack
- Status Codes:
204 No Content – Default response description
default – An error occurred
- POST /gov/ack/update_state_digest¶
Update and fetch a service state digest, for the purpose of member endorsement
This endpoint is deprecated from 5.0.0. It is replaced by POST /gov/members/state-digests/{memberId}:update
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/api¶
OpenAPI schema
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/commit¶
Current commit level
Latest transaction ID that has been committed on the service
- Query Parameters:
view_history (boolean) –
view_history_since (integer) –
- Status Codes:
200 OK – Default response description
default – An error occurred
A member’s recovery share
This endpoint is deprecated from 5.0.0. It is replaced by GET /gov/recovery/encrypted-shares/{memberId}
- Parameters:
member_id (string) –
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/jwt_keys/all¶
This endpoint is deprecated from 5.0.0. It is replaced by POST /gov/service/jwk
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/constitution¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/cose_history¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/cose_recent_proposals¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/endpoints¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/history¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/interpreter/flush¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/js_runtime_options¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/jwt/issuers¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/jwt/public_signing_key¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/jwt/public_signing_key_issuer¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/jwt/public_signing_keys_metadata¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/members/acks¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/members/certs¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/members/encryption_public_keys¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/members/info¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/modules¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/modules_quickjs_bytecode¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/modules_quickjs_version¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/nodes/code_ids¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/nodes/endorsed_certificates¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/nodes/info¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/nodes/snp/host_data¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/nodes/snp/measurements¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/nodes/snp/uvm_endorsements¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/proposals¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/proposals_info¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/service/acme_certificates¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/service/config¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/service/info¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/service/previous_service_identity¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/tls/ca_cert_bundles¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/users/certs¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/kv/users/info¶
This route is auto-generated from the KV schema.
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/members¶
This endpoint is deprecated from 5.0.0. It is replaced by GET /gov/service/members
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/proposals¶
Proposed changes to the service pending resolution
This endpoint is deprecated from 5.0.0. It is replaced by GET /gov/members/proposals
- Status Codes:
200 OK – Default response description
default – An error occurred
- POST /gov/proposals¶
This endpoint is deprecated from 5.0.0. It is replaced by POST /gov/members/proposals:create
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/proposals/{proposal_id}¶
Information about a proposed change to the service
This endpoint is deprecated from 5.0.0. It is replaced by GET /gov/members/proposals/{proposalId}
- Parameters:
proposal_id (string) –
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/proposals/{proposal_id}/actions¶
Actions contained in a proposed change to the service
This endpoint is deprecated from 5.0.0. It is replaced by GET /gov/members/proposals/{proposalId}/actions
- Parameters:
proposal_id (string) –
- Status Codes:
200 OK – Default response description
default – An error occurred
- POST /gov/proposals/{proposal_id}/ballots¶
Submit a ballot for a proposed change to the service
This endpoint is deprecated from 5.0.0. It is replaced by POST /gov/members/proposals/{proposalId}/ballots/{memberId}:submit
- Parameters:
proposal_id (string) –
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/proposals/{proposal_id}/ballots/{member_id}¶
Ballot for a given member about a proposed change to the service
This endpoint is deprecated from 5.0.0. It is replaced by GET /gov/members/proposals/{proposalId}/ballots/{memberId}
- Parameters:
proposal_id (string) –
member_id (string) –
- Status Codes:
200 OK – Default response description
default – An error occurred
- POST /gov/proposals/{proposal_id}/withdraw¶
Withdraw a proposed change to the service
This endpoint is deprecated from 5.0.0. It is replaced by POST /gov/members/proposals/{proposalId}:withdraw
- Parameters:
proposal_id (string) –
- Status Codes:
200 OK – Default response description
default – An error occurred
- GET /gov/receipt¶
Receipt for a transaction
A signed statement from the service over a transaction entry in the ledger
- Query Parameters:
transaction_id (string) – (Required)
- Status Codes:
200 OK – Default response description
default – An error occurred
A member’s recovery share
This endpoint is deprecated from 5.0.0. It is replaced by GET /gov/recovery/encrypted-shares/{memberId}
- Status Codes:
200 OK – Default response description
default – An error occurred
Provide a recovery share for the purpose of completing a service recovery
This endpoint is deprecated from 5.0.0. It is replaced by POST /gov/recovery/members/{memberId}:recover
- Status Codes:
200 OK – Default response description
default – An error occurred