OverviewIntroduction
Overview

Clients Management API

Create, list, update, and delete Mythic Analytics client tenants, manage tags and snippets, and retrieve loader embed code via the Clients Management API.

Overview

Use the Clients Management API to manage Mythic Analytics client tenants. You can create tenants with auto-generated credentials, configure tags and snippets for remote injection, and retrieve loader snippets for embedding the SDK.

Base URL

All endpoints share the same base URL and version prefix.

https://api.mythic-analytics.com/api/v1

Response envelope

All endpoints return a JSON envelope.

successboolean
Required

Whether the request succeeded.

dataobject|array|null

Resource payload. Shape depends on the endpoint.

countinteger

Total number of matching resources. Present on list endpoints.

errorstring|null

Error message on failed requests.

Example error response:

{
  "success": false,
  "data": null,
  "error": "Unauthorized",
  "count": 0
}

Validation rules

The API enforces the following formats:

FieldPatternDescription
id^[a-zA-Z0-9_-]{1,255}$Alphanumeric, hyphens, underscores
name1-255 charactersRequired display name
domainValid domain formate.g., acme-retail.com
emailStandard email formate.g., ops@acme.com
global_nameValid JS identifiere.g., acmeRetail, _myApp

Error handling

StatusMeaning
400Invalid JSON, missing required fields, or validation error
401Admin key missing or invalid
404Client not found
409Conflict — duplicate id, global_name, or domain
500Internal server error

Check both the HTTP status code and the error field in the response body for programmatic error handling.

Was this page helpful?
Built with Documentation.AI

Last updated today