Get channel metadata
Returns metadata for the specified channel, optionally including custom properties.
| Path Parameters |
|---|
sub_key string — REQUIREDYour app's subscribe key from Admin Portal. |
channel string — REQUIREDThe channel ID to perform the operation on. Must not be empty and can contain up to 92 UTF-8 byte sequences. Prohibited characters are: |
| Query Parameters |
|---|
include string[]Possible values: [ List of additional/complex metadata to include in the response. Omit this query parameter if you don't want to retrieve additional metadata. |
auth stringString which is either the auth key (Access Manager legacy) or a valid token (Access Manager) used to authorize the operation if access control is enabled. Authorization token with permissions to perform the request. |
signature stringSignature used to verify that the request was signed with the secret key associated with the subscribe key. If Access Manager is enabled, either a valid authorization token or a signature are required. Check Access Manager documentation for details on how to compute the signature. |
timestamp integerUnix epoch timestamp used as a nonce for signature computation. Must have no more than ± 60 seconds offset from NTP.
Required if |
| Responses | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
200Successfully returned metadata for the requested channel.
| |||||||||||
304Requested resource has not been modified since the last retrieval. | |||||||||||
403Disabled - The subscribe key doesn't have App Context API enabled. Forbidden - The client isn't authorized to perform this operation. The authorization key you provided doesn't have the required permissions for this operation.
| |||||||||||
404The requested resource was not found.
| |||||||||||
429Request rate limit exceeded.
| |||||||||||
500An internal server error occurred.
| |||||||||||
503Request processing exceeded the maximum allowed time.
|
sub_key*channel*Prohibited characters are:
,, /, \, *, :, channel, non-printable ASCII control characters, and Unicode zero.includeauthsignatureIf Access Manager is enabled, either a valid authorization token or a signature are required.
Check Access Manager documentation for details on how to compute the signature.
timestampRequired if
signature parameter is supplied.statusdata{"id":"myChannel3","name":"My channel","description":"A channel that is mine.","updated":"2019-02-20T23:11:20.893Z","eTag":"RTc1NUQwNUItREMyNy00Q0YxLUJCNDItMEZDMTZDMzVCN0VGCg=="}{
"status": 200,
"data": {
"id": "myChannel3",
"name": "My channel",
"description": "A channel that is mine.",
"updated": "2019-02-20T23:11:20.893Z",
"eTag": "RTc1NUQwNUItREMyNy00Q0YxLUJCNDItMEZDMTZDMzVCN0VGCg=="
}
}statuserror{
"status": 403,
"error": {
"message": "Invalid signature",
"source": "authz",
"details": [
{
"message": "Client and server produced different signatures for the same inputs.",
"location": "signature",
"locationType": "query"
}
]
}
}statuserror{
"status": 404,
"error": {
"message": "Requested resource was not found.",
"source": "metadata"
}
}statuserror{
"status": 429,
"error": {
"message": "You have exceeded the maximum number of requests per second allowed for your subscribe key.",
"source": "metadata"
}
}statuserror{
"status": 500,
"error": {
"message": "An unexpected error occurred while processing the request.",
"source": "metadata"
}
}statuserror{
"status": 503,
"error": {
"message": "The server took longer to respond than the maximum allowed processing time.",
"source": "metadata"
}
}