Get channel metadata

Returns metadata for the specified channel, optionally including custom properties.

Path Parameters
`sub_key` string — REQUIRED Your app's subscribe key from Admin Portal.
`channel` string — REQUIRED The channel name to perform the operation on. Must not be empty and can contain up to 92 UTF-8 byte sequences. Prohibited characters are: `,`, `/`, `\`, `*`, `:`, channel, non-printable ASCII control characters, and Unicode zero.

Query Parameters
`include` string[] Possible values: [`custom`, `type`, `status`] List of additional/complex metadata to include in the response. Omit this query parameter if you don't want to retrieve additional metadata.
`auth` string String 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` string Signature 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` integer Unix epoch timestamp used as a nonce for signature computation. Must have no more than ± 60 seconds offset from NTP. Required if `signature` parameter is supplied.

Responses

200

Successfully returned metadata for the requested channel.

Schema — OPTIONAL

status integer — OPTIONAL

HTTP status code.

data object

Object with channel metadata used in responses.

id string — OPTIONAL

Possible values: 1 ≤ length ≤ 92

The channel name to perform the operation on. Must not be empty, and may contain up to 92 UTF-8 byte sequences.

Prohibited characters are: ,, /, \, *, :, channel, non-printable ASCII control characters, and Unicode zero.

updated date-time

Date and time the object was last updated.

eTag string

Information on the object's content fingerprint.

NOTE: eTag from GET requests can be used alongside the If-Match HTTP header in conditional PATCH requests in users/channels' metadata APIs. This functionality is currently not supported in the membership/members' metadata APIs.

name string — OPTIONAL

Possible values: 1 ≤ length

The channel name to perform the operation on. Max. 2,048 characters. Must not be empty or consist only of whitespace characters.

description string — OPTIONAL

Description of the channel. Max. 2,048 characters.

type string — OPTIONAL

Channel type. Max. 50 characters.

status string — OPTIONAL

Channel status. Max. 50 characters.

custom object — OPTIONAL

JSON object of key/value pairs with supported data-types. Values must be scalar only; arrays or objects are not supported.

NOTE: If you set custom fields with integer values, do not specify numbers larger than 9007199254740991 due to precision limitations in JSON implementations. For large integer values, for example PubNub timetoken values, use string values instead of integers.

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.

Schema — OPTIONAL

status integer — OPTIONAL

HTTP status code.

error object — OPTIONAL

Error response.

message string — OPTIONAL

User-facing error message.

source string — OPTIONAL

Possible values: [metadata, authz]

Internal source of the error.

details object[] — OPTIONAL

message string — OPTIONAL

A user-facing error message.

location string — OPTIONAL

Name of the offending query string parameter, or a dot-delimited JSON path to the source of the error in the input document, if applicable.

locationType string — OPTIONAL

Possible values: [path, query, header, body]

404

The requested resource was not found.

Schema — OPTIONAL

status integer — OPTIONAL

HTTP status code.

error object — OPTIONAL

Error response.

message string — OPTIONAL

User-facing error message.

source string — OPTIONAL

Possible values: [metadata, authz]

Internal source of the error.

details object[] — OPTIONAL

message string — OPTIONAL

A user-facing error message.

location string — OPTIONAL

Name of the offending query string parameter, or a dot-delimited JSON path to the source of the error in the input document, if applicable.

locationType string — OPTIONAL

Possible values: [path, query, header, body]

429

Request rate limit exceeded.

Schema — OPTIONAL

status integer — OPTIONAL

HTTP status code.

error object — OPTIONAL

Error response.

message string — OPTIONAL

User-facing error message.

source string — OPTIONAL

Possible values: [metadata, authz]

Internal source of the error.

details object[] — OPTIONAL

message string — OPTIONAL

A user-facing error message.

location string — OPTIONAL

Name of the offending query string parameter, or a dot-delimited JSON path to the source of the error in the input document, if applicable.

locationType string — OPTIONAL

Possible values: [path, query, header, body]

500

An internal server error occurred.

Schema — OPTIONAL

status integer — OPTIONAL

HTTP status code.

error object — OPTIONAL

Error response.

message string — OPTIONAL

User-facing error message.

source string — OPTIONAL

Possible values: [metadata, authz]

Internal source of the error.

details object[] — OPTIONAL

message string — OPTIONAL

A user-facing error message.

location string — OPTIONAL

Name of the offending query string parameter, or a dot-delimited JSON path to the source of the error in the input document, if applicable.

locationType string — OPTIONAL

Possible values: [path, query, header, body]

503

Request processing exceeded the maximum allowed time.

Schema — OPTIONAL

status integer — OPTIONAL

HTTP status code.

error object — OPTIONAL

Error response.

message string — OPTIONAL

User-facing error message.

source string — OPTIONAL

Possible values: [metadata, authz]

Internal source of the error.

details object[] — OPTIONAL

message string — OPTIONAL

A user-facing error message.

location string — OPTIONAL

Name of the offending query string parameter, or a dot-delimited JSON path to the source of the error in the input document, if applicable.

locationType string — OPTIONAL

Possible values: [path, query, header, body]