CAcargill
Scabbard

Submit a list of batches to the Scabbard service

Changed on

This endpoint can be used to submit batches to a Scabbard service. The body of the request must be a list of valid Sabre batches. If the batches are submitted successfully, the response will contain a link for checking the status of the submitted batches.

This endpoint requires the permission "scabbard.write".

post/scabbard/{circuit}/{service_id}/batches

Request

  • Base URL
    http://localhost:9000/api
  • URL
    http://localhost:9000/api/scabbard/{circuit}/{service_id}/batches
  • Auth
    none declared. Required headers: Authorization

Path parameters

circuitstring required

Circuit the targeted service belongs to

service_idstring required

ID of the targeted service

Headers

Authorizationstring required

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersioninteger
Example:2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Response

Batch was submitted successfully

linkstring

Link to get status of batches that were submitted

Example response

{
  "link": "/scabbard/abcde-01234/ABCD/batch_statuses?ids=6ff35474a572087e08fd6a54d563bd8172951b363e5c9731f1a40a855e14bba45dac515364a08d8403f4fb5d4a206174b7f63c29e4f4e425dc71b95494b8a798"
}

Changes