Microsoft.ManagedCcf (preview:2023-06-01)

2025/10/22 • 23 deleted methods

Proposals_List (removed)
Description :  Returns all current proposed changes to the service. Note that non-open proposals (ie - those which have already been accepted, rejected, withdrawn, etc) are not returned.
Reference :  Link ¶

⚼ Request

GET:  /gov/members/proposals
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of Proposal items ,
}
{
value:
{
Description: The Proposal items on this page ,
Required: True ,
}
[
{
proposalId:
{
Description: Unique ID assigned to this proposal at its submission, by the service. ,
Required: True ,
}
string ,
proposerId:
{
Description: ID of CCF member who signed and created this proposal. ,
Required: True ,
}
string ,
proposalState:
{
Description: Current state of this proposal. ,
Enum:
{
Open: Proposal is active and can be voted on. ,
Accepted: Proposal passed a successful vote and was enacted. ,
Withdrawn: Proposal was removed by proposing member. Will never be enacted. ,
Rejected: Proposal was rejected by vote. Will never be enacted. ,
Failed: Proposal passed a successful vote, but its proposed actions failed. Will never be enacted. ,
Dropped: Proposal was open when its semantics were potentially changed (code or constitution were modified), so it was automatically invalidated. ,
}
,
Required: True ,
}
enum ,
ballotCount:
{
Description: Count of how many ballots have been submitted for this proposal. ,
Format: int64 ,
Required: True ,
}
integer ,
finalVotes:
{
Description: If a proposal is not open, then this contains the result of each ballot when the proposal transitioned from open. ,
Required: False ,
}
object ,
voteFailures:
{
Description: This will be populated with a description of any ballots which failed to execute. ,
Required: False ,
}
object ,
failure:
{
Description: If proposalState is Failure, then this will describe why the proposal failed. ,
Required: False ,
}
{
reason:
{
Description: Error message describing reason for failure. ,
Required: True ,
}
string ,
trace:
{
Description: Call stack showing where failure occurred, if available. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Proposals_Withdraw (removed)
Description :  Withdraw an existing proposal. Only the original proposer is permitted to withdraw.
Reference :  Link ¶

⚼ Request

POST:  /gov/members/proposals/{proposalId}:withdraw
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proposalId:
{
Description: Unique ID assigned to this proposal at its submission, by the service. ,
Required: True ,
}
string ,
body:
{
Description: A raw CoseSign1 signature. See CCF docs for required headers and body schema: https://microsoft.github.io/CCF/main/use_apps/issue_commands.html#cose-schemas ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction where this request produced a write on the service. This uniquely identifies the submitted request, and can be used to confirm that the request becomes committed. ,
}
string ,
}
,
$schema:
{
Description: Description of a proposed change to the service. ,
}
{
proposalId:
{
Description: Unique ID assigned to this proposal at its submission, by the service. ,
Required: True ,
}
string ,
proposerId:
{
Description: ID of CCF member who signed and created this proposal. ,
Required: True ,
}
string ,
proposalState:
{
Description: Current state of this proposal. ,
Enum:
{
Open: Proposal is active and can be voted on. ,
Accepted: Proposal passed a successful vote and was enacted. ,
Withdrawn: Proposal was removed by proposing member. Will never be enacted. ,
Rejected: Proposal was rejected by vote. Will never be enacted. ,
Failed: Proposal passed a successful vote, but its proposed actions failed. Will never be enacted. ,
Dropped: Proposal was open when its semantics were potentially changed (code or constitution were modified), so it was automatically invalidated. ,
}
,
Required: True ,
}
enum ,
ballotCount:
{
Description: Count of how many ballots have been submitted for this proposal. ,
Format: int64 ,
Required: True ,
}
integer ,
finalVotes:
{
Description: If a proposal is not open, then this contains the result of each ballot when the proposal transitioned from open. ,
Required: False ,
}
object ,
voteFailures:
{
Description: This will be populated with a description of any ballots which failed to execute. ,
Required: False ,
}
object ,
failure:
{
Description: If proposalState is Failure, then this will describe why the proposal failed. ,
Required: False ,
}
{
reason:
{
Description: Error message describing reason for failure. ,
Required: True ,
}
string ,
trace:
{
Description: Call stack showing where failure occurred, if available. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Proposals_Get (removed)
Description :  Returns a summary of a single proposed change to the service.
Reference :  Link ¶

⚼ Request

GET:  /gov/members/proposals/{proposalId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proposalId:
{
Description: Unique ID assigned to this proposal at its submission, by the service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history. ,
}
string ,
}
,
$schema:
{
Description: Description of a proposed change to the service. ,
}
{
proposalId:
{
Description: Unique ID assigned to this proposal at its submission, by the service. ,
Required: True ,
}
string ,
proposerId:
{
Description: ID of CCF member who signed and created this proposal. ,
Required: True ,
}
string ,
proposalState:
{
Description: Current state of this proposal. ,
Enum:
{
Open: Proposal is active and can be voted on. ,
Accepted: Proposal passed a successful vote and was enacted. ,
Withdrawn: Proposal was removed by proposing member. Will never be enacted. ,
Rejected: Proposal was rejected by vote. Will never be enacted. ,
Failed: Proposal passed a successful vote, but its proposed actions failed. Will never be enacted. ,
Dropped: Proposal was open when its semantics were potentially changed (code or constitution were modified), so it was automatically invalidated. ,
}
,
Required: True ,
}
enum ,
ballotCount:
{
Description: Count of how many ballots have been submitted for this proposal. ,
Format: int64 ,
Required: True ,
}
integer ,
finalVotes:
{
Description: If a proposal is not open, then this contains the result of each ballot when the proposal transitioned from open. ,
Required: False ,
}
object ,
voteFailures:
{
Description: This will be populated with a description of any ballots which failed to execute. ,
Required: False ,
}
object ,
failure:
{
Description: If proposalState is Failure, then this will describe why the proposal failed. ,
Required: False ,
}
{
reason:
{
Description: Error message describing reason for failure. ,
Required: True ,
}
string ,
trace:
{
Description: Call stack showing where failure occurred, if available. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Proposals_GetActions (removed)
Description :  Returns actions contained in a proposal.
Reference :  Link ¶

⚼ Request

GET:  /gov/members/proposals/{proposalId}/actions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proposalId:
{
Description: Unique ID assigned to this proposal at its submission, by the service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history. ,
}
string ,
}
,
$schema:
{
Description: The actions contained in a proposal, describing the proposal's changes. ,
}
{
actions:
{
Description: A list of actions to apply. Each action is considered, in order, for both proposal and execution of the proposal. All actions are validated and, if the proposal is accepted, applied atomically. ,
Required: True ,
}
[
{
name:
{
Description: The name of the action to perform. This should match an action defined in the service's constitution, so that it can be invoked by the `apply` function of the constitution if the proposal is accepted. ,
Required: True ,
}
string ,
args:
{
Description: Arguments to modify the behavior of this action. The schema is determined by the action implementation, and should be validated by a `validate` call in the constitution. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Ballots_Submit (removed)
Description :  Submit an executable ballot for a specific proposal. This may be as simple as `return true` to vote in favour, or contain reads from the KV and conditions on the proposal contents.
Reference :  Link ¶

⚼ Request

POST:  /gov/members/proposals/{proposalId}/ballots/{memberId}:submit
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proposalId:
{
Description: Unique ID assigned to this proposal at its submission, by the service. ,
Required: True ,
}
string ,
memberId:
{
Description: ID of CCF member who signed and submitted this ballot. ,
Required: True ,
}
string ,
body:
{
Description: A raw CoseSign1 signature. See CCF docs for required headers and body schema: https://microsoft.github.io/CCF/main/use_apps/issue_commands.html#cose-schemas ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction where this request produced a write on the service. This uniquely identifies the submitted request, and can be used to confirm that the request becomes committed. ,
}
string ,
}
,
$schema:
{
Description: Description of a proposed change to the service. ,
}
{
proposalId:
{
Description: Unique ID assigned to this proposal at its submission, by the service. ,
Required: True ,
}
string ,
proposerId:
{
Description: ID of CCF member who signed and created this proposal. ,
Required: True ,
}
string ,
proposalState:
{
Description: Current state of this proposal. ,
Enum:
{
Open: Proposal is active and can be voted on. ,
Accepted: Proposal passed a successful vote and was enacted. ,
Withdrawn: Proposal was removed by proposing member. Will never be enacted. ,
Rejected: Proposal was rejected by vote. Will never be enacted. ,
Failed: Proposal passed a successful vote, but its proposed actions failed. Will never be enacted. ,
Dropped: Proposal was open when its semantics were potentially changed (code or constitution were modified), so it was automatically invalidated. ,
}
,
Required: True ,
}
enum ,
ballotCount:
{
Description: Count of how many ballots have been submitted for this proposal. ,
Format: int64 ,
Required: True ,
}
integer ,
finalVotes:
{
Description: If a proposal is not open, then this contains the result of each ballot when the proposal transitioned from open. ,
Required: False ,
}
object ,
voteFailures:
{
Description: This will be populated with a description of any ballots which failed to execute. ,
Required: False ,
}
object ,
failure:
{
Description: If proposalState is Failure, then this will describe why the proposal failed. ,
Required: False ,
}
{
reason:
{
Description: Error message describing reason for failure. ,
Required: True ,
}
string ,
trace:
{
Description: Call stack showing where failure occurred, if available. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Ballots_Get (removed)
Description :  Returns a member's submitted ballot.
Reference :  Link ¶

⚼ Request

GET:  /gov/members/proposals/{proposalId}/ballots/{memberId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proposalId:
{
Description: Unique ID assigned to this proposal at its submission, by the service. ,
Required: True ,
}
string ,
memberId:
{
Description: ID of CCF member who signed and submitted this ballot. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history. ,
}
string ,
}
,
$schema:
{
Description: The source script of an executable vote from a member, regarding a proposed change to the service. ,
}
{
script:
{
Description: The script to execute, returning the voter's support of this proposal. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Proposals_Create (removed)
Description :  Submit a proposed change to the service. This will be assigned an ID by the service. Submitting the same signature (including signed COSE headers such as created_at) multiple times will be treated as a single idempotent operation, returning a single created proposal (or an error if it is no longer available). Any change to the request body will be treated as a new, separate proposal.
Reference :  Link ¶

⚼ Request

POST:  /gov/members/proposals:create
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: A raw CoseSign1 signature. See CCF docs for required headers and body schema: https://microsoft.github.io/CCF/main/use_apps/issue_commands.html#cose-schemas ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction where this request produced a write on the service. This uniquely identifies the submitted request, and can be used to confirm that the request becomes committed. ,
}
string ,
}
,
$schema:
{
Description: Description of a proposed change to the service. ,
}
{
proposalId:
{
Description: Unique ID assigned to this proposal at its submission, by the service. ,
Required: True ,
}
string ,
proposerId:
{
Description: ID of CCF member who signed and created this proposal. ,
Required: True ,
}
string ,
proposalState:
{
Description: Current state of this proposal. ,
Enum:
{
Open: Proposal is active and can be voted on. ,
Accepted: Proposal passed a successful vote and was enacted. ,
Withdrawn: Proposal was removed by proposing member. Will never be enacted. ,
Rejected: Proposal was rejected by vote. Will never be enacted. ,
Failed: Proposal passed a successful vote, but its proposed actions failed. Will never be enacted. ,
Dropped: Proposal was open when its semantics were potentially changed (code or constitution were modified), so it was automatically invalidated. ,
}
,
Required: True ,
}
enum ,
ballotCount:
{
Description: Count of how many ballots have been submitted for this proposal. ,
Format: int64 ,
Required: True ,
}
integer ,
finalVotes:
{
Description: If a proposal is not open, then this contains the result of each ballot when the proposal transitioned from open. ,
Required: False ,
}
object ,
voteFailures:
{
Description: This will be populated with a description of any ballots which failed to execute. ,
Required: False ,
}
object ,
failure:
{
Description: If proposalState is Failure, then this will describe why the proposal failed. ,
Required: False ,
}
{
reason:
{
Description: Error message describing reason for failure. ,
Required: True ,
}
string ,
trace:
{
Description: Call stack showing where failure occurred, if available. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StateDigests_Update (removed)
Description :  Request that this member's stateDigest is updated to a fresher value. Only this member may update their own stateDigest. Returns the refreshed value.
Reference :  Link ¶

⚼ Request

POST:  /gov/members/state-digests/{memberId}:update
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
memberId:
{
Description: Identifier for member this stateDigest applies to. ,
Required: True ,
}
string ,
body:
{
Description: A raw CoseSign1 signature. See CCF docs for required headers and body schema: https://microsoft.github.io/CCF/main/use_apps/issue_commands.html#cose-schemas ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction where this request produced a write on the service. This uniquely identifies the submitted request, and can be used to confirm that the request becomes committed. ,
}
string ,
}
,
$schema:
{
Description: A compact summary of the service's state up to a certain point in time, updated and signed by members to indicate their participation in and approval of the service. ,
}
{
digest:
{
Description: Hex-encoding of SHA-256 hash of the root of the service's merkle tree. This should be signed by a new member and submitted as an ACK to mark that member as Active. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StateDigests_Acknowledge (removed)
Description :  Submit a signed acknowledgement of a recent digest of the service status, to transition the member to Active.
Reference :  Link ¶

⚼ Request

POST:  /gov/members/state-digests/{memberId}:ack
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
memberId:
{
Description: Identifier for member this stateDigest applies to. ,
Required: True ,
}
string ,
body:
{
Description: A raw CoseSign1 signature. See CCF docs for required headers and body schema: https://microsoft.github.io/CCF/main/use_apps/issue_commands.html#cose-schemas ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction where this request produced a write on the service. This uniquely identifies the submitted request, and can be used to confirm that the request becomes committed. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StateDigests_Get (removed)
Description :  Get the stateDigest assigned to the given member, which that member must sign to become active.
Reference :  Link ¶

⚼ Request

GET:  /gov/members/state-digests/{memberId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
memberId:
{
Description: Identifier for member this stateDigest applies to. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history. ,
}
string ,
}
,
$schema:
{
Description: A compact summary of the service's state up to a certain point in time, updated and signed by members to indicate their participation in and approval of the service. ,
}
{
digest:
{
Description: Hex-encoding of SHA-256 hash of the root of the service's merkle tree. This should be signed by a new member and submitted as an ACK to mark that member as Active. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
EncryptedShares_Get (removed)
Description :  Retrieve a member's recovery share, encrypted with that member's share-encryption key.
Reference :  Link ¶

⚼ Request

GET:  /gov/recovery/encrypted-shares/{memberId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
memberId:
{
Description: ID of CCF member who this recovery share belongs to. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
encryptedShare:
{
Description: Base-64 encoding of a member's encrypted share. ,
Format: byte ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Shares_Submit (removed)
Description :  Provide a recovery share for the purpose of completing a service recovery.
Reference :  Link ¶

⚼ Request

POST:  /gov/recovery/members/{memberId}:recover
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
memberId:
{
Description: Identifier for member this recovery state applies to. ,
Required: True ,
}
string ,
body:
{
Description: A raw CoseSign1 signature. See CCF docs for required headers and body schema: https://microsoft.github.io/CCF/main/use_apps/issue_commands.html#cose-schemas ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history. ,
}
string ,
}
,
$schema:
{
Description: Response to a submitted recovery share. ,
}
{
message:
{
Description: Human-readable description of current recovery progress. ,
Required: True ,
}
string ,
submittedCount:
{
Description: Count of how many accepted member shares have been submitted, including the current request. ,
Format: int64 ,
Required: True ,
}
integer ,
recoveryThreshold:
{
Description: Count of how many member shares are required to initiate the end-of-recovery procedure. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ServiceState_GetConstitution (removed)
Description :  Retrieve the constitution which controls governance changes on this service.
Reference :  Link ¶

⚼ Request

GET:  /gov/service/constitution
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history. ,
}
string ,
}
,
$schema:
{
Description: Constitution used to make governance decisions on the service. All governance changes are presented as proposals which must be validated, approved, and applied by the code in this constitution. ,
}
{
constitution:
{
Description: Javascript source code of constitution. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ServiceState_GetServiceInfo (removed)
Description :  Returns general information about the service, including whether it is a recovery or original service.
Reference :  Link ¶

⚼ Request

GET:  /gov/service/info
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history. ,
}
string ,
}
,
$schema:
{
Description: General information about the current service. ,
}
{
status:
{
Description: Lifetime stage of the service. ,
Enum:
{
Opening: Services which have not yet passed a `transition_service_to_open` proposal. ,
Open: Services which are operating normally and accepting user transactions. ,
WaitingForRecoveryShares: Recovered services which cannot yet access private state. ,
Recovering: Recovered services which are actively replaying transactions from previous service, to reach the same state. ,
}
,
Required: True ,
}
enum ,
certificate:
{
Description: The current service identity. This is the public face of a secret key shared only by the nodes within the service, and should be used to authenticate TLS sessions with this service. ,
Required: True ,
}
string ,
recoveryCount:
{
Description: Records how many predecessors this service has. While the service identity certificate will change on any recovery, this allows users to determine exactly how many such recoveries have occurred. ,
Format: int64 ,
Required: True ,
}
integer ,
creationTransactionId:
{
Description: Transaction ID at which this service was first created. If this is a recovery of a previous service, this will indicate when the current service was recovered. ,
Required: True ,
}
string ,
previousServiceCreationTransactionId:
{
Description: Transaction ID at which the predecessor service was created, if this service is a recovery. If this is an original service rather than a recovery, this will be omitted. ,
Required: False ,
}
string ,
serviceData:
{
Description: Arbitrary service-defined metadata about this service. May be used by constitution or application code, but will not affect any core framework decisions. ,
Required: False ,
}
string ,
configuration:
{
Description: Lists governance-controlled configuration parameters of this service, which will be used by core framework code. ,
Required: True ,
}
{
maximumNodeCertificateValidityDays:
{
Description: A non-negative JSON-safe integer (ie max is 2^53 - 1) ,
Format: int64 ,
Required: True ,
}
integer ,
recentCoseProposalsWindowSize:
{
Description: A non-negative JSON-safe integer (ie max is 2^53 - 1) ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ServiceState_GetJsApp (removed)
Description :  Retrieve details of Javascript application and execution engine.
Reference :  Link ¶

⚼ Request

GET:  /gov/service/javascript-app
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history. ,
}
string ,
}
,
$schema:
{
Description: Describes the currently installed JavaScript application. ,
}
{
endpoints:
{
Description: The collection of endpoints exposed by the application. Keyed by path. ,
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ServiceState_GetJoinPolicies (removed)
Description :  Retrieve policy data which determines whether new nodes are permitted to join the service. This describes the hardware attestations which are acceptable to the service, demonstrating a joining node is running approved code.
Reference :  Link ¶

⚼ Request

GET:  /gov/service/join-policy
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history. ,
}
string ,
}
,
$schema:
{
Description: Collection of all policies which determine currently acceptable nodes, across multiple platforms. ,
}
{
sgx:
{
Description: Policy applied to nodes running in SGX enclaves. ,
Required: True ,
}
{
measurements:
{
Description: Code measurements of acceptable enclaves. ,
Required: True ,
}
[
string ,
]
,
}
,
snp:
{
Description: Policy applied to nodes running in AMD SEV-SNP containers. ,
Required: True ,
}
{
measurements:
{
Description: Code measurements of acceptable enclaves. ,
Required: True ,
}
[
string ,
]
,
hostData:
{
Description: Collection of acceptable host data values. ,
Required: True ,
}
object ,
uvmEndorsements:
{
Description: Collection of acceptable UVM endorsements. ,
Required: True ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ServiceState_GetJwkInfo (removed)
Description :  Returns information about OpenID Connect identity providers.
Reference :  Link ¶

⚼ Request

GET:  /gov/service/jwk
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history. ,
}
string ,
}
,
$schema:
{
Description: Describes what Javascript Web Tokens (JWTs) are accepted by the service, and how they will be validated. ,
}
{
issuers:
{
Description: Collection of JWT issuers. Keyed by issuer ID. ,
Required: True ,
}
object ,
caCertBundles:
{
Description: Collection of CAs used to authenticate connections with issuers. Keyed by governance-controlled bundle names. ,
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ServiceState_ListMembers (removed)
Description :  Retrieve list of all members who govern this service.
Reference :  Link ¶

⚼ Request

GET:  /gov/service/members
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of Member items ,
}
{
value:
{
Description: The Member items on this page ,
Required: True ,
}
[
{
memberId:
{
Description: ID of CCF member who this object refers to. ,
Required: True ,
}
string ,
status:
{
Description: Current status of this member. ,
Enum:
{
Accepted: Member has been approved to join the service, but have not yet submitted an ACK to indicate their participation. These members should not be considered by constitutions in quorum calculations, and their signed requests will be rejected until they become Active. ,
Active: Member has submitted a valid ACK and is a full voting participant. ,
}
,
Required: True ,
}
enum ,
memberData:
{
Description: Arbitrary service-defined metadata about this member. May be used by constitution or application code, but will not affect any core framework decisions. ,
Required: False ,
}
string ,
certificate:
{
Description: x509 certificate used as this member's identity. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ServiceState_GetMember (removed)
Description :  Retrieve a single governing member, by ID.
Reference :  Link ¶

⚼ Request

GET:  /gov/service/members/{memberId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
memberId:
{
Description: ID of CCF member who this object refers to. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history. ,
}
string ,
}
,
$schema:
{
Description: Information on individual members within a consortium. ,
}
{
memberId:
{
Description: ID of CCF member who this object refers to. ,
Required: True ,
}
string ,
status:
{
Description: Current status of this member. ,
Enum:
{
Accepted: Member has been approved to join the service, but have not yet submitted an ACK to indicate their participation. These members should not be considered by constitutions in quorum calculations, and their signed requests will be rejected until they become Active. ,
Active: Member has submitted a valid ACK and is a full voting participant. ,
}
,
Required: True ,
}
enum ,
memberData:
{
Description: Arbitrary service-defined metadata about this member. May be used by constitution or application code, but will not affect any core framework decisions. ,
Required: False ,
}
string ,
certificate:
{
Description: x509 certificate used as this member's identity. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ServiceState_ListNodes (removed)
Description :  Retrieve list of all nodes participating in this service.
Reference :  Link ¶

⚼ Request

GET:  /gov/service/nodes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of Node items ,
}
{
value:
{
Description: The Node items on this page ,
Required: True ,
}
[
{
nodeId:
{
Description: ID of CCF node who this object refers to. ,
Required: True ,
}
string ,
status:
{
Description: Current status of this node. ,
Enum:
{
Pending: Indicates a node which has successfully completed a join request to the service (including attestation checks), but has not yet been approved by governance. ,
Trusted: Indicates a node which has been approved by governance, and is a full participant in the service. ,
Retired: Indicates a node which has been removed from a service by a reconfiguration. ,
}
,
Required: True ,
}
enum ,
nodeData:
{
Description: Arbitrary service-defined metadata about this node. May be used by constitution or application code, but will not affect any core framework decisions. ,
Required: False ,
}
string ,
certificate:
{
Description: x509 certificate containing this node's identity. ,
Required: True ,
}
string ,
retiredCommitted:
{
Description: This is false during node's normal operation. It transitions to true once the node has been retired, and that retirement has been committed by the service. At this point it is safe to terminate a node. Terminating a node any earlier may affect liveness of the service. ,
Required: True ,
}
boolean ,
quoteInfo:
{
Description: Contains this node's hardware attestation. This is generated during node startup, and must meet the current join policy restrictions for the node to successfully join a service. ,
Required: True ,
}
{
format:
{
Description: Discriminator property for QuoteInfo. ,
Required: True ,
}
string ,
}
,
rpcInterfaces:
{
Description: A collection of interfaces by which this node may be contacted. Some may be limited to private networks, and others may be DNS names or internet-public network addresses. The keys are arbitrary strings determined by the node operator. ,
Required: True ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ServiceState_GetNode (removed)
Description :  Retrieve a single node, by ID.
Reference :  Link ¶

⚼ Request

GET:  /gov/service/nodes/{nodeId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
nodeId:
{
Description: ID of CCF node who this object refers to. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history. ,
}
string ,
}
,
$schema:
{
Description: Information on individual nodes within a service. ,
}
{
nodeId:
{
Description: ID of CCF node who this object refers to. ,
Required: True ,
}
string ,
status:
{
Description: Current status of this node. ,
Enum:
{
Pending: Indicates a node which has successfully completed a join request to the service (including attestation checks), but has not yet been approved by governance. ,
Trusted: Indicates a node which has been approved by governance, and is a full participant in the service. ,
Retired: Indicates a node which has been removed from a service by a reconfiguration. ,
}
,
Required: True ,
}
enum ,
nodeData:
{
Description: Arbitrary service-defined metadata about this node. May be used by constitution or application code, but will not affect any core framework decisions. ,
Required: False ,
}
string ,
certificate:
{
Description: x509 certificate containing this node's identity. ,
Required: True ,
}
string ,
retiredCommitted:
{
Description: This is false during node's normal operation. It transitions to true once the node has been retired, and that retirement has been committed by the service. At this point it is safe to terminate a node. Terminating a node any earlier may affect liveness of the service. ,
Required: True ,
}
boolean ,
quoteInfo:
{
Description: Contains this node's hardware attestation. This is generated during node startup, and must meet the current join policy restrictions for the node to successfully join a service. ,
Required: True ,
}
{
format:
{
Description: Discriminator property for QuoteInfo. ,
Required: True ,
}
string ,
}
,
rpcInterfaces:
{
Description: A collection of interfaces by which this node may be contacted. Some may be limited to private networks, and others may be DNS names or internet-public network addresses. The keys are arbitrary strings determined by the node operator. ,
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Transactions_Get (removed)
Description :  Get status of transaction by transaction ID, to determine whether it has committed.
Reference :  Link ¶

⚼ Request

GET:  /gov/service/transactions/{transactionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
transactionId:
{
Description: Identifier of the requested transaction. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of this transaction. ,
Enum:
{
Unknown: This is not a transaction the current node knows, but could exist in future. This may be returned when a transaction is created on one node then immediately queried on another, before it has been replicated. ,
Pending: This transaction is known on the current node, but has not yet been committed. This is expected to be a temporary state. ,
Committed: This transaction is known on the current node, and known to be committed. This means it has been replicated to a quorum of nodes, so will persist through future elections. Committed is a terminal state of this state machine. ,
Invalid: This transaction ID will never commit in the current service, because it contains a different term than a known transaction with the same sequence number. This can occur for a transaction ID returned from the service (ie - which was previously Unknown or Pending), if that transaction is lost during a consensus election. This should be rare. Invalid is a terminal state of this state machine. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Transactions_GetCommit (removed)
Description :  Get latest committed transaction.
Reference :  Link ¶

⚼ Request

GET:  /gov/service/transactions/commit
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
transactionId:
{
Description: Identifier of committed transaction. ,
Required: True ,
}
string ,
status:
{
Description: Status of this transaction. ,
Enum:
{
Unknown: This is not a transaction the current node knows, but could exist in future. This may be returned when a transaction is created on one node then immediately queried on another, before it has been replicated. ,
Pending: This transaction is known on the current node, but has not yet been committed. This is expected to be a temporary state. ,
Committed: This transaction is known on the current node, and known to be committed. This means it has been replicated to a quorum of nodes, so will persist through future elections. Committed is a terminal state of this state machine. ,
Invalid: This transaction ID will never commit in the current service, because it contains a different term than a known transaction with the same sequence number. This can occur for a transaction ID returned from the service (ie - which was previously Unknown or Pending), if that transaction is lost during a consensus election. This should be rare. Invalid is a terminal state of this state machine. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}