Pegasys Orchestrate REST API (latest - 87989469)

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

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":
    [
    ]
}

Retrieves a chain by ID

Authorizations:
path Parameters
uuid
required
string

ID of the chain

Responses

Deletes a chain by ID

Authorizations:
path Parameters
uuid
required
string

ID of the chain

Responses

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":
    [
    ]
}

Retrieves a list of all registered faucet

Authorizations:

Responses

Registers a new faucet

Authorizations:
Request Body schema: application/json

Faucet registration request

amount
required
string
chainRule
required
string
cooldown
required
string
creditorAccount
required
string
maxBalance
required
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "chainRule": "string",
  • "cooldown": "string",
  • "creditorAccount": "string",
  • "maxBalance": "string",
  • "name": "string"
}

Retrieves a faucet by ID

path Parameters
uuid
required
string

ID of the faucet

Responses

Deletes a faucet by ID

Authorizations:
path Parameters
uuid
required
string

ID of the faucet

Responses

Updates a faucet by ID

Authorizations:
path Parameters
uuid
required
string

ID of the faucet

Request Body schema: application/json

Faucet update request

amount
string
chainRule
string
cooldown
string
creditorAccount
string
maxBalance
string
name
string

Responses

Request samples

Content type
application/json
{