Alcatraz Admin Portal API

Customer-facing REST API for the Alcatraz Admin Portal, used by third-party projects and applications to administer Rock devices, users, profiles and events. Access is authorized with an API key generated in the Admin Portal (Accounts > Account Settings > API Keys) and passed in the x-alcatraz-api-key header. The endpoint reference is published only inside the authenticated Admin Portal via its API Docs button; the vendor directs everyone else to their Alcatraz AI account manager.

API entry from apis.yml

apis.yml Raw ↑
aid: alcatraz-ai:admin-portal-api
name: Alcatraz Admin Portal API
description: Customer-facing REST API for the Alcatraz Admin Portal, used by third-party projects and
  applications to administer Rock devices, users, profiles and events. Access is authorized with an API
  key generated in the Admin Portal (Accounts > Account Settings > API Keys) and passed in the x-alcatraz-api-key
  header. The endpoint reference is published only inside the authenticated Admin Portal via its API Docs
  button; the vendor directs everyone else to their Alcatraz AI account manager.
humanURL: https://support.alcatraz.ai/api-keys
baseURL: https://platform.alcatraz.ai/api/v2/
tags:
- Access Control
- Biometrics
- Identity
properties:
- type: Documentation
  url: https://support.alcatraz.ai/api-keys
- type: Authentication
  url: authentication/alcatraz-ai-authentication.yml
x-evidence:
  base_url_source: https://alcatraz-docs.s3.us-west-2.amazonaws.com/Guides/Alcatraz+AI+Admin+Portal+Guide+v2.5.pdf
  base_url_source_note: 'Section 3.1.7.2 API Key Documentation: "Request URL for Alcatraz AI API is https://platform.alcatraz.ai/api/v2/"
    and "use the authentication header: x-alcatraz-api-key"'
  checked: '2026-08-06'
  host_resolves: false
  host_resolution_note: platform.alcatraz.ai returned NXDOMAIN from 8.8.8.8, 1.1.1.1 and 9.9.9.9 on 2026-08-06;
    the documented API host is not resolvable from the public internet.