Monitoring

12 routes de l'API publique. Textes de la source : openapi-csp.json du dépôt platform.

List usage daily

GET /usage-daily

Accès : Clé API du MSP, portée read.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
limit	requête	integer	non	Défaut : 50. Valeur : 1 à 100.
cursor	requête	string	non	Longueur minimum : 1.
from	requête	string (date)	oui
to	requête	string (date)	oui
endpoint_id	requête	string (uuid)	non
client_id	requête	string (uuid)	non

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
items	array of object	oui
items[].msp_id	string (uuid)	oui
items[].endpoint_id	string (uuid)	oui
items[].revision	integer	non	Valeur minimum : 0.
items[].date	string (date)	oui
items[].orchestrated_bytes	integer	oui	Valeur minimum : 0.
items[].stored_bytes	integer	oui	Valeur minimum : 0.
items[].billable_users	integer	non	Valeur minimum : 0.
items[].peak_billable_users	integer	non	Valeur minimum : 0.
items[].licenses_consumed	integer	non	Valeur minimum : 0.
items[].source_bytes	object	non
items[].client_id	string (uuid)	oui
next_cursor	string | null	oui

List audit log

GET /audit-log

Accès : Clé API du MSP, portée read.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
limit	requête	integer	non	Défaut : 50. Valeur : 1 à 100.
cursor	requête	string	non	Longueur minimum : 1.
actor_id	requête	string (uuid)	non
api_key_id	requête	string (uuid)	non
action	requête	"auth.login" | "auth.login_failed" | "auth.logout" | "auth.password_changed" | "auth.password_change_failed" | "auth.mfa_failed" | "auth.mfa_enrolled" | "auth.mfa_reset" | "auth.recovery_code_used" | "auth.recovery_codes_regenerated" | "auth.mfa_disabled" | "auth.mfa_confirmed" | "auth.mfa_skipped_trusted_browser" | "auth.trusted_browser_added" | "auth.trusted_browser_revoked" | "invitation.created" | "invitation.revoked" | "invitation.accepted" | "account.updated" | "account.unsubscribed" | "account.push_subscribed" | "account.push_unsubscribed" | "user.role_changed" | "user.removed" | "user.platform_admin_created" | "msp.created" | "msp.suspended" | "msp.reactivated" | "msp.mfa_policy_changed" | "install_profile.updated" | "install_profile.id_regenerated" | "client.created" | "client.delete.requested" | "enrollment_token.revoked" | "enrollment_token.reattach_created" | "deployment_token.created" | "deployment_token.revoked" | "endpoint.enrolled" | "endpoint.enroll_refused" | "endpoint.delete.requested" | "endpoint.renamed" | "problem.acknowledged" | "problem.unacknowledged" | "endpoint.first_backup_alert.updated" | "endpoint.first_backup_reset.updated" | "repo.first_backup_reset" | "policy.created" | "policy.updated" | "script.created" | "script.updated" | "script.version_reverted" | "script.deleted" | "policy.hooks_changed" | "job.cancel.requested" | "pending_action.requested" | "pending_action.cancelled" | "pending_action.applied" | "restore_session.granted" | "restore_session.refused" | "restore_session.closed" | "restore_session.requested" | "restore_session.cross_client_confirmed" | "restore_session.cancel_requested" | "agent.version_changed" | "agent.upload_limit_changed" | "agent.relocate" | "agent.dir_listed" | "share.created" | "share.updated" | "share.deleted" | "share.checked" | "mssql.connection.updated" | "mssql.restore.requested" | "mssql.restore.ended" | "hyperv.tpm_guardian.imported" | "agent.update_relaunched" | "agent.revoked" | "agent.reattached" | "agent_release.created" | "agent_release.revoked" | "agent_rollout.updated" | "agent_rollout.targeted" | "alert_settings.updated" | "alert_recipients.updated" | "keys.exported" | "pool.created" | "pool.updated" | "bucket.created" | "bucket.updated" | "license.imported" | "license.refused" | "license.request_exported" | "data_plane.bandwidth_limit_updated" | "repo_move.requested" | "repo_move.preempted" | "repo_move.switched" | "repo_move.failed" | "repo_move.rolled_back" | "repo_move.purged" | "snapshot.tree_listed" | "snapshot.searched" | "snapshot.selection_sized" | "recovery.claimed" | "recovery.claim_failed" | "recovery.approved" | "recovery.cancelled" | "recovery.closed" | "mcp.enabled" | "mcp.disabled" | "mcp.access_granted" | "mcp.access_revoked" | "mcp.call" | "api_key.created" | "api_key.rotated" | "api_key.revoked" | "api_key.call" | string	non
object_type	requête	string	non
object_id	requête	string	non	Longueur : 1 à 256.
endpoint_id	requête	string (uuid)	non
from	requête	string (date-time)	non
to	requête	string (date-time)	non

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
items	array of object	oui
items[].id	integer	oui	Valeur minimum : 0.
items[].ts	string (date-time)	oui
items[].actor_type	"user" | "api_key" | "system"	oui
items[].actor_id	string (uuid) | null	oui
items[].actor_email	string | null	oui
items[].actor_api_key	object | null	oui
items[].action	string	oui	A value of AUDIT_ACTIONS or m365.<action>; rows written before J3 may hold others.
items[].object_type	string | null	oui
items[].object_id	string | null	oui
items[].endpoint_id	string (uuid) | null	oui
items[].payload	string | number | boolean | null | array of string | number | boolean | null | array | object | object | null	oui
items[].ip	string (ipv4) | string (ipv6) | null	oui
next_cursor	string | null	oui

