GET Check Geo Access
Overview
The following table contains information about the GET method for checking whether the caller's IP address is allowed to access a video based on its geo-blocking rule.
| GET Check Geo Access | |
|---|---|
| Method | GET |
| URL or Endpoint | /api/videos/videoId/check-geo-access |
| Headers | Authorization |
| Parameters | videoId |
| Body | Not Applicable |
The description of the URL parameter is as follows:
| URL Parameter Name | Mandatory | Type | Description |
|---|---|---|---|
videoId | Yes | string | Unique Id of the video. |
Request Body
The GET method doesn't contain a request body.
Response
{
"success": true,
"errors": [],
"messages": [],
"result": true,
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
Top-Level Properties
| Field Name | Type | Description |
|---|---|---|
| success | boolean | If the response is successful or not. |
| errors | array[string] | Indicates if there was an error. |
| messages | array[string] | Returns the response message from the executed action. |
| result | boolean | Indicates whether the caller's IP address is allowed to access the video. Returns true when access is allowed or when the video has no geo-blocking rule attached, and false when the IP address is blocked. |
| resultInfo | string | Returns extra information about the result. |
| statusCode | integer | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed