Eagle Eye Networks Applications API
Applications that can get access to an account and interact with it.
Applications that can get access to an account and interact with it.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/eagle-eye-networks:eagle-eye-networks-applications-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: SYSTEM Applications API
version: 3.0.0
description: Applications that can get access to an account and interact with it.
servers:
- url: https://{BaseUrl}/api/v3.0
description: Eagle Eye Networks API Server
variables:
BaseUrl:
default: api.cxxx.eagleeyenetworks.com
description: HTTPS Base url to use for all API calls, retrieved from https://api.eagleeyenetworks.com/api/v3.0/clientSettings
security:
- bearerAuth: []
tags:
- name: Applications
description: Applications that can get access to an account and interact with it.
paths:
/applications:
get:
operationId: listApplications
description: 'This endpoint allows retrieval of all applications accessible by the requesting user.
It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available applications, not the number of applications resulting from the query string.'
tags:
- Applications
parameters:
- $ref: '#/components/parameters/pageToken'
- $ref: '#/components/parameters/pageSize'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiPaginatedApplicationResponse'
'400':
$ref: '#/components/responses/validationError'
'401':
$ref: '#/components/responses/unauthorized'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/resourceNotFound'
'500':
$ref: '#/components/responses/internalServerError'
summary: List applications
x-summary-source: derived
post:
operationId: createApplication
description: This endpoint allows you to create a new application under the requesting user's account. A maximum of 100 applications can be created under the account.
tags:
- Applications
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ApiApplicationCreate'
responses:
'201':
description: Application Created
content:
application/json:
schema:
$ref: '#/components/schemas/ApiApplication'
'400':
$ref: '#/components/responses/validationError'
'401':
$ref: '#/components/responses/unauthorized'
'403':
$ref: '#/components/responses/forbidden'
'500':
$ref: '#/components/responses/internalServerError'
summary: Create application
x-summary-source: derived
/applications/{applicationId}:
parameters:
- $ref: '#/components/parameters/applicationId'
get:
operationId: getApplication
description: This endpoint allows you to retrieve a single application.
tags:
- Applications
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiApplication'
'400':
$ref: '#/components/responses/validationError'
'401':
$ref: '#/components/responses/unauthorized'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/resourceNotFound'
'500':
$ref: '#/components/responses/internalServerError'
summary: Get application
x-summary-source: derived
patch:
operationId: updateApplication
description: This endpoint allows you to update a single application.
tags:
- Applications
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ApiApplicationUpdate'
responses:
'204':
description: Application Updated
'400':
$ref: '#/components/responses/validationError'
'401':
$ref: '#/components/responses/unauthorized'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/resourceNotFound'
'500':
$ref: '#/components/responses/internalServerError'
summary: Update application
x-summary-source: derived
delete:
operationId: deleteApplication
description: This endpoint allows you to delete a single application.
tags:
- Applications
responses:
'204':
description: Application deleted.
'400':
$ref: '#/components/responses/validationError'
'401':
$ref: '#/components/responses/unauthorized'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/resourceNotFound'
'500':
$ref: '#/components/responses/internalServerError'
summary: Delete application
x-summary-source: derived
/languages:
get:
operationId: listLanguages
description: 'This endpoint allows you to retrieve a list of languages supported by the service.
It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available languages, not the number of languages resulting from the query string.'
tags:
- Applications
parameters:
- $ref: '#/components/parameters/pageToken'
- $ref: '#/components/parameters/pageSize'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedLanguageResponse'
'400':
$ref: '#/components/responses/validationError'
'401':
$ref: '#/components/responses/unauthorized'
'500':
$ref: '#/components/responses/internalServerError'
summary: List languages
x-summary-source: derived
/timeZones:
get:
operationId: listTimeZones
description: 'This endpoint allows you to retrieve a list of the supported time zones.
It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available time zones, not the number of time zones resulting from the query string.'
tags:
- Applications
parameters:
- $ref: '#/components/parameters/pageToken'
- $ref: '#/components/parameters/pageSize'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedTimeZoneResponse'
'400':
$ref: '#/components/responses/validationError'
'401':
$ref: '#/components/responses/unauthorized'
'500':
$ref: '#/components/responses/internalServerError'
summary: List time zones
x-summary-source: derived
components:
schemas:
ErrorInfoExceptionDetail:
properties:
type:
description: A string enum describing the type of detail object.
type: string
enum:
- errorInfo
reason:
description: 'The reason for the error. This is a constant value that identifies the proximate cause of the
error. Error reasons are unique within a particular domain of errors.
'
type: string
enum:
- unauthenticated
- unexpectedArgument
- missingRequiredArgument
- wrongArgumentValue
- invalidPermission
- wrongEdition
- wrongAccountType
- resourceNotFound
- endpointNotFound
- methodNotSupported
- unexpectedError
- acceptNotSupported
- alreadyExists
- foreignKeyConflict
- childDevicesExist
- contentNotSupported
- deadlineExpired
- tooManyRequests
- deviceUnavailable
- serviceUnavailable
- invalidJSON
- resourceLocked
- notSupportedOnBridge
- outOfRetention
- deviceIdentificationFailed
- credentialValidationFailed
- credentialSetupFailed
- localUrlValidationFailed
- hwRegistrationFailed
- failedAddingCameraAfterValidation
- neverConnected
- reconnectFailed
- unsupportedModel
- purged
- userBlocked
- userTemporarilyBlocked
- quotaExceeded
- alreadyValidated
- reAuthenticationRequired
- badGateway
domain:
description: 'Logical grouping to which the "reason" belongs
'
type: string
metadata:
$ref: '#/components/schemas/ExceptionMetadata'
Language:
type: object
description: Represents a langugage that is supported by the Eagle Eye Networks API.
properties:
tag:
type: string
description: 'IETF language tag used as main identifier of the language in the Eagle Eye Networks API. The format can be just the two character "primary language subtag" or a combination of the two character "primary language subtag" and 2 character "region subtag".
'
example: pt-BR
pattern: ^[a-z]{2}(-[A-Z]{2})?$
name:
type: string
description: 'Name of the language in native language, with an optional region in parentheses, eg. ‘Espanol’ for Spanish.
'
example: Português (Brasil)
required:
- tag
- name
ExceptionDetail:
type: object
oneOf:
- $ref: '#/components/schemas/ErrorInfoExceptionDetail'
- $ref: '#/components/schemas/BadRequestExceptionDetail'
- $ref: '#/components/schemas/ResourceInfoExceptionDetail'
discriminator:
propertyName: type
mapping:
errorInfo: '#/components/schemas/ErrorInfoExceptionDetail'
badRequest: '#/components/schemas/BadRequestExceptionDetail'
resourceInfo: '#/components/schemas/ResourceInfoExceptionDetail'
properties:
type:
description: A string enum describing the type of detail object.
type: string
enum:
- errorInfo
- badRequest
- resourceInfo
required:
- type
ApiApplication:
description: This object denotes a single Application.
allOf:
- type: object
properties:
id:
type: string
readOnly: true
description: Unique identifier for application
example: application Id
technicalContact:
$ref: '#/components/schemas/ApplicationTechContact'
- $ref: '#/components/schemas/ApiApplicationBase'
required:
- id
- name
- description
- isPublic
- technicalContact
ApiPaginatedApplicationResponse:
allOf:
- $ref: '#/components/schemas/PaginatedResponseWithSize'
- type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/ApiApplication'
ApiV3Error:
type: object
properties:
code:
description: HTTP code defined in EEN Standard Code Values
type: integer
status:
description: A string enum describing the code
type: string
enum:
- cancelled
- unknown
- invalidArgument
- deadlineExceeded
- notFound
- conflict
- permissionDenied
- resourceExhausted
- failedPrecondition
- aborted
- outOfRange
- unimplemented
- internal
- unavailable
- dataLoss
- unauthenticated
- mediaTypeNotSupported
- acceptNotSupported
- methodNotSupported
- tooManyRequests
- badGateway
message:
description: Developer friendly human readable error message in English
type: string
details:
description: An array of extensible objects that define error information
type: array
items:
$ref: '#/components/schemas/ExceptionDetail'
required:
- code
- status
- message
- details
BadRequestExceptionDetail:
properties:
type:
description: A string enum describing the type of detail object.
type: string
enum:
- badRequest
argumentViolations:
type: array
items:
$ref: '#/components/schemas/ArgumentViolation'
PaginatedResponseNoTotalSize:
type: object
description: 'Used to wrap results for a paginated response, containing information on how to retrieve further pages.
'
properties:
nextPageToken:
type:
- string
- 'null'
readOnly: true
description: 'Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.
'
prevPageToken:
type:
- string
- 'null'
readOnly: true
description: 'Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.
'
results:
type: array
readOnly: true
description: The result set from a collection API call.
items:
type: object
required:
- nextPageToken
- prevPageToken
- results
TimeZone:
type: object
description: 'Represents a time zone that is supported by the Eagle Eye Networks API. Designed as an object to allow future extension by adding new fields.
'
properties:
name:
type: string
description: 'Name of the time zone in "tz database" format of "Area/Location" us as identifier of the time zone in the EEN API.
'
example: America/New_York
PaginatedResponseWithSize:
description: "Used to wrap results for a paginated response, containing information on how to retrieve further pages and the total number of results. \n"
allOf:
- $ref: '#/components/schemas/PaginatedResponseNoTotalSize'
- properties:
totalSize:
type: integer
readOnly: true
description: 'Size of the total result set.
'
required:
- totalSize
ResourceInfoExceptionDetail:
properties:
type:
description: A string enum describing the type of detail object.
type: string
enum:
- resourceInfo
resource:
description: Referenced resource type, eg "cameras", "bridges", or "locations".
type: string
ids:
type: array
description: Identities of resources
items:
type: string
PaginatedLanguageResponse:
allOf:
- $ref: '#/components/schemas/PaginatedResponseWithSize'
- type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/Language'
ApiApplicationCreate:
allOf:
- $ref: '#/components/schemas/ApiApplicationBase'
- type: object
properties:
technicalContact:
$ref: '#/components/schemas/ApplicationTechContact'
required:
- name
- description
- isPublic
- technicalContact
PaginatedTimeZoneResponse:
allOf:
- $ref: '#/components/schemas/PaginatedResponseWithSize'
- type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/TimeZone'
ArgumentViolation:
properties:
argumentName:
type: string
description: Name of the argument
description:
type: string
description: Description of the violation
ExceptionMetadata:
properties:
path:
description: Path of the request
type: string
method:
description: Method of the request
type: string
ApiApplicationBase:
type: object
properties:
name:
type: string
description: Name of the application.
minLength: 1
maxLength: 255
example: Application name
displayName:
type: string
description: Display name of the application.
maxLength: 255
example: Application display name
website:
type: string
description: URL to the website of this application.
format: uri
example: https://een.com
developer:
type: string
description: Name of the developer/company which developed this application.
maxLength: 255
example: Eagle eye networks
privacyPolicy:
type: string
description: URL to the privacy policy of this application.
format: uri
example: https://een.com/privacy
termsOfService:
type: string
description: URL to the terms of service of this application.
format: uri
example: https://een.com/tos
description:
type: string
description: The description of the application.
maxLength: 512
example: This is the web client
isPublic:
type: boolean
description: Whether this application is intended to be public (available for other parties through an application store).
example: false
logo:
type: string
description: URL to the logo of the application.
format: uri
example: https://een.com/logo.png
ApiApplicationUpdate:
allOf:
- $ref: '#/components/schemas/ApiApplicationBase'
- type: object
properties:
technicalContact:
$ref: '#/components/schemas/ApplicationTechContactUpdate'
ApplicationTechContact:
allOf:
- $ref: '#/components/schemas/ApplicationTechContactUpdate'
required:
- name
- email
ApplicationTechContactUpdate:
type: object
description: Request body for application update.
properties:
name:
type: string
description: First name of point of contact for this application.
minLength: 1
maxLength: 512
example: Prakash
lastName:
type: string
description: Last name of the person to contact for this application.
maxLength: 256
example: Singh
email:
type: string
description: Email id of the person to contact for this application.
format: email
maxLength: 75
example: abc@gmail.com
phone:
type: string
description: Phone number of the person to contact for this application.
maxLength: 30
example: (555) 555-1234
responses:
forbidden:
description: You have no permission to access the specified resource.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV3Error'
examples:
invalidPermission:
value:
code: 403
status: permissionDenied
message: The client caller does not have permission for the specified operation
details:
- type: errorInfo
reason: invalidPermission
domain: apiv3
metadata:
path: /api/v3.0/<resource>
wrongEdition:
value:
code: 403
status: permissionDenied
message: This feature is not enabled for the account
details:
- type: errorInfo
reason: wrongEdition
domain: apiv3
metadata:
path: /api/v3.0/locations
wrongAccountType:
value:
code: 403
status: permissionDenied
message: This feature is only available for end users
details:
- type: errorInfo
reason: wrongAccountType
domain: apiv3
metadata:
path: /api/v3.0/locations
resourceNotFound:
description: Referenced resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV3Error'
examples:
endpointNotFound:
value:
code: 404
status: notFound
message: The API endpoint was not found
details:
- type: errorInfo
reason: endpointNotFound
domain: apiv3
metadata:
path: /api/v3.0/<resource>
resourceNotFound:
value:
code: 404
status: notFound
message: The resource was not found
details:
- type: errorInfo
reason: resourceNotFound
domain: apiv3
metadata:
path: /api/v3.0/<resource>
- type: resourceInfo
resource: <resource>
ids:
- <ids>
internalServerError:
description: Something went wrong in the server. Please try again.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV3Error'
example:
code: 500
status: internal
message: An internal error has occurred. Please try again later.
details:
- type: errorInfo
reason: unexpectedError
domain: apiv3
metadata:
path: /api/v3.0/<resource>
unauthorized:
description: You are not authenticated. Please authenticate and try again.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV3Error'
example:
code: 401
status: unauthenticated
message: The client caller does not have a valid authentication credential
details:
- type: errorInfo
reason: unauthenticated
domain: apiv3
metadata:
path: /api/v3.0/<resource>
validationError:
description: The supplied object is invalid. Error detail will contain the validation error.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV3Error'
examples:
unexpectedArgument:
value:
code: 400
status: invalidArgument
message: 'Unexpected argument: name'
details:
- type: errorInfo
reason: unexpectedArgument
domain: apiv3
metadata:
path: /api/v3.0/<resource>
missingRequiredArgument:
value:
code: 400
status: invalidArgument
message: 'Missing required arguments: name, id'
details:
- type: errorInfo
reason: missingRequiredArgument
domain: apiv3
metadata:
path: /api/v3.0/<resource>
badRequestInvalidJSON:
value:
code: 400
status: invalidArgument
message: Invalid JSON
details:
- type: errorInfo
reason: invalidJSON
domain: apiv3
metadata:
path: /api/v3.0/<resource>
badRequestInvalidArgument:
value:
code: 400
status: invalidArgument
message: 'Invalid Argument: Argument name is too long'
details:
- type: errorInfo
reason: wrongArgumentValue
domain: apiv3
metadata:
path: /api/v3.0/<resource>
- type: badRequest
argumentViolations:
- argumentName: name
description: Name is too long
parameters:
pageSize:
in: query
name: pageSize
description: 'The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a `nextPageToken` value.
'
example: 100
required: false
schema:
type: integer
minimum: 1
maximum: 500
default: 100
applicationId:
name: applicationId
in: path
description: Identifier of an application
required: true
schema:
type: string
pageToken:
in: query
name: pageToken
description: 'Token string value that references a page for pagination. This value is received when retrieving the first page in the `nextPageToken` and `prevPageToken` fields.
When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like `include` should still be applied.
'
example: b2Zmc2V0PTEwJmxpbWl0PTEw
required: false
schema:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
x-provenance:
method: searched
source: https://developer.eagleeyenetworks.com/reference
harvested: '2026-10-14'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://developer.eagleeyenetworks.com/reference/addoauthclient.md
- https://developer.eagleeyenetworks.com/reference/createapplication.md
- https://developer.eagleeyenetworks.com/reference/deleteapplication.md
- https://developer.eagleeyenetworks.com/reference/deleteoauthclient.md
- https://developer.eagleeyenetworks.com/reference/getapplication.md
- https://developer.eagleeyenetworks.com/reference/getoauthclient.md
- https://developer.eagleeyenetworks.com/reference/getoauthclients.md
- https://developer.eagleeyenetworks.com/reference/listapplications.md
- https://developer.eagleeyenetworks.com/reference/listlanguages.md
- https://developer.eagleeyenetworks.com/reference/listtimezones.md
- https://developer.eagleeyenetworks.com/reference/updateapplication.md
- https://developer.eagleeyenetworks.com/reference/updateclient.md
merge:
pages: 12
deduped: 191
conflicts_kept_first: 0