Skip to content

Get supported capabilities

Endpoint
GET /v1/capabilities

This endpoint informs clients of all capabilities supported by the server. This information MUST inform the client of any supported optional features as well as any configuration options associated with them.

Each capability is returned as an object containing key-value pairs representing the capability’s settings. Clients SHOULD use this information to adjust their behavior.

Client behavior

Clients SHOULD inform the user which features are supported by the server. Clients MAY also display information about relevant settings.

Server behavior

The server MUST respond with all supported optional features and any associated settings. If a feature isn’t enabled, the server MUST NOT include it in the response.

Example request

Terminal window
$ curl -X 'GET' \
'/v1/capabilities' \
-H 'accept: application/json'
{
"capabilities": {
"queue_sync": {
"max_queues": 5
},
"store_shows": {},
"store_episodes": {
"allow": true,
"upload_quota": 500
}
}
}