Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Protocol local ID

Body

application/json

Refresh options

Options of a protocol refresh.

dry_run
boolean
default:false

Run every check and report update_available without writing.

Response

Refresh result

Outcome of a protocol refresh.

dry_run
boolean
required
Example:

true

protocol
ProtocolSummary · object
required

Summary of an imported or created protocol.

status
enum<string>
required

unchanged: the URL serves the stored document. update_available: a dry run found a changed document that passes every check. updated: the changed document was stored as the next revision.

Available options:
unchanged,
update_available,
updated
Example:

"update_available"