200
Successfully returned metadata for the requested channel. Schema — OPTIONAL |
---|
status integer — OPTIONAL | data object — OPTIONALObject with channel metadata used in responses. id string — OPTIONALPossible 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 — OPTIONALDate and time the object was last updated. | eTag string — OPTIONALThe object's content fingerprint used in conditional requests. | name string — OPTIONALPossible values: 1 ≤ length The channel name to perform the operation on. Must not be empty or consist only of whitespace characters. | description string — OPTIONALDescription of the channel. | type string — OPTIONAL | status string — OPTIONAL | custom object — OPTIONALJSON object of key/value pairs with supported data-types. Values must be scalar only; arrays or objects are not supported. |
|
|
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 | error object — OPTIONALmessage string — OPTIONALUser-facing error message. | source string — OPTIONALPossible values: [metadata , authz ] Internal source of the error. | details object[] — OPTIONALmessage string — OPTIONALA user-facing error message. | location string — OPTIONALName 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 — OPTIONALPossible values: [path , query , header , body ] |
|
|
|
404
The requested resource was not found. Schema — OPTIONAL |
---|
status integer — OPTIONAL | error object — OPTIONALmessage string — OPTIONALUser-facing error message. | source string — OPTIONALPossible values: [metadata , authz ] Internal source of the error. | details object[] — OPTIONALmessage string — OPTIONALA user-facing error message. | location string — OPTIONALName 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 — OPTIONALPossible values: [path , query , header , body ] |
|
|
|
429
Request rate limit exceeded. Schema — OPTIONAL |
---|
status integer — OPTIONAL | error object — OPTIONALmessage string — OPTIONALUser-facing error message. | source string — OPTIONALPossible values: [metadata , authz ] Internal source of the error. | details object[] — OPTIONALmessage string — OPTIONALA user-facing error message. | location string — OPTIONALName 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 — OPTIONALPossible values: [path , query , header , body ] |
|
|
|
500
An internal server error occurred. Schema — OPTIONAL |
---|
status integer — OPTIONAL | error object — OPTIONALmessage string — OPTIONALUser-facing error message. | source string — OPTIONALPossible values: [metadata , authz ] Internal source of the error. | details object[] — OPTIONALmessage string — OPTIONALA user-facing error message. | location string — OPTIONALName 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 — OPTIONALPossible values: [path , query , header , body ] |
|
|
|
503
Request processing exceeded the maximum allowed time. Schema — OPTIONAL |
---|
status integer — OPTIONAL | error object — OPTIONALmessage string — OPTIONALUser-facing error message. | source string — OPTIONALPossible values: [metadata , authz ] Internal source of the error. | details object[] — OPTIONALmessage string — OPTIONALA user-facing error message. | location string — OPTIONALName 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 — OPTIONALPossible values: [path , query , header , body ] |
|
|
|