Hubs

View hubs.

Supported Formats

json
>>>

GET https://api.vidyard.com/dashboard/v1/hubs
List all hubs

List all hubs

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
500 Internal Server Error

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "hubs": [
      {
        "id": 251,
        "name": "Test Hub",
        "description": "Trying new settings out",
        "route_type": "subdomain",
        "subdomain": "test",
        "organization_id": 4044,
        "hub_type": "hub",
        "base_url": "https://test.hubs.vidyard.com",
        "created_at": 1397245645,
        "updated_at": 1411501875
      },
      {
        "id": 245,
        "name": "Cats",
        "description": "Just cats",
        "route_type": "subdomain",
        "subdomain": "cats",
        "organization_id": 4044,
        "hub_type": "hub",
        "base_url": "https://cats.hubs.vidyard.com",
        "created_at": 1393523626,
        "updated_at": 1393523626
      }
  ],
  "summary":{
    "page": 1,
    "per_page": 2,
    "count": 5
  }
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String
per_page
optional

The number of items to show per page
Maximum: 200

Validations:

  • Parameter has to be Integer.
page
optional

The page number to include in the response
Only applies when per_page used
Default: 1

Validations:

  • Parameter has to be Integer.
>>>

GET https://api.vidyard.com/dashboard/v1/hubs/:id/sitemap
Get the sitemap url for a given hub ID

Get the sitemap url for a given hub ID

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
500 Internal Server Error

Examples

REQUEST
Accept: application/json
RESPONSE
200 (OK)
{
  "url": "secure.vidyard.com/sitemaps/sitemap-123abc.xml"
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String
id
required

Validations:

  • Parameter has to be Integer.