Channels
post/api/v2/channels

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Request body

fqcnstring required

Channel type

useAnonymousExtChannelboolean

Use anonymous external channels

messageFormsboolean

Create message forms

payloadEncryptionboolean required

Channel encryption

type'sub' | 'pub' | 'download' | 'upload' required

Channel type

Example request

{
  "fqcn": "channel.name",
  "useAnonymousExtChannel": true,
  "messageForms": true,
  "payloadEncryption": true,
  "type": "sub",
  "conditions": {
    "dids": [
      "did:ethr:volta:0x09Df5d33f1242E1b8aA5E0E0F6BfA687E6846993"
    ],
    "roles": [
      "marketoperator.roles"
    ],
    "topics": [
      {
        "topicName": "operatorEnvelope",
        "owner": "aemo.edge"
      }
    ],
    "responseTopics": [
      {
        "topicName": "operatorEnvelope",
        "owner": "aemo.edge",
        "responseTopicId": "id"
      }
    ]
  }
}

Response

Channel successfully created

ChannelEntity required

Changes

    • breaking

      the ///// request property type changed from object to array

    • breaking

      added the new required request property /////

    • info

      added the new optional request property