GET

/api/v1/displays

Retrieve the Manager’s current displays with work areas in device-independent pixels and scaling

Request#

POSIX shell · curl

curl --fail-with-body --request GET \
  "$ADBR_API_URL/api/v1/displays" \
  -H "Authorization: Bearer $ADBR_API_TOKEN"

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs.

Authentication and permissions#

Authentication: Bearer token

Scopes: runtime:control

All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.

Parameters#

No path or query parameters declared.

Request body#

No request body declared.

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "items"
        ],
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "label",
                "primary",
                "work_area",
                "scale_factor"
              ],
              "properties": {
                "id": {
                  "type": "integer"
                },
                "label": {
                  "type": "string"
                },
                "primary": {
                  "type": "boolean"
                },
                "work_area": {
                  "type": "object",
                  "required": [
                    "x",
                    "y",
                    "width",
                    "height"
                  ],
                  "properties": {
                    "x": {
                      "type": "integer",
                      "minimum": -100000,
                      "maximum": 100000
                    },
                    "y": {
                      "type": "integer",
                      "minimum": -100000,
                      "maximum": 100000
                    },
                    "width": {
                      "type": "integer",
                      "minimum": 200,
                      "maximum": 100000
                    },
                    "height": {
                      "type": "integer",
                      "minimum": 200,
                      "maximum": 100000
                    }
                  },
                  "additionalProperties": false
                },
                "scale_factor": {
                  "type": "number",
                  "exclusiveMinimum": 0
                }
              }
            }
          }
        }
      }
    }
  }
}

default · HTTP error envelope. The status and error.code identify the failure.

OpenAPI JSON

{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

General authentication and transport errors may occur in addition to the documented responses.

OpenAPI definition#

Complete operation definition

OpenAPI JSON

{
  "summary": "Aktuelle Bildschirme des Managers mit Arbeitsbereichen in geräteunabhängigen Pixeln und Skalierung abrufen",
  "tags": [
    "Laufzeit"
  ],
  "x-required-scopes": [
    "runtime:control"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "items"
            ],
            "properties": {
              "items": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "label",
                    "primary",
                    "work_area",
                    "scale_factor"
                  ],
                  "properties": {
                    "id": {
                      "type": "integer"
                    },
                    "label": {
                      "type": "string"
                    },
                    "primary": {
                      "type": "boolean"
                    },
                    "work_area": {
                      "type": "object",
                      "required": [
                        "x",
                        "y",
                        "width",
                        "height"
                      ],
                      "properties": {
                        "x": {
                          "type": "integer",
                          "minimum": -100000,
                          "maximum": 100000
                        },
                        "y": {
                          "type": "integer",
                          "minimum": -100000,
                          "maximum": 100000
                        },
                        "width": {
                          "type": "integer",
                          "minimum": 200,
                          "maximum": 100000
                        },
                        "height": {
                          "type": "integer",
                          "minimum": 200,
                          "maximum": 100000
                        }
                      },
                      "additionalProperties": false
                    },
                    "scale_factor": {
                      "type": "number",
                      "exclusiveMinimum": 0
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}