Blacklisted IP Ranges

Add blacklisted ip ranges to an existing organization

Supported Formats

json
>>>

GET https://api.vidyard.com/dashboard/v1/blacklisted_ip_ranges/:id
Get a single blacklisted ip range

Get a single blacklisted ip range

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
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Accept: application/json

RESPONSE
200 (Ok)
{
  "id": 28,
  "organization_id": 27,
  "name": "Test",
  "ip_range": "192.168.0.1/24"
  "embed_domain": "http://embed.vidyard.com",
  "created_at": 1390585689,
  "updated_at": 1390585689,
}

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

POST https://api.vidyard.com/dashboard/v1/blacklisted_ip_ranges
Create a new blacklisted ip range

Create a new blacklisted ip range

Supported Formats

json

Errors

Code Description
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
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
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Authorization: Bearer <user jwt>
Content-Type: application/json
{
}

RESPONSE
Location: /api/v1/organizations/1/blacklisted_ip_ranges/28
201 (Created)
{
  "id": 28,
  "created_at": 1392405501,
  "updated_at": 1392405501,
  "organization_id": 1,
  "ip_range": "192.168.0.1/24",
  "name": "Test",
}
REQUEST
Authorization: Bearer <service jwt>
Content-Type: application/json
{
  "ip_range": "192.168.0.1/24"
}

RESPONSE
Location: /api/v1/organizations/1/blacklisted_ip_ranges/28
201 (Created)
{
  "id": 29,
  "organization_id": 1,
  "created_at": 1392405501,
  "updated_at": 1392405501,
  "ip_range": "192.168.0.1/24",
  "name": "Test",
}

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
ip_range
optional

The ip range in dotted quad format

Validations:

  • Must be a String
name
optional

The name describing the IP address/range

Validations:

  • Must be a String
>>>

GET https://api.vidyard.com/dashboard/v1/blacklisted_ip_ranges
Get a list of blacklisted ip ranges

Get a list of blacklisted ip ranges

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
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Accept: application/json

RESPONSE
{
  "blacklisted_ip_ranges": [
    {
      "id": 2222,
      "organization_id": 1,
      "ip_range": "192.168.0.1/24",
      "name": "Test",
      "created_at": 1346961610,
      "updated_at": 1346961610
    },
    {
      "id": 2245,
      "organization_id": 1,
      "ip_range": "10.0.0.1/8",
      ...
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 2,
    "count": 100
  }
}

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

DELETE https://api.vidyard.com/dashboard/v1/blacklisted_ip_ranges/:id
Delete a blacklisted ip range

Delete a blacklisted ip range

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
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Accept: application/json

RESPONSE
{
  "id": 28,
  "organization_id": 27,
  "ip_range": "192.168.0.1/24",
  "name": "Test",
  "embed_domain": "http://embed.vidyard.com",
  "created_at": 1390585689,
  "updated_at": 1390585689,
}

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

Used to uniquely identify a blacklisted ip range

Validations:

  • Parameter has to be Integer.