Channels

Read how a channel is shared with other projects

Lists only projects the caller can read; unreadable projects are neither named nor counted.

GET
/api/projects/{projectId}/channels/{channelId}/sharing

Authorization

headerAuthorizationBearer <Postdot API key>

A user-owned Postdot API key sent as Authorization: Bearer <token>. Its project scope is limited by the creator’s current access.

Path Parameters

projectId*string
Length1 <= length
channelId*string
Length1 <= length

Response Body

Response for status 200

application/json
  1. response
channel*
usages*array<>
Example Request
curl -X GET 'https://postdot.example/api/projects/string/channels/string/sharing'
Example Response
{
  "channel": {
    "id": "string",
    "revision": 0,
    "shared": true,
    "attachmentState": "active",
    "attachmentRevision": 0,
    "canManage": true,
    "canShare": true,
    "canWithdraw": true,
    "management": {
      "kind": "workspace"
    }
  },
  "usages": [
    {
      "projectId": "string",
      "name": "string",
      "state": "active",
      "revision": 0,
      "canAcceptManagement": true
    }
  ]
}

Was this page helpful?