Platform & admin
Admin
Explore the data types and operations available in Admin.
167 operations
Read current deployment state; source is held separately in Git.
iacStackValuesQueryList the current value of every variable the stack holds, set ones only, with secrets listed by name and never by value. Requires stack read access.
iacUpdateEditingMutationUpdate authoring presence without changing source or deployment state.
iacUpdateStackRulesMutationChange a stack's rules. Every change is recorded. Requires stack administration; invalid values are refused with INVALID_RULES.
iacValidateQueryValidate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
iamAuthoringCapabilitiesQueryConditional authoring availability and supported actions, business attributes, operators and limits. Metadata only; does not grant access.
listArchiveExecutionsQueryRun history for one archive job, newest run first (by startedAt), with pagination. Scoped to the caller's tenant. Requires archiveExecution:list permission.
listArchiveJobsQueryList the tenant's archive jobs as a cursor-paginated connection, filtered and sorted in the database. Requires archiveJob:list permission.
listBotAPITokensQueryList the API tokens belonging to a bot user. Returns an empty list if the target user is not a bot. Requires apitoken:list permission.
listConfigVersionsQueryList version history for tenant configuration, newest first, with pagination. Requires tenantConfig:list permission.
listDataChangeEventTopicsQueryList all valid data change event topics, grouped by resource. Requires authentication.
listEndpointLogsQueryList endpoint logs with pagination. Requires incomingWebhook:read permission.
listIAMActionsQueryList all available IAM actions grouped by resource. Requires authentication.
listIAMPoliciesQueryList IAM policies with pagination. Requires iam:listPolicies permission.
listMagicQueriesQueryLists every available Magic Query noun with a short description and its options — the discovery entry point.
listMyAPITokensQueryList the current user's API tokens with pagination. Requires apitoken:list permission.
listTaskDefinitionsQueryList task definitions with pagination. Requires taskDefinition:list permission.
listTeamsQueryList teams with pagination. Requires team:list permission.
listUserPoliciesQueryList policies attached to a user. Requires iam:listUserPolicies permission.
listUsersQueryList users with pagination and filtering. Requires user:list permission.
magicQueryQueryExecutes a Magic Query string and returns the predefined query's JSON result. On a bad noun or parameter, returns a structured error whose 'extensions' carry 'code', 'actionable_message', and 'suggestions' for self-correction.
meQueryWho the caller is and which tenant they are acting in. Requires authentication but no permission: a caller asking who they are needs no authority over anything.
myEffectivePermissionsQueryGet current user's effective permissions. Requires authentication.
pingQueryHealth check endpoint
platformInfoQueryWhich build of the platform is answering. Compare across deployments to tell them apart, or across time to notice that the server changed under a cached set of workarounds.
previewIAMPolicyQuerySimulate a draft alongside a user's attached policies, or replacing one attachment. Requires iam:listUserPolicies and iam:readPolicy. Supplied time, network and sample values are simulation only; no resource records are read or permissions changed.
queryLogsQueryQuery logs across all drains (webhook, execution, edge app, archive). Requires log:list permission.
removeJmfTokenMutationRemoves the JMF access token. While the endpoint is on, anything that can reach it can then post signals.
removeTeamMemberMutationRemove a user from a team. Requires team:write permission.
renderSchemaXMLQueryRender JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
revealJmfTokenMutationShows the JMF access token so an operator can set up a device. Every reveal is recorded with who and when.
revokeAPITokenMutationRevoke an API token. Requires apitoken:revoke permission.
revokeBotAPITokenMutationRevoke an API token belonging to a bot user. Fails if the token's owner is not a bot. Requires apitoken:revoke permission.
rollbackConfigMutationRollback to a previous config version. Creates a new version with the old data. Requires tenantConfig:write permission.
runArchiveJobMutationRun an archive job immediately, regardless of its schedule or isEnabled flag. Enqueues the work and returns a PENDING ArchiveExecution to poll; the run itself happens asynchronously. Requires an authenticated user and archiveJob:execute permission.
schemaAuthoringCatalogQueryCompiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
searchHelpQuerySearch human-facing manuals using shared semantic and text retrieval.
setJmfTokenMutationSets or replaces the JMF access token with one you supply, e.g. the one your devices already send.
setTeamMemberRoleMutationSet a team member's role. Team admins administer the stacks the team owns. Requires team:write permission.
settingsQueryThis instance's settings. Needs tenantPreferences:read or tenantConfig:read; each section then needs the permission that guarded its data before Settings existed, and is null with an error without it.
streamLogsSubscriptionStream logs across drains (webhook, execution, edge app) as they are written. Requires log:list permission.
teamsForUserQueryTeams an account belongs to. Requires team:read permission.
updateAppAccessSettingsMutationSaves the app access section. Other sections are untouched.
updateArchiveJobMutationUpdate an archive job. Only provided fields are changed. Requires archiveJob:write permission.
updateConditionalIAMPolicyMutationUpdate an IAM policy, refusing the change if it was edited since expectedRevision. Requires iam:updatePolicy permission.
updateConfigMutationUpdate tenant configuration. Creates a new version. For SECRET entries with null value, the existing secret is preserved. Requires tenantConfig:write permission.
updateFulfillmentSettingsMutationSave only the fulfillment section, preserving every other settings section
updateIAMPolicyMutationUpdate an IAM policy. Requires iam:updatePolicy permission.
updateImposingSettingsMutationSaves the imposing section. Other sections are untouched.
updateJmfSettingsMutationTurns the direct JMF endpoint on or off. The token is untouched.