Rhombus Systems Component Webservice API
The Component Webservice API from Rhombus Systems — 62 operation(s) for component webservice.
The Component Webservice API from Rhombus Systems — 62 operation(s) for component webservice.
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/rhombus-systems-component-webservice-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
contact:
email: developer@rhombussystems.com
description: 'This API is for use by Rhombus customers and partners.
## Authentication
All requests require two headers:
- `x-auth-scheme` — The authentication scheme identifier. Use `api-token` for standard API key auth, or `partner-api-token` for partner API auth.
- `x-auth-apikey` — Your Rhombus API key.
Example:
```
POST /api/camera/getMinimalCameraStateList
x-auth-scheme: api-token
x-auth-apikey: YOUR_API_KEY
Content-Type: application/json
```'
title: Rhombus Component Webservice API
version: '1.0'
servers:
- description: Production Server
url: https://api2.rhombussystems.com
security:
- ApiKeyAuth: []
tags:
- name: Component Webservice
paths:
/api/component/addAccessControlledDoorLabel:
post:
description: Create a label that can be assigned to an access controlled door and referenced by an access grant or access revocation
operationId: addAccessControlledDoorLabel
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_AddAccessControlledDoorLabelWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_AddAccessControlledDoorLabelWSResponse'
description: OK
summary: Create a label that can be assigned to an access controlled door
tags:
- Component Webservice
/api/component/createAccessControlledDoor:
post:
description: Create an access controlled door
operationId: createAccessControlledDoor
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateAccessControlledDoorWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateAccessControlledDoorWSResponse'
description: OK
summary: Create an access controlled door
tags:
- Component Webservice
/api/component/createAccessControlledDoorSeekpoints:
post:
description: Create custom activity seekpoints for a specified access controlled door
operationId: createAccessControlledDoorSeekpoints
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateAccessControlledDoorSeekpointsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateAccessControlledDoorSeekpointsWSResponse'
description: OK
summary: Create custom activity seekpoints for a specified access controlled door
tags:
- Component Webservice
/api/component/createIntegratedDoorPositionIndicator:
post:
description: Create a door position indicator component
operationId: createIntegratedDoorPositionIndicator
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateIntegratedDoorPositionIndicatorWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateIntegratedDoorPositionIndicatorWSResponse'
description: OK
summary: Create a door position indicator component
tags:
- Component Webservice
/api/component/createIntegratedDoorRelay:
post:
description: Create a door relay component
operationId: createIntegratedDoorRelay
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateIntegratedDoorRelayWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateIntegratedDoorRelayWSResponse'
description: OK
summary: Create a door relay component
tags:
- Component Webservice
/api/component/createIntegratedGenericButton:
post:
description: Create a generic button component
operationId: createIntegratedGenericButton
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateIntegratedGenericButtonWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateIntegratedGenericButtonWSResponse'
description: OK
summary: Create a generic button component
tags:
- Component Webservice
/api/component/createIntegratedGenericInput:
post:
description: Create a generic input component
operationId: createIntegratedGenericInput
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateIntegratedGenericInputWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateIntegratedGenericInputWSResponse'
description: OK
summary: Create a generic input component
tags:
- Component Webservice
/api/component/createIntegratedGenericRelay:
post:
description: Create a generic relay component
operationId: createIntegratedGenericRelay
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateIntegratedGenericRelayWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateIntegratedGenericRelayWSResponse'
description: OK
summary: Create a generic relay component
tags:
- Component Webservice
/api/component/createIntegratedRequestToExit:
post:
description: Create a request to exit component
operationId: createIntegratedRequestToExit
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateIntegratedRequestToExitWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateIntegratedRequestToExitWSResponse'
description: OK
summary: Create a request to exit component
tags:
- Component Webservice
/api/component/createOsdpDoorReader:
post:
description: Create a third party OSDP Reader component
operationId: createOsdpDoorReader
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateOsdpReaderWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateOsdpReaderWSResponse'
description: OK
summary: Create a third party OSDP Reader component
tags:
- Component Webservice
/api/component/createRhombusOsdpDoorReader:
post:
description: Create a Rhombus OSDP Reader component
operationId: createRhombusOsdpDoorReader
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateRhombusOsdpReaderWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateRhombusOsdpReaderWSResponse'
description: OK
summary: Create a Rhombus OSDP Reader component
tags:
- Component Webservice
/api/component/createWiegandReader:
post:
description: Create a third party Wiegand Reader component
operationId: createWiegandReader
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateWiegandReaderWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_CreateWiegandReaderWSResponse'
description: OK
summary: Create a third party Wiegand Reader component
tags:
- Component Webservice
/api/component/deleteAccessControlledDoor:
post:
description: Delete the specified access controlled door
operationId: deleteAccessControlledDoor
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_DeleteAccessControlledDoorWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_DeleteAccessControlledDoorWSResponse'
description: OK
summary: Delete the specified access controlled door
tags:
- Component Webservice
/api/component/deleteComponent:
post:
description: Delete a component
operationId: deleteComponent
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_DeleteComponentWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_DeleteComponentWSResponse'
description: OK
summary: Delete a component
tags:
- Component Webservice
/api/component/deleteComponentsByOwnerDevice:
post:
description: Delete all components owned by the specified device
operationId: deleteComponentsByOwnerDevice
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_DeleteComponentsByOwnerDeviceWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_DeleteComponentsByOwnerDeviceWSResponse'
description: OK
summary: Delete all components owned by the specified device
tags:
- Component Webservice
/api/component/findAccessControlledDoorShadows:
post:
description: Find access controlled door shadows within the org
operationId: findAccessControlledDoorShadows
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindAccessControlledDoorShadowsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindAccessControlledDoorShadowsWSResponse'
description: OK
summary: Find access controlled door shadows within the org
tags:
- Component Webservice
/api/component/findAccessControlledDoorShadowsByLocation:
post:
description: Find access controlled door shadows within the specified location
operationId: findAccessControlledDoorShadowsByLocation
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindAccessControlledDoorShadowsByLocationWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindAccessControlledDoorShadowsByLocationWSResponse'
description: OK
summary: Find access controlled door shadows within the specified location
tags:
- Component Webservice
/api/component/findAccessControlledDoors:
post:
description: Find access controlled doors within the org
operationId: findAccessControlledDoors
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindAccessControlledDoorsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindAccessControlledDoorsWSResponse'
description: OK
summary: Find access controlled doors within the org
tags:
- Component Webservice
/api/component/findAccessControlledDoorsByLocation:
post:
description: Find access controlled doors within the specified location
operationId: findAccessControlledDoorsByLocation
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindAccessControlledDoorsByLocationWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindAccessControlledDoorsByLocationWSResponse'
description: OK
summary: Find access controlled doors within the specified location
tags:
- Component Webservice
/api/component/findAccessControlledDoorsByOwnerDevice:
post:
description: Find access controlled doors for the specified owner device
operationId: findAccessControlledDoorsByOwnerDevice
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindAccessControlledDoorsByOwnerDeviceWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindAccessControlledDoorsByOwnerDeviceWSResponse'
description: OK
summary: Find access controlled doors for the specified owner device
tags:
- Component Webservice
/api/component/findAllComponentShadows:
post:
description: Retrieve all component shadows for the specified component uuids
operationId: findAllComponentShadows
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindAllComponentShadowsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindAllComponentShadowsWSResponse'
description: OK
summary: Retrieve all component shadows for the specified component uuids
tags:
- Component Webservice
/api/component/findComponentEventsByAccessControlledDoor:
post:
description: Retrieve all component events relevant to the specified AccessControlledDoor
operationId: findComponentEventsByAccessControlledDoor
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindComponentEventsByAccessControlledDoorWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindComponentEventsByAccessControlledDoorWSResponse'
description: OK
summary: Retrieve all component events relevant to the specified AccessControlledDoor
tags:
- Component Webservice
/api/component/findComponentEventsByApiToken:
post:
description: Retrieve all component events relevant to the specified api token
operationId: findComponentEventsByApiToken
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindComponentEventsByApiTokenWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindComponentEventsByApiTokenWSResponse'
description: OK
summary: Retrieve all component events relevant to the specified api token
tags:
- Component Webservice
/api/component/findComponentEventsByComponent:
post:
description: Retrieve all component events relevant to the specified component
operationId: findComponentEventsByComponent
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindComponentEventsByComponentWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindComponentEventsByComponentWSResponse'
description: OK
summary: Retrieve all component events relevant to the specified component
tags:
- Component Webservice
/api/component/findComponentEventsByCorrelation:
post:
description: Retrieve all component events relevant to the specified correlation id
operationId: findComponentEventsByCorrelation
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindComponentEventsByCorrelationWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindComponentEventsByCorrelationWSResponse'
description: OK
summary: Retrieve all component events relevant to the specified correlation id
tags:
- Component Webservice
/api/component/findComponentEventsByCredentialHexValue:
post:
description: Retrieve all component events relevant to the specified credential hex value
operationId: findComponentEventsByCredentialHexValue
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
example: api-token
in: header
name: x-auth-scheme
required: true
schema:
type: string
default: api-token
enum:
- api-token
- api
- partner-api-token
- partner-api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindComponentEventsByCredentialHexValueWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component_FindComponentEventsByCredentialHexValueWSResponse'
description: OK
summary: Retrieve all component events relevant to the specified credential hex value
tags:
- Component Webservice
/api/component/findComponentEventsByCredentialUuid:
post:
description: Retrieve all component events relevant to the specified credential uuid
operationId: findComponentEventsByCredentialUuid
parameters:
- description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be
# --- truncated at 32 KB (294 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rhombus-systems/refs/heads/main/openapi/rhombus-systems-component-webservice-api-openapi.yml