Sign in
Channels

Changed on
put/api/v2/channels/{fqcn}

Request

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

Path parameters

fqcnstring required

Channel type

Request body

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

Channel type

useAnonymousExtChannelboolean

Use anonymous external channels

messageFormsboolean

Enable message forms

payloadEncryptionboolean required

Channel encryption

Example request

{
  "type": "sub",
  "useAnonymousExtChannel": true,
  "messageForms": true,
  "payloadEncryption": true,
  "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 updated

ChannelEntity required

Changes