EIZO
API docs by Redocly

ColorNavigator Network API (1.0.0)

Download OpenAPI specification:Download

Web API for ColorNavigator Network

Getting Started

A ColorNavigator Network account is required

You cannot use this API if you do not have an account.

Create an Access Token

Create an access token from the ColorNavigator Network website.

  1. Log in to ColorNavigator Network.
  2. Select "Log-in User Settings" in the header > "ColorNavigator Network API" > "Create".
  3. Enter the correct password and the token will be displayed.

Call API

For example, you can call API with curl from a terminal app.

> curl https://cnnw1.eizo.com/api/v1/monitors --header 'Authorization: Bearer <ACCESS-TOKEN>'
{"monitors":[{"id": "cg279x_12345678","modelName":"CG279X","serialNumber":"12345678", ... }]}
  • Replace <ACCESS-TOKEN> with your access token.

For more usage, please refer to the examples on GitHub.

Note

About Access Token

  • Keep your token in a safe place.
  • A user account can have only one token. When creating a new token, the existing one becomes invalid.
  • You can manage the token on the ColorNavigator Network website.

Rate Limits

Each API has rate limits.

Requests exceeding these limits will result in a 429 error response.

  • You can send a total of 5 requests per second per user across all endpoints.
  • Additionally, each endpoint has its own specific rate limits, which are listed below.
Method Endpoint Requests Window of time Per
GET /api/v1/groups 100 1 hour User
GET /api/v1/monitors 100 1 hour User
GET /api/v1/monitors/:id 300 1 hour User
GET /api/v1/monitors/:id/color-modes/:index 6000 24 hours User
GET /api/v1/monitor-configurations 100 1 hour User
POST /api/v1/remote-command/monitor-configuration/send 100 1 hour User
POST /api/v1/remote-command/asset-information/send 100 1 hour User
POST /api/v1/remote-command/request-to-upload/send 100 1 hour User

Miscellaneous

ColorNavigator API

We also have ColorNavigator API that can be used to control ColorEdge through ColorNavigator 7.

Changelog

1.0.0 (ColorNavigator Network 1.2.0)

0.9.0-beta (ColorNavigator Network 1.1.13)

  • First Edition

Gets the list of groups

header Parameters
Authorization
required
string
Example: Bearer 0123456789abcdef0123456789abcdef01234567

The token for authorization. Set Bearer type.

Responses

Response samples

Content type
application/json
{
  • "groups": [
    ]
}

Gets the list of monitors

Gets the list of your managed monitors, which do not include removed ones.

header Parameters
Authorization
required
string
Example: Bearer 0123456789abcdef0123456789abcdef01234567

The token for authorization. Set Bearer type.

Responses

Response samples

Content type
application/json
{
  • "monitors": [
    ]
}

Gets detailed monitor information

path Parameters
monitorId
required
string
Example: cg279x_12345678

An identifier of the target monitor.

header Parameters
Authorization
required
string
Example: Bearer 0123456789abcdef0123456789abcdef01234567

The token for authorization. Set Bearer type.

Responses

Response samples

Content type
application/json
{
  • "id": "cg279x_12345678",
  • "modelName": "CG279X",
  • "serialNumber": 12345678,
  • "groupId": "01234567-89ab-cdef-0123-456789abcdef",
  • "groupName": "group name",
  • "firmwareVersion": "10000-00000-00000",
  • "usageHours": 100,
  • "monitorConfigurationName": "Current Monitor Configuration",
  • "postCalibrationUsageHours": 20,
  • "calibratedAt": "2023-01-01 00:00",
  • "selfCalibrationExecutedAt": "2023-01-01 00:00",
  • "computer": {
    },
  • "remoteCommand": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "keyLock": "OFF",
  • "duePriority": "UNIFORMITY",
  • "rangeExtension": "OFF",
  • "selfCalibrationSettings": {
    },
  • "selfCorrectionSettings": {
    },
  • "builtInSensor": {
    },
  • "colorModes": [],
  • "assetInformation": {
    },
  • "detailsUploadedAt": "2019-08-24T14:15:22Z"
}

Gets color mode information

Gets the calibration target, result, or color parameters.

path Parameters
monitorId
required
string
Example: cg279x_12345678

An identifier of the target monitor.

colorModeIndex
required
integer

An index of the color mode. It is zero-based indexing.

The color mode "number" on OSD begins at 1. The index of color mode No.1 is 0.

header Parameters
Authorization
required
string
Example: Bearer 0123456789abcdef0123456789abcdef01234567

The token for authorization. Set Bearer type.

Responses

Response samples

Content type
application/json
{
  • "parameters": {
    },
  • "calibrationTarget": {
    },
  • "calibrationResult": {
    },
  • "index": 0,
  • "name": "CAL1",
  • "selected": true,
  • "enabled": true,
  • "type": "ADVANCED",
  • "postCalibrationUsageHours": 0,
  • "selfCalibrationResult": {
    }
}

Gets the list of monitor configurations

header Parameters
Authorization
required
string
Example: Bearer 0123456789abcdef0123456789abcdef01234567

The token for authorization. Set Bearer type.

Responses

Response samples

Content type
application/json
{
  • "monitorConfigurations": [
    ]
}

Sends a monitor configuration command

header Parameters
Authorization
required
string
Example: Bearer 0123456789abcdef0123456789abcdef01234567

The token for authorization. Set Bearer type.

Request Body schema: application/json
monitorConfigurationId
required
string

An identifier of the monitor configuration you want to send.

targetMonitorIds
required
Array of strings

Target monitors.

required
object or object or object

The start timing of the calibration.

  • POWER_SAVE: Starts the calibration after the monitor enters power save
  • IMMEDIATE: Starts the calibration when the monitor receieves the remote command even if in use
    • If the calibration is canceled by the monitor's OSD, the calibration will restart when the monitor enters power save.
  • SPECIFIED_DATE: Starts the calibration on the specified schedule
    • You can specify a date within the next 3 months but can not specify a date of the 6th week.

Responses

Request samples

Content type
application/json
{
  • "monitorConfigurationId": "01234567-89ab-cdef-0123-456789abcdef",
  • "targetMonitorIds": [
    ],
  • "calibrationTiming": {
    }
}

Response samples

Content type
application/json
{}

Sends a asset information command

header Parameters
Authorization
required
string
Example: Bearer 0123456789abcdef0123456789abcdef01234567

The token for authorization. Set Bearer type.

Request Body schema: application/json
targetMonitorIds
required
Array of strings

Target monitors.

required
object or null

Asset information. Note the following limitations.

  • Maximum length: 64 characters
  • Prohibited characters: <, >

Responses

Request samples

Content type
application/json
{
  • "targetMonitorIds": [
    ],
  • "assetInformation": {
    }
}

Response samples

Content type
application/json
{}

Sends a request to upload command

header Parameters
Authorization
required
string
Example: Bearer 0123456789abcdef0123456789abcdef01234567

The token for authorization. Set Bearer type.

Request Body schema: application/json
targetMonitorIds
required
Array of strings

Target monitors.

Responses

Request samples

Content type
application/json
{
  • "targetMonitorIds": [
    ]
}

Response samples

Content type
application/json
{}