Send publish request for a set of policy rules
POST {{baseUrl}}/tap/publish
Send publish request of set of policy rules and returns the response.
Note: These endpoints are currently in beta and might be subject to changes.
If you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.
Request Body
{"rules"=>[{"type"=>"TRANSFER", "action"=>"BLOCK", "asset"=>"<string>", "amountCurrency"=>"NATIVE", "amountScope"=>"SINGLE_TX", "amount"=>"<string>", "periodSec"=>"<number>", "operator"=>"<string>", "operators"=>{"wildcard"=>"*", "users"=>["<string>", "<string>"], "usersGroups"=>["<string>", "<string>"], "services"=>["<string>", "<string>"]}, "transactionType"=>"REDEEM", "designatedSigner"=>"<string>", "designatedSigners"=>{"users"=>["<string>", "<string>"], "usersGroups"=>["<string>", "<string>"]}, "srcType"=>"VAULT", "srcSubType"=>"CONTRACT", "srcId"=>"<string>", "src"=>{"ids"=>[["<string>"], ["<string>"]]}, "dstType"=>"NETWORK_CONNECTION", "dstSubType"=>"INTERNAL", "dstId"=>"<string>", "dst"=>{"ids"=>[["<string>"], ["<string>"]]}, "dstAddressType"=>"ONE_TIME", "authorizers"=>["<string>", "<string>"], "authorizersCount"=>"<number>", "authorizationGroups"=>{"logic"=>"AND", "allowOperatorAsAuthorizer"=>"<boolean>", "groups"=>[{"users"=>["<string>", "<string>"], "usersGroups"=>["<string>", "<string>"], "th"=>"<number>"}, {"users"=>["<string>", "<string>"], "usersGroups"=>["<string>", "<string>"], "th"=>"<number>"}]}, "amountAggregation"=>{"operators"=>"PER_SINGLE_MATCH", "srcTransferPeers"=>"PER_SINGLE_MATCH", "dstTransferPeers"=>"ACROSS_ALL_MATCHES"}, "rawMessageSigning"=>{"algorithm"=>"<string>", "derivationPath"=>{"path"=>["<number>", "<number>"]}}, "applyForApprove"=>"<boolean>", "applyForTypedMessage"=>"<boolean>", "externalDescriptor"=>"<string>"}, {"type"=>"TRANSFER", "action"=>"ALLOW", "asset"=>"<string>", "amountCurrency"=>"USD", "amountScope"=>"SINGLE_TX", "amount"=>"<string>", "periodSec"=>"<number>", "operator"=>"<string>", "operators"=>{"wildcard"=>"*", "users"=>["<string>", "<string>"], "usersGroups"=>["<string>", "<string>"], "services"=>["<string>", "<string>"]}, "transactionType"=>"CONTRACT_CALL", "designatedSigner"=>"<string>", "designatedSigners"=>{"users"=>["<string>", "<string>"], "usersGroups"=>["<string>", "<string>"]}, "srcType"=>"*", "srcSubType"=>"EXCHANGETEST", "srcId"=>"<string>", "src"=>{"ids"=>[["<string>"], ["<string>"]]}, "dstType"=>"VAULT", "dstSubType"=>"INTERNAL", "dstId"=>"<string>", "dst"=>{"ids"=>[["<string>"], ["<string>"]]}, "dstAddressType"=>"ONE_TIME", "authorizers"=>["<string>", "<string>"], "authorizersCount"=>"<number>", "authorizationGroups"=>{"logic"=>"OR", "allowOperatorAsAuthorizer"=>"<boolean>", "groups"=>[{"users"=>["<string>", "<string>"], "usersGroups"=>["<string>", "<string>"], "th"=>"<number>"}, {"users"=>["<string>", "<string>"], "usersGroups"=>["<string>", "<string>"], "th"=>"<number>"}]}, "amountAggregation"=>{"operators"=>"PER_SINGLE_MATCH", "srcTransferPeers"=>"ACROSS_ALL_MATCHES", "dstTransferPeers"=>"ACROSS_ALL_MATCHES"}, "rawMessageSigning"=>{"algorithm"=>"<string>", "derivationPath"=>{"path"=>["<number>", "<number>"]}}, "applyForApprove"=>"<boolean>", "applyForTypedMessage"=>"<boolean>", "externalDescriptor"=>"<string>"}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Idempotency-Key | string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"status":"AWAITING_QUORUM","rules":[{"type":"TRANSFER","action":"2-TIER","asset":"\u003cstring\u003e","amountCurrency":"EUR","amountScope":"SINGLE_TX","amount":"\u003cstring\u003e","periodSec":"\u003cnumber\u003e","operator":"\u003cstring\u003e","operators":{"wildcard":"*","users":["\u003cstring\u003e","\u003cstring\u003e"],"usersGroups":["\u003cstring\u003e","\u003cstring\u003e"],"services":["\u003cstring\u003e","\u003cstring\u003e"]},"transactionType":"TRANSFER","designatedSigner":"\u003cstring\u003e","designatedSigners":{"users":["\u003cstring\u003e","\u003cstring\u003e"],"usersGroups":["\u003cstring\u003e","\u003cstring\u003e"]},"srcType":"FIAT_ACCOUNT","srcSubType":"CONTRACT","srcId":"\u003cstring\u003e","src":{"ids":[["\u003cstring\u003e"],["\u003cstring\u003e"]]},"dstType":"UNMANAGED","dstSubType":"EXCHANGETEST","dstId":"\u003cstring\u003e","dst":{"ids":[["\u003cstring\u003e"],["\u003cstring\u003e"]]},"dstAddressType":"ONE_TIME","authorizers":["\u003cstring\u003e","\u003cstring\u003e"],"authorizersCount":"\u003cnumber\u003e","authorizationGroups":{"logic":"OR","allowOperatorAsAuthorizer":"\u003cboolean\u003e","groups":[{"users":["\u003cstring\u003e","\u003cstring\u003e"],"usersGroups":["\u003cstring\u003e","\u003cstring\u003e"],"th":"\u003cnumber\u003e"},{"users":["\u003cstring\u003e","\u003cstring\u003e"],"usersGroups":["\u003cstring\u003e","\u003cstring\u003e"],"th":"\u003cnumber\u003e"}]},"amountAggregation":{"operators":"PER_SINGLE_MATCH","srcTransferPeers":"ACROSS_ALL_MATCHES","dstTransferPeers":"ACROSS_ALL_MATCHES"},"rawMessageSigning":{"algorithm":"\u003cstring\u003e","derivationPath":{"path":["\u003cnumber\u003e","\u003cnumber\u003e"]}},"applyForApprove":"\u003cboolean\u003e","applyForTypedMessage":"\u003cboolean\u003e","externalDescriptor":"\u003cstring\u003e"},{"type":"TRANSFER","action":"2-TIER","asset":"\u003cstring\u003e","amountCurrency":"NATIVE","amountScope":"TIMEFRAME","amount":"\u003cstring\u003e","periodSec":"\u003cnumber\u003e","operator":"\u003cstring\u003e","operators":{"wildcard":"*","users":["\u003cstring\u003e","\u003cstring\u003e"],"usersGroups":["\u003cstring\u003e","\u003cstring\u003e"],"services":["\u003cstring\u003e","\u003cstring\u003e"]},"transactionType":"SUPPLY","designatedSigner":"\u003cstring\u003e","designatedSigners":{"users":["\u003cstring\u003e","\u003cstring\u003e"],"usersGroups":["\u003cstring\u003e","\u003cstring\u003e"]},"srcType":"COMPOUND","srcSubType":"EXTERNAL","srcId":"\u003cstring\u003e","src":{"ids":[["\u003cstring\u003e"],["\u003cstring\u003e"]]},"dstType":"EXCHANGE","dstSubType":"EXCHANGETEST","dstId":"\u003cstring\u003e","dst":{"ids":[["\u003cstring\u003e"],["\u003cstring\u003e"]]},"dstAddressType":"ONE_TIME","authorizers":["\u003cstring\u003e","\u003cstring\u003e"],"authorizersCount":"\u003cnumber\u003e","authorizationGroups":{"logic":"OR","allowOperatorAsAuthorizer":"\u003cboolean\u003e","groups":[{"users":["\u003cstring\u003e","\u003cstring\u003e"],"usersGroups":["\u003cstring\u003e","\u003cstring\u003e"],"th":"\u003cnumber\u003e"},{"users":["\u003cstring\u003e","\u003cstring\u003e"],"usersGroups":["\u003cstring\u003e","\u003cstring\u003e"],"th":"\u003cnumber\u003e"}]},"amountAggregation":{"operators":"PER_SINGLE_MATCH","srcTransferPeers":"ACROSS_ALL_MATCHES","dstTransferPeers":"PER_SINGLE_MATCH"},"rawMessageSigning":{"algorithm":"\u003cstring\u003e","derivationPath":{"path":["\u003cnumber\u003e","\u003cnumber\u003e"]}},"applyForApprove":"\u003cboolean\u003e","applyForTypedMessage":"\u003cboolean\u003e","externalDescriptor":"\u003cstring\u003e"}],"checkResult":{"errors":"\u003cnumber\u003e","results":[{"index":"\u003cnumber\u003e","status":"failure","errors":[{"errorMessage":"\u003cstring\u003e","errorCode":"\u003cnumber\u003e","errorCodeName":"\u003cstring\u003e","errorField":"designatedSigners"},{"errorMessage":"\u003cstring\u003e","errorCode":"\u003cnumber\u003e","errorCodeName":"\u003cstring\u003e","errorField":"operator"}]},{"index":"\u003cnumber\u003e","status":"ok","errors":[{"errorMessage":"\u003cstring\u003e","errorCode":"\u003cnumber\u003e","errorCodeName":"\u003cstring\u003e","errorField":"amountAggregation"},{"errorMessage":"\u003cstring\u003e","errorCode":"\u003cnumber\u003e","errorCodeName":"\u003cstring\u003e","errorField":"amountAggregation"}]}]},"metadata":{"editedBy":"\u003cstring\u003e","editedAt":"\u003cstring\u003e","publishedBy":"\u003cstring\u003e","publishedAt":"\u003cstring\u003e"}}