Get alert settings

GET /alerts

Accès : Clé API du MSP, portée read.

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
rules	object	oui
rules.agent	object	oui
rules.m365	object	oui
first_backup_alert_default_days	integer	oui	Stack default, FIRST_BACKUP_ALERT_DAYS of the deployment; PUT /alerts does not set it. Valeur : 1 à 365.

Replace alert settings

PUT /alerts

Accès : Clé API du MSP, portée operate.

Corps de la requête (application/json)

Nom	Type	Obligatoire	Description
rules	object	oui
rules.agent	object	oui
rules.agent.backup_failed	object	oui
rules.agent.backup_partial	object	oui
rules.agent.backup_missed	object	oui
rules.agent.agent_offline	object	oui
rules.agent.no_recent_snapshot	object	oui
rules.agent.check_failed	object	oui
rules.agent.update_failed	object	oui
rules.agent.share_unreachable	object	non	Défaut : {"enabled":true}.
rules.agent.first_backup_unfinished	object	non	Défaut : {"enabled":true}.
rules.m365	object	oui
rules.m365.backup_failed	object	oui
rules.m365.backup_partial	object	oui
rules.m365.backup_missed	object	oui
rules.m365.no_recent_snapshot	object	oui
rules.m365.check_failed	object	oui

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
rules	object	oui
rules.agent	object	oui
rules.m365	object	oui
first_backup_alert_default_days	integer	oui	Stack default, FIRST_BACKUP_ALERT_DAYS of the deployment; PUT /alerts does not set it. Valeur : 1 à 365.

Get client alert settings

GET /clients/{id}/alerts

Accès : Clé API du MSP, portée read.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
client_id	string (uuid)	oui
rules	object	oui
rules.agent	object	oui
rules.m365	object	oui

Replace client alert settings

PUT /clients/{id}/alerts

Accès : Clé API du MSP, portée operate.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
id	chemin	string (uuid)	oui

Corps de la requête (application/json)

Nom	Type	Obligatoire	Description
rules	object	oui
rules.agent	object	oui
rules.agent.backup_failed	object	non
rules.agent.backup_partial	object	non
rules.agent.backup_missed	object	non
rules.agent.agent_offline	object	non
rules.agent.no_recent_snapshot	object	non
rules.agent.check_failed	object	non
rules.agent.update_failed	object	non
rules.agent.share_unreachable	object	non
rules.agent.first_backup_unfinished	object	non
rules.m365	object	oui
rules.m365.backup_failed	object	non
rules.m365.backup_partial	object	non
rules.m365.backup_missed	object	non
rules.m365.no_recent_snapshot	object	non
rules.m365.check_failed	object	non

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
client_id	string (uuid)	oui
rules	object	oui
rules.agent	object	oui
rules.m365	object	oui

