Get metadata for all channels
Returns metadata for all channels, optionally including custom properties.
Path Parameters |
---|
sub_key string — REQUIREDYour app's subscribe key from Admin Portal. |
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. |
limit integerPossible values: value ≤ 100 Number of objects to return in response. Default is |
start stringPreviously-returned cursor bookmark for fetching the next page. |
end stringPreviously-returned cursor bookmark for fetching the previous page. Ignored if you also supply the start parameter. |
count booleanRequest |
filter stringExpression used to filter the results. Only objects whose properties satisfy the given expression are returned. For details on [App Context Filtering], refer to documentation. Note the following:
Example (Simple expression): custom.public == true Example (Date/time comparison): updated >= "2019-08-31T00:00:00Z" Example (Compound expression): description == null && (custom.label != "" || custom.description != "") Example (Wildcard): name LIKE 'X*' Example (Escaped wildcard): name LIKE '*\\**' |
sort string[]Possible values: Value must match regular expression List of properties to sort by.
Append Example: id,name:desc,updated,status,type |
auth stringString which is either the auth key (PAM v2) 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 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
200 Successfully returned the list of channel metadata.
| ||||||||||||||
304 Requested resource has not been modified since the last retrieval. | ||||||||||||||
403 Disabled - 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.
| ||||||||||||||
429 Request rate limit exceeded.
| ||||||||||||||
500 An internal server error occurred.
| ||||||||||||||
503 Request processing exceeded the maximum allowed time.
|