openapi: 3.2.0 info: title: USER & ACCOUNTS Editions API version: 3.0.0 description: Retrieve information on editions available to the account. 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: Editions description: Retrieve information on editions available to the account. paths: /editions: get: operationId: getEditions description: 'This endpoint allows you to retrieve a list of the editions that are available for your account. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available editions, not the number of editions resulting from the query string.' tags: - Editions parameters: - $ref: '#/components/parameters/accountId2' - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/pageSize' responses: '200': description: Successfully fetched content: application/json: schema: $ref: '#/components/schemas/PaginatedEditionResponse' '400': $ref: '#/components/responses/validationError' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/resourceNotFound' '500': $ref: '#/components/responses/internalServerError' summary: Get editions x-summary-source: derived /editions/{id}: get: operationId: getEdition description: This endpoint allows you to retrieve a specific edition by its ID. tags: - Editions parameters: - $ref: '#/components/parameters/id1' responses: '200': description: Successfully authorized content: application/json: schema: $ref: '#/components/schemas/Edition' '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 edition 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' 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 Edition: properties: id: oneOf: - $ref: '#/components/parameters/id/schema' name: type: string minLength: 1 maxLength: 32 order: type: integer description: The order in which the edition should be sorted capabilities: type: object description: Object with key as feature flag and value boolean determining if it is on/off required: - id - name - order - capabilities 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 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 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 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 PaginatedEditionResponse: allOf: - $ref: '#/components/schemas/PaginatedResponseWithSize' - type: object properties: results: type: array items: $ref: '#/components/schemas/Edition' 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/ 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/ resourceNotFound: value: code: 404 status: notFound message: The resource was not found details: - type: errorInfo reason: resourceNotFound domain: apiv3 metadata: path: /api/v3.0/ - type: resourceInfo resource: 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/ 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/ 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/ missingRequiredArgument: value: code: 400 status: invalidArgument message: 'Missing required arguments: name, id' details: - type: errorInfo reason: missingRequiredArgument domain: apiv3 metadata: path: /api/v3.0/ badRequestInvalidJSON: value: code: 400 status: invalidArgument message: Invalid JSON details: - type: errorInfo reason: invalidJSON domain: apiv3 metadata: path: /api/v3.0/ 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/ - type: badRequest argumentViolations: - argumentName: name description: Name is too long parameters: id1: in: path required: true name: id description: Edition ID schema: type: string 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 id: in: path required: true name: id description: 'Account ID. Use __*self*__ as the Account ID to reference the account of the current session ' schema: type: string accountId2: in: query name: accountId description: Account ID specified in as an ESN Type. 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/createresourcegrants.md - https://developer.eagleeyenetworks.com/reference/createrole.md - https://developer.eagleeyenetworks.com/reference/createroleassignments.md - https://developer.eagleeyenetworks.com/reference/createuser.md - https://developer.eagleeyenetworks.com/reference/deletecredential.md - https://developer.eagleeyenetworks.com/reference/deleteresourcegrants.md - https://developer.eagleeyenetworks.com/reference/deleterole.md - https://developer.eagleeyenetworks.com/reference/deleteroleassignments.md - https://developer.eagleeyenetworks.com/reference/deletetrustedclient.md - https://developer.eagleeyenetworks.com/reference/deleteuser.md - https://developer.eagleeyenetworks.com/reference/getcurrentuser.md - https://developer.eagleeyenetworks.com/reference/getedition.md - https://developer.eagleeyenetworks.com/reference/geteditions.md - https://developer.eagleeyenetworks.com/reference/getresourcegrants.md - https://developer.eagleeyenetworks.com/reference/getrole.md - https://developer.eagleeyenetworks.com/reference/getroleassignments.md - https://developer.eagleeyenetworks.com/reference/getroles.md - https://developer.eagleeyenetworks.com/reference/gettrustedclients.md - https://developer.eagleeyenetworks.com/reference/getuser.md - https://developer.eagleeyenetworks.com/reference/getusers.md - https://developer.eagleeyenetworks.com/reference/listaccounts.md - https://developer.eagleeyenetworks.com/reference/listauditlogs.md - https://developer.eagleeyenetworks.com/reference/updatecurrentuser.md - https://developer.eagleeyenetworks.com/reference/updaterole.md - https://developer.eagleeyenetworks.com/reference/updateuser.md merge: pages: 25 deduped: 428 conflicts_kept_first: 0