List dashboard problems

GET /dashboard/problems

Accès : Clé API du MSP, portée read.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
limit	requête	integer	non	Défaut : 50. Valeur : 1 à 100.
cursor	requête	string	non	Longueur minimum : 1.
client_id	requête	string (uuid)	non	Endpoints of this client only; 404 for a client of another MSP.
tag	requête	string | array of string	non	key:value, repeat for several (AND). Key and value compare without case.
no_tag	requête	string | array of string	non	A tag key, repeat for several (AND): the endpoint does not have the key. Compares without case.
endpoint_id	requête	string (uuid)	non
as_of	requête	string (date-time)	non	Reuse the dashboard problem window upper bound across pages.
state	requête	"open" | "acknowledged" | "unresolved" | "all"	non	open: the problems not resolved and not acknowledged (the rule of GET /dashboard); acknowledged: not resolved, hidden by an acknowledgement; unresolved: both; all: also the resolved ones. Défaut : "all".

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
items	array of object	oui
items[].id	string (uuid)	oui
items[].endpoint_id	string (uuid)	oui
items[].type	"backup" | "baremetal_backup" | "mssql_backup" | "vm_backup" | "init" | "unlock" | "forget" | "prune" | "check" | "migrate" | "update" | "reset_first_backup"	oui
items[].status	"scheduled" | "dispatched" | "running" | "succeeded" | "partial" | "failed" | "cancelled" | "interrupted" | "preempted" | "missed" | "superseded"	oui
items[].trigger	"schedule" | "manual" | "system"	oui
items[].policy_id	string (uuid) | null	non	The backup policy of a backup run; null for maintenance or a backup without policy. Optional for older readers [C13], always sent.
items[].cause	string | null	oui	Typed cause, for example no_ack or repo_migrating
items[].scheduled_at	string (date-time)	oui	Request time for a manual job.
items[].window_ends_at	string (date-time) | null	oui
items[].started_at	string (date-time) | null	oui
items[].ended_at	string (date-time) | null	oui
items[].snapshot_id	string | null	oui	succeeded or partial backup only.
items[].summary	object | null	oui	Final restic summary, backup only.
items[].error_count	integer | null	oui	Unreadable files of a partial backup.
items[].file_error_codes	array of object | null	non	Count per typed code of the stored file errors of a partial backup (at most 100; error_count is the real total), most frequent first, without paths or text: for every role and for an OAuth access token (MCP). Null without stored errors. Optional for older readers [C13], always sent.
items[].error	string | null	oui
items[].upload_limit	number | null	non	Upload limit sent to the agent for this backup, MiB/s: the exception of the agent, else the limit of the policy, fixed when the order is sent. Null: no limit, or not a backup. Optional for older readers [C13], always sent.
items[].progress	object | null	oui	Only while running
items[].hooks	object | null	non	Scripts before and after a backup, per phase: version, SHA-256, status, exit code, duration, output. Null: none ran. Optional for older readers [C13], always sent.
items[].volume	object | null	non	Size and count of a succeeded or partial backup of any kind. Null: not a backup, no snapshot, or another status. Optional for older readers [C13], always sent.
items[].endpoint_name	string	oui
items[].client_id	string (uuid)	oui
items[].resolved	boolean	oui	A later job of the same endpoint, type and policy succeeded; for an agent update, also: the agent runs its version.
items[].resolved_by_job_id	string (uuid) | null	oui	The newest later succeeded job of the same endpoint, type and policy; null without one.
items[].resolved_at	string (date-time) | null	oui	ended_at of resolved_by_job_id
items[].acknowledged	object | null	oui	The acknowledgement that hides this job; null when no acknowledgement covers it.
next_cursor	string | null	oui

Get dashboard

GET /dashboard

