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 null.

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 null.

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
application/json
{
  • "category": {
    }
}
Response samples
application/json
{
  • "category": {
    }
}

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
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/categories"
Response samples
application/json
{
  • "categories": [
    ],
  • "pagination": {
    }
}

Fetch a category

This operation shows details for a single, specified category.

Request
path Parameters
id
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 null.

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
// 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": {
    }
}

Update a category

This operation updates a category.

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

Request
path Parameters
id
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 null.

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 null.

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
application/json
{
  • "category": {
    }
}
Response samples
application/json
{
  • "category": {
    }
}

Delete a category

This operation deletes a category.

Request
path Parameters
id
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
// 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": {
    },
  • "Example Response 2": {
    },
  • "Example Response 3": {
    },
  • "Example Response 4": {
    },
  • "Example Response 5": {
    },
  • "Example Response 6": {
    },
  • "Example Response 7": {
    },
  • "Example Response 8": {
    },
  • "Example Response 9": {
    }
}