Categories

Operations related to categorizing videos.

Create a category

This operation creates a category you can assign to a video for organization.

Request

Request Body schema: application/json

object (category)

name	string Name of the category.
description	string A description for the category.
parent_id	string Identifier to the parent category if one exists. If the category is on top level and no parent exists, the value is an empty string. Example: `"parent_id": ""` If the category is under an existing parent category, the value is the id of the parent category. Example: `"parent_id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"` Note: When updating a category the parent can be removed by setting `parent_id` to an empty string.

Responses

200

Success

Response Schema: application/json

object (category)

id	string Unique identifier for the category.
name	string Name of the category.
description	string A description for the category.
parent_id	string Identifier to the parent category if one exists. If the category is on top level and no parent exists, the value is an empty string. Example: `"parent_id": ""` If the category is under an existing parent category, the value is the id of the parent category. Example: `"parent_id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"` Note: When updating a category the parent can be removed by setting `parent_id` to an empty string.

401

Unauthorized

422

Unprocessable Entity

post/categories

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"category": {"name": "My first category",
"description": "This is a category description",
"parent_id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"
}
}

Response samples

application/json

{"category": {"id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbbd",
"name": "My first category",
"description": "This is a category description.",
"parent_id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"
}
}

Fetch all categories

This operation shows details for all categories available in Wowza Video.

Request

query Parameters

page

integer <int32>

Default: 1

Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is 1.

per_page

integer <int32>

Default: 1000

For use with the page parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000.

query

string

Searches text fields case insensitive and partial. Full matches aren't required.

For categories, name and description are the only searchable fields.

Limit to a specific field with a colon (:).

If you have multiple search terms you can use pipe (|) to separate the search terms.

Examples:

Query	Description
`query=foo`	Searches name & description field for `foo`.
`query=foo:description`	Searches description field for `foo`.
`query=foo\|bar`	Searches name for `foo` and `bar`. A category must match both to be included.

sort_column

string

Default: "name"

Value: "name"

sort_direction

string

Default: "DESC"

only_top_level

boolean

Default: false

Only categories without parent categories will be returned if set to true.

parent_id

string

Limit search to categories with a specific parent category. When specified, only child categories with the specified parent will be returned.

Responses

200

Success

Response Schema: application/json

	Array of objects (CategoryResponse) The list of categories.
	object (Pagination)

401

Unauthorized

get/categories

Request samples

Response samples

application/json

{"categories": [{"category": {"id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbbd",
"name": "My first category",
"description": "This is a category description.",
"parent_id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"
}
}
],
"pagination": {"payload_version": 0,
"total_records": 100,
"page": 1,
"per_page": 10,
"total_pages": 2,
"page_first_index": 10,
"page_last_index": 10
}
}

Fetch a category

This operation shows details for a single, specified category.

Request

path Parameters

required

string

Unique identifier for the category.

Example: 51cd5c07-1583-4f5e-bd81-f1aa11510ea9

Responses

200

Success

Response Schema: application/json

object (category)

id	string Unique identifier for the category.
name	string Name of the category.
description	string A description for the category.
parent_id	string Identifier to the parent category if one exists. If the category is on top level and no parent exists, the value is an empty string. Example: `"parent_id": ""` If the category is under an existing parent category, the value is the id of the parent category. Example: `"parent_id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"` Note: When updating a category the parent can be removed by setting `parent_id` to an empty string.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/categories/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/categories/2aa3343e-2fb5-42c3-8671-b52c24b7c3e2"

Response samples

application/json

{"category": {"id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbbd",
"name": "My first category",
"description": "This is a category description.",
"parent_id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"
}
}

Update a category

This operation updates a category.

Only the fields that are sent in the request body will be updated.

Request

path Parameters

required

string

Unique identifier for the category.

Example: 51cd5c07-1583-4f5e-bd81-f1aa11510ea9

Request Body schema: application/json

object (category)

name	string Name of the category.
description	string A description for the category.
parent_id	string Identifier to the parent category if one exists. If the category is on top level and no parent exists, the value is an empty string. Example: `"parent_id": ""` If the category is under an existing parent category, the value is the id of the parent category. Example: `"parent_id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"` Note: When updating a category the parent can be removed by setting `parent_id` to an empty string.

Responses

200

Success

Response Schema: application/json

object (category)

id	string Unique identifier for the category.
name	string Name of the category.
description	string A description for the category.
parent_id	string Identifier to the parent category if one exists. If the category is on top level and no parent exists, the value is an empty string. Example: `"parent_id": ""` If the category is under an existing parent category, the value is the id of the parent category. Example: `"parent_id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"` Note: When updating a category the parent can be removed by setting `parent_id` to an empty string.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

patch/categories/{id}

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"category": {"name": "My first category",
"description": "This is a category description",
"parent_id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"
}
}

Response samples

application/json

{"category": {"id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbbd",
"name": "My first category",
"description": "This is a category description.",
"parent_id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"
}
}

Delete a category

This operation deletes a category.

Request

path Parameters

required

string

Unique identifier for the category.

Example: 51cd5c07-1583-4f5e-bd81-f1aa11510ea9

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

delete/categories/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WV_HOST}/api/v2.0/categories/2aa3343e-2fb5-42c3-8671-b52c24b7c3e2"

Response samples

application/json

{"Example Response 1": {"meta": {"status": 401,
"code": "ERR-401-NoApiKey",
"title": "No API Key Error",
"message": "No API key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 2": {"meta": {"status": 401,
"code": "ERR-401-NoAccessKey",
"title": "No Access Key Error",
"message": "No access key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 3": {"meta": {"status": 401,
"code": "ERR-401-InvalidApiKey",
"title": "Invalid Api Key Error",
"message": "Invalid API key.",
"description": "",
"links": [ ]
}
},
"Example Response 4": {"meta": {"status": 401,
"code": "ERR-401-InvalidAccessKey",
"title": "Invalid Access Key Error",
"message": "Invalid access key.",
"description": "",
"links": [ ]
}
},
"Example Response 5": {"meta": {"status": 401,
"code": "ERR-401-BadAccountStatus",
"title": "Bad Account Status Error",
"message": "Your account's status doesn't allow this action.",
"description": "",
"links": [ ]
}
},
"Example Response 6": {"meta": {"status": 401,
"code": "ERR-401-FeatureNotEnabled",
"title": "Feature Not Enabled Error",
"message": "This feature isn't enabled.",
"description": "",
"links": [ ]
}
},
"Example Response 7": {"meta": {"status": 401,
"code": "ERR-401-TrialExceeded",
"title": "Bad Billing Status Error",
"message": "Your billing status needs attention. You can't start or add live streams until your billing status is updated.",
"description": "",
"links": [ ]
}
},
"Example Response 8": {"meta": {"status": 401,
"code": "ERR-401-ExpiredToken",
"title": "JWT is expired",
"message": "Token has exired.",
"description": "",
"links": [ ]
}
},
"Example Response 9": {"meta": {"status": 401,
"code": "ERR-401-InvalidToken",
"title": "JWT is invalid",
"message": "Token is invalid.",
"description": "",
"links": [ ]
}
}
}