Accès : Clé API du MSP, portée read.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
client_id	requête	string (uuid)	non	Endpoints of this client only; 404 for a client of another MSP.
tag	requête	string | array of string	non	key:value, repeat for several (AND). Key and value compare without case.
no_tag	requête	string | array of string	non	A tag key, repeat for several (AND): the endpoint does not have the key. Compares without case.
stale_days	requête	integer	non	stale counts agents without a succeeded backup for this number of days. Défaut : 7. Valeur : 1 à 90.

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
success_30d	object	oui	B1: backup jobs scheduled in the last 30 days, by outcome.
success_30d.jobs	integer	oui	succeeded + partial + failed + interrupted + missed. Valeur minimum : 0.
success_30d.succeeded	integer	oui	Valeur minimum : 0.
success_30d.partial	integer	oui	Valeur minimum : 0.
success_30d.failed	integer	oui	Valeur minimum : 0.
success_30d.interrupted	integer	oui	Valeur minimum : 0.
success_30d.missed	integer	oui	Without missed of cause repo_migrating Valeur minimum : 0.
success_30d.success_rate	number | null	oui	succeeded / jobs; null without jobs.
success_30d.from_exclusive	string (date-time)	oui
success_30d.to_inclusive	string (date-time)	oui
stale	object	oui	B2: agents without a succeeded backup for stale_days days.
stale.days	integer	oui	Valeur minimum : 0.
stale.endpoints	integer	oui	Agents whose last succeeded backup (or creation, without one) is days old or more. Valeur minimum : 0.
stale.never	integer	oui	Part of endpoints without any succeeded backup. Valeur minimum : 0.
endpoints	object	oui	Endpoints of the MSP not deleted (a pending deletion still counts)
endpoints.agent_online	integer	oui	Live entry in the presence registry. Valeur minimum : 0.
endpoints.agent_offline	integer	oui	Valeur minimum : 0.
endpoints.m365	integer	oui	Valeur minimum : 0.
protected_source_24h	object	oui	Cumulative logical source bytes of accepted agent snapshots (succeeded/partial) and M365 units completed in (from, to]. Unknown measurements are never zero.
protected_source_24h.from_exclusive	string (date-time)	oui
protected_source_24h.to_inclusive	string (date-time)	oui
protected_source_24h.source_bytes	string | null	oui
protected_source_24h.known_source_bytes	string	oui
protected_source_24h.measured_units	integer	oui	Valeur minimum : 0.
protected_source_24h.unknown_units	integer	oui	Valeur minimum : 0.
protected_source_24h.availability	"complete" | "partial" | "unavailable"	oui
problems	object	oui	Exact 7-day totals before limits, of the open problems only: a resolved problem job (resolved) or an acknowledged one is not counted. One representative per endpoint, failed > interrupted > missed > partial, then scheduled_at and ID descending. Groups ordered by first representative. GET /dashboard/problems lists omitted history.
problems.as_of	string (date-time)	oui
problems.clients	integer	oui	Valeur minimum : 0.
problems.endpoints	integer	oui	Valeur minimum : 0.
problems.jobs	integer	oui	Valeur minimum : 0.
problems.resolved_jobs	integer	oui	Problem jobs of the window resolved since: in GET /dashboard/problems with state: all, not in jobs Valeur minimum : 0.
problems.acknowledged_jobs	integer	oui	Problem jobs of the window not resolved but hidden by an acknowledgement: not in jobs Valeur minimum : 0.
problems.groups	array of object	oui	Éléments maximum : 5.
stored_bytes	integer	oui	Sum of the latest usage_daily.stored_bytes sample of each endpoint not deleted; 0 before the first sample. Valeur minimum : 0.
vms_failed	object	non	Hyper-V VMs in failure in the scope. Optional for older readers, always sent.
vms_failed.vms	integer	oui	Hyper-V VMs and Proxmox VMs and containers present on their host, backed up by a VM policy, whose last result is failed Valeur minimum : 0.
vms_failed.endpoints	integer	oui	Hosts of these VMs. Valeur minimum : 0.
first_backups_unfinished	object	oui	Open "first backup unfinished" alerts of the endpoints of the scope, oldest first, 20 at most: a policy with no snapshot N days after its first run started.
first_backups_unfinished.total	integer	oui	Open alerts before the limit. Valeur minimum : 0.
first_backups_unfinished.items	array of object	oui	Éléments maximum : 20.
first_backup_resets	object	oui	Open "first backup reset" alerts of the endpoints of the scope, newest first, 20 at most: the data of an abandoned first backup was deleted. The alert ends at the next snapshot of the endpoint.
first_backup_resets.total	integer	oui	Open alerts before the limit. Valeur minimum : 0.
first_backup_resets.items	array of object	oui	Éléments maximum : 20.
mssql_alerts	object	oui	Open SQL Server alerts (mssql_rights_missing, mssql_log_growing) of the endpoints of the scope, oldest first, 20 at most.
mssql_alerts.total	integer	oui	Open alerts before the limit. Valeur minimum : 0.
mssql_alerts.items	array of object	oui	Éléments maximum : 20.
recent_problem_jobs	array of object	oui	Newest first: jobs failed, partial, missed, interrupted of endpoints not deleted, scheduled in the last 7 days, 20 at most. Without missed jobs of cause repo_migrating: a platform action, not shown to the MSP.
recent_problem_jobs[].id	string (uuid)	oui
recent_problem_jobs[].endpoint_id	string (uuid)	oui
recent_problem_jobs[].type	"backup" | "baremetal_backup" | "mssql_backup" | "vm_backup" | "init" | "unlock" | "forget" | "prune" | "check" | "migrate" | "update" | "reset_first_backup"	oui
recent_problem_jobs[].status	"scheduled" | "dispatched" | "running" | "succeeded" | "partial" | "failed" | "cancelled" | "interrupted" | "preempted" | "missed" | "superseded"	oui
recent_problem_jobs[].trigger	"schedule" | "manual" | "system"	oui
recent_problem_jobs[].policy_id	string (uuid) | null	non	The backup policy of a backup run; null for maintenance or a backup without policy. Optional for older readers [C13], always sent.
recent_problem_jobs[].cause	string | null	oui	Typed cause, for example no_ack or repo_migrating
recent_problem_jobs[].scheduled_at	string (date-time)	oui	Request time for a manual job.
recent_problem_jobs[].window_ends_at	string (date-time) | null	oui
recent_problem_jobs[].started_at	string (date-time) | null	oui
recent_problem_jobs[].ended_at	string (date-time) | null	oui
recent_problem_jobs[].snapshot_id	string | null	oui	succeeded or partial backup only.
recent_problem_jobs[].summary	object | null	oui	Final restic summary, backup only.
recent_problem_jobs[].error_count	integer | null	oui	Unreadable files of a partial backup.
recent_problem_jobs[].file_error_codes	array of object | null	non	Count per typed code of the stored file errors of a partial backup (at most 100; error_count is the real total), most frequent first, without paths or text: for every role and for an OAuth access token (MCP). Null without stored errors. Optional for older readers [C13], always sent.
recent_problem_jobs[].error	string | null	oui
recent_problem_jobs[].upload_limit	number | null	non	Upload limit sent to the agent for this backup, MiB/s: the exception of the agent, else the limit of the policy, fixed when the order is sent. Null: no limit, or not a backup. Optional for older readers [C13], always sent.
recent_problem_jobs[].progress	object | null	oui	Only while running
recent_problem_jobs[].hooks	object | null	non	Scripts before and after a backup, per phase: version, SHA-256, status, exit code, duration, output. Null: none ran. Optional for older readers [C13], always sent.
recent_problem_jobs[].volume	object | null	non	Size and count of a succeeded or partial backup of any kind. Null: not a backup, no snapshot, or another status. Optional for older readers [C13], always sent.
recent_problem_jobs[].endpoint_name	string	oui
recent_problem_jobs[].client_id	string (uuid)	oui

