Pegasys Orchestrate REST API (latest - e09e1ff5)

Download OpenAPI specification:Download

✉ PegaSys Orchestrate: support@pegasys.tech

Authentication

ApiKeyAuth

Security Scheme Type API Key
Header parameter name: X-API-Key

JWTAuth

Security Scheme Type API Key
Header parameter name: Authorization

Chain Registry

Retrieves a list of all registered chains

Authorizations:

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Registers a new chain

Authorizations:
Request Body schema: application/json

Chain registration request

object
name
required
string
object
urls
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "listener":
    {
    },
  • "name": "string",
  • "privateTxManager":
    {
    },
  • "urls":
    [
    ]
}

Response samples

Content type
application/json
{
  • "chainID": "string",
  • "createdAt": "string",
  • "listenerBackOffDuration": "string",
  • "listenerCurrentBlock": "0",
  • "listenerDepth": 0,
  • "listenerExternalTxEnabled": true,
  • "listenerStartingBlock": "0",
  • "name": "string",
  • "privateTxManagers":
    [
    ],
  • "tenantID": "string",
  • "updatedAt": "string",
  • "urls":
    [
    ],
  • "uuid": "string"
}

Retrieves a chain by ID

Authorizations:
path Parameters
uuid
required
string

ID of the chain

Responses

Response samples

Content type
application/json
{
  • "chainID": "string",
  • "createdAt": "string",
  • "listenerBackOffDuration": "string",
  • "listenerCurrentBlock": "0",
  • "listenerDepth": 0,
  • "listenerExternalTxEnabled": true,
  • "listenerStartingBlock": "0",
  • "name": "string",
  • "privateTxManagers":
    [
    ],
  • "tenantID": "string",
  • "updatedAt": "string",
  • "urls":
    [
    ],
  • "uuid": "string"
}

Deletes a chain by ID

Authorizations:
path Parameters
uuid
required
string

ID of the chain

Responses

Response samples

Content type
application/json
{
  • "code": 24000,
  • "message": "invalid status update for the current job state"
}

Updates a chain by ID

Authorizations:
path Parameters
uuid
required
string

ID of the chain

Request Body schema: application/json

Chain update request

object
name
string
object
urls
Array of strings

Responses

Request samples

Content type
application/json
{
  • "listener":
    {
    },
  • "name": "string",
  • "privateTxManager":
    {
    },
  • "urls":
    [
    ]
}

Response samples

Content type
application/json
{
  • "chainID": "string",
  • "createdAt": "string",
  • "listenerBackOffDuration": "string",
  • "listenerCurrentBlock": "0",
  • "listenerDepth": 0,
  • "listenerExternalTxEnabled": true,
  • "listenerStartingBlock": "0",
  • "name": "string",
  • "privateTxManagers":
    [
    ],
  • "tenantID": "string",
  • "updatedAt": "string",
  • "urls":
    [
    ],
  • "uuid": "string"
}