For the complete documentation index, see llms.txt. This page is also available as Markdown.

Record

Get recording or running status.

get

Get recording or running status. Policy must be in dry-run mode, otherwise returns 403 "Invalid status.". Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Responses
get
/record/{policyId}/status

Start recording.

post

Start recording. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Body
object · ObjectOptional
Responses
post
/record/{policyId}/recording/start

Stop recording.

post

Stop recording. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Body
object · ObjectOptional
Responses
post
/record/{policyId}/recording/stop

Get recorded actions.

get

Get recorded actions. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Responses
get
/record/{policyId}/recording/actions

Run record from a zip file.

post

Run record from a zip file. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Query parameters
importRecordsstringRequired
syncNewRecordsstringRequired
fromPolicyIdstringRequired
Body
stringOptional
Responses
post
/record/{policyId}/running/start

Stop running.

post

Stop running. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Body
object · ObjectOptional
Responses
post
/record/{policyId}/running/stop

Get running results.

get

Get running results. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Responses
get
/record/{policyId}/running/results

Get documents produced by a recorded action.

get

Returns all VC and VP documents from the dry-run store that share the given recordActionId. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Query parameters
recordActionIdstringRequired

Record action UUID

Responses
get
/record/{policyId}/recording/action-documents

Get running details.

get

Get running details. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Responses
get
/record/{policyId}/running/details

Fast Forward.

post

Fast Forward. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Body
object · ObjectOptional
Responses
post
/record/{policyId}/running/fast-forward

Retry step.

post

Retry step. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Body
object · ObjectOptional
Responses
post
/record/{policyId}/running/retry

Skip step.

post

Skip step. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Body
object · ObjectOptional
Responses
post
/record/{policyId}/running/skip

Last updated