Get dashboard tag groups

GET /dashboard/tag-groups

Accès : Clé API du MSP, portée read.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
key	requête	string	oui	The tag key to group by; 404 when the MSP does not have it. Longueur : 1 à 64.
client_id	requête	string (uuid)	non	Endpoints of this client only; 404 for a client of another MSP.
tag	requête	string | array of string	non	key:value, repeat for several (AND). Key and value compare without case.
no_tag	requête	string | array of string	non	A tag key, repeat for several (AND): the endpoint does not have the key. Compares without case.
stale_days	requête	integer	non	stale counts agents without a succeeded backup for this number of days. Défaut : 7. Valeur : 1 à 90.

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
key_id	string (uuid)	oui
key	string	oui
as_of	string (date-time)	oui
stale_days	integer	oui	Valeur minimum : 0.
groups	array of object	oui	One row per value, most endpoints first, then by value; the row without the key is last and always present. The rows add up to the totals of GET /dashboard with the same client_id, tag and no_tag
groups[].value	string | null	oui	The value (stored form); null for the endpoints without the key.
groups[].endpoints	integer	oui	agent_online + agent_offline + m365. Valeur minimum : 0.
groups[].agent_online	integer	oui	Valeur minimum : 0.
groups[].agent_offline	integer	oui	Valeur minimum : 0.
groups[].m365	integer	oui	Valeur minimum : 0.
groups[].problem_endpoints_7d	integer	oui	Endpoints with at least one open problem job in the 7-day problem window of GET /dashboard Valeur minimum : 0.
groups[].problem_jobs_7d	integer	oui	Open problem jobs, the rule of problems of GET /dashboard Valeur minimum : 0.
groups[].success_30d	object	oui
groups[].stale_endpoints	integer	oui	Same rule as stale.endpoints of GET /dashboard Valeur minimum : 0.
groups[].stored_bytes	integer	oui	Valeur minimum : 0.

