Getting started

WeGuard Developer API

Read your device inventory and status, installed apps, locations, screen time and app usage, policies, account, users and audit log over a versioned REST API. Use it to feed a CMDB, an ITSM or asset tool, a SIEM, a data warehouse or your own dashboards.

v1 is read-only

Every v1 endpoint is a GET. You can read data from your WeGuard account, but you can’t change devices, policies or settings.

Base URL

Send every request to the production base URL over HTTPS. Responses are JSON.

Base URL

https://api-gw.weguard.ai/core/v1

The base URL already includes the version. Paths in these docs repeat it for readability, so GET /v1/devices means https://api-gw.weguard.ai/core/v1/devices, not https://api-gw.weguard.ai/core/v1/v1/devices. If you need a sandbox (QA) environment, ask WeGuard support or your account manager.

What you can do

Read hardware, OS, enrollment, assigned policy, compliance, security state, tags and platform details for Android, iOS and iPadOS, macOS, tvOS and Windows devices, and list the apps installed on each device.
Check whether each device is online, and read its status: battery and, on Windows, Windows Update compliance, hardware health and BitLocker state.
Get the last location each device reported, and its location history.
Read the daily screen time and app usage of Windows devices.
List every policy with its device count, and the devices assigned to each one.
See your plan, license usage and tag labels, plus the console users in your account and their roles.
Read the audit log of who did what in the console, for your SIEM or for compliance reviews.

You authenticate with API keys. An account admin creates them in the console and limits each one to the scopes it needs.

Quickstart in three steps

Create an API key in the console under Settings → Developer API (account admins only).
Store it in an environment variable such as WEGUARD_API_KEY.
Call GET /v1/me to check that it works:

bash

curl https://api-gw.weguard.ai/core/v1/me \
  -H "Authorization: Bearer $WEGUARD_API_KEY"

The Quickstart covers each step in more detail, then shows you how to list devices and page through them.

Explore the docs

QuickstartCreate a key and make your first request in a few minutes.AuthenticationAPI key format, the Bearer header, storage, rotation and revocation.Authorization & scopesWhich scope each endpoint needs and how tenant isolation works.ErrorsProblem-details responses, every error code, and what to retry.PaginationCursor-based paging through large collections.Rate limitsPer-key limits, rate-limit headers and backoff.

API reference

IdentityVerify an API key and see which account and scopes it carries.AccountYour WeGuard account: plan, license usage, enabled platforms and the labels of the device tag slots.DevicesInventory, enrollment, policy, compliance, security state, connectivity and status of your managed Android, Apple (iOS, iPadOS, macOS, tvOS) and Windows devices.Installed appsThe apps installed on a device, as the device last reported them.Location historyThe locations a device reported over time, newest first.Screen time and app usageDaily screen time, up time and per-app foreground time of Windows devices, per UTC day.PoliciesDevice policies across platforms, how many devices each one manages, and which devices are assigned to it.UsersThe admins and operators who sign in to your account’s console, with their roles and the policies they can access.Audit logsThe console activity log of your WeGuard account: who did what and when, newest first.Conventions & versioningFormats, ids, request ids, ETags and compatibility.

OpenAPI and Postman

The OpenAPI description and the Postman collection are generated from this reference, so they always match it. Import the Postman collection to send requests without writing code, or pass the OpenAPI description to a client generator. Tools that import by URL, such as Postman (Import → Link), Swagger UI or openapi-generator -i, can use these addresses:

OpenAPI 3.1 URL

https://weguard.ai/docs/openapi.json

Postman collection URL

https://weguard.ai/docs/weguard-developer-api.postman_collection.json

OpenAPI 3.1

Every endpoint, parameter, schema and error code in one machine-readable file. Generate a client, or load it into Swagger UI, Insomnia or Bruno.

JSON · 341 KBDownload

Postman collection

Every request, grouped by resource, with an example response for each. Set the apiKey variable and send.

JSON · 66 KBDownload

Getting help

Every response carries an X-Request-Id header, and every error body includes the same value as requestId. Include it when you contact WeGuard support so we can find the exact request.

Base URL

What you can do

Quickstart in three steps

Explore the docs

API reference

OpenAPI and Postman

Getting help

We use cookies