Export dashboard tag groups

GET /dashboard/tag-groups/export

Accès : Clé API du MSP, portée read.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
key	requête	string	oui	The tag key to group by; 404 when the MSP does not have it. Longueur : 1 à 64.
client_id	requête	string (uuid)	non	Endpoints of this client only; 404 for a client of another MSP.
tag	requête	string | array of string	non	key:value, repeat for several (AND). Key and value compare without case.
no_tag	requête	string | array of string	non	A tag key, repeat for several (AND): the endpoint does not have the key. Compares without case.
stale_days	requête	integer	non	stale counts agents without a succeeded backup for this number of days. Défaut : 7. Valeur : 1 à 90.

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Get license overview

GET /license

Accès : Clé API du MSP, portée read.

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
state	"valid" | "grace" | "overdraft" | "exhausted" | "none" | "trial_expired"	oui
backups_allowed	boolean	oui
new_workloads_allowed	boolean	oui
license	object | null	oui
commit	object | null	oui
balance	object | null	oui
month_usage	object | null	oui
trial	object | null	oui
alerts	array of object	oui
alerts[].type	"expiry_near" | "grace" | "commit_consumed" | "balance_projection" | "overdraft_started" | "overdraft_exhausted" | "usage_cap_reached" | "clock_behind" | "backups_stopped"	oui
alerts[].severity	"info" | "warning" | "critical"	oui
alerts[].since	string (date-time)	oui
alerts[].value	integer | null	oui

Get license usage

GET /license/usage

Accès : Clé API du MSP, portée read.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
days	requête	integer	non	Défaut : 30. Valeur : 1 à 90.

Réponses

Code	Description
200	Success
default	Error (400, 401, 403, 404, 409, 415, 422, 429, 500, 502, 503 or 504)

Réponse 200 (application/json)

Nom	Type	Obligatoire	Description
state	"valid" | "grace" | "overdraft" | "exhausted" | "none" | "trial_expired"	oui
billing	"prepaid" | "postpaid" | "none" | null	oui
days	array of object	oui
days[].day	string (date)	oui
days[].state	"valid" | "grace" | "overdraft" | "exhausted" | "none" | "trial_expired"	oui
days[].charged	boolean	oui
days[].consumed	integer	oui	Valeur minimum : 0.
days[].workloads	array of object	oui
balance	object | null	oui
month_usage	object | null	oui
projection	object | null	oui