/

Docs
History
Schema
Generate

Filter operations

get/.well-known/jwks.jsonEndpoint: oidc.keys
get/.well-known/openid-configurationEndpoint: oidc.discovery
patch/api/v1/account/profileUpdate the caller's shared ``name`` and/or ``institution`` only.
get/api/v1/admin/app-accessList per-application access grants.
get/api/v1/admin/app-access/appsList the gated applications and their role vocabularies.
put/api/v1/admin/app-access/apps/{app_key}/notification-recipientsReplace the access-request notification list for *app_key*.
get/api/v1/admin/client-statsGet aggregated client platform usage statistics.
post/api/v1/admin/newsCreate a new news item.
delete/api/v1/admin/news/{news_id}Delete a news item.
put/api/v1/admin/news/{news_id}/translationsUpdate translations for a news item.
delete/api/v1/admin/news/{news_id}/translations/{lang}Delete a specific translation for a news item.
post/api/v1/admin/oidc-clientsRegister an OIDC client; only API administrators may provision clients.
get/api/v1/admin/users/{subject}Endpoint: oidc.admin_user_lookup
post/api/v1/admin/users/{user_id}/app-accessGrant, update, or revoke a user's access to a gated application.
delete/api/v1/admin/users/{user_id}/app-access/{app_key}Revoke a user's access to a gated application.
get/api/v1/apps/{app_key}/meReturn the caller's profile and effective access to *app_key*.
get/api/v1/apps/{app_key}/usersExact-email lookup or the application user directory.
post/api/v1/apps/{app_key}/users/resolveResolve up to 100 subjects to application profiles.
put/api/v1/apps/{app_key}/users/{subject}/accessApprove, revoke, or change the role of *subject* (administrators only).
post/api/v1/bulk-emailCreate a draft bulk email.
get/api/v1/bulk-email/configReturn bulk email config (max_recipients, from_email) for superadmins.
post/api/v1/bulk-email/recipient-listCreate a named recipient list from filter criteria.
post/api/v1/bulk-email/recipient-list/previewPreview users matching filter criteria without saving.
patch/api/v1/bulk-email/recipient-list/{list_id}Update an existing saved recipient list.
delete/api/v1/bulk-email/{bulk_email_id}Delete a draft bulk email.
post/api/v1/bulk-email/{bulk_email_id}/restore-draftRestore a SENT or FAILED bulk email back to DRAFT status.
post/api/v1/bulk-email/{bulk_email_id}/sendSend a bulk email.
post/api/v1/bulk-email/{bulk_email_id}/send-testSend bulk email as test to superadmins only (no 2FA, status unchanged).
post/api/v1/bulk-email/{bulk_email_id}/send-test-selfSend bulk email as test to the requesting user only (no 2FA, status unchanged).
post/api/v1/bulk-email/{bulk_email_id}/send-verificationGenerate and email a 6-digit OTP to the caller for this bulk email.
get/api/v1/data/boundariesGet administrative boundary metadata with download URLs.
get/api/v1/data/boundaries/last-updatedGet the most recent modification timestamp across all boundaries.
get/api/v1/data/boundaries/listGet hierarchical list of all boundaries with ADM1 nested under ADM0.
get/api/v1/executionRetrieve all executions with admin filtering and cross-user visibility.
get/api/v1/execution/exportExport executions as a CSV file (admin only).
get/api/v1/execution/userRetrieve executions for the current authenticated user.
patch/api/v1/execution/{execution}Update an execution's properties (admin only).
get/api/v1/execution/{execution}/batch-logsRetrieve AWS Batch (CloudWatch) logs for a specific execution.
patch/api/v1/execution/{execution}/callbackUpdate only the execution identified by an execution-bound credential.
post/api/v1/execution/{execution}/callback/logAppend a log only to the credential's execution.
post/api/v1/execution/{execution}/cancelCancel a running execution and any associated Google Earth Engine tasks.
get/api/v1/execution/{execution}/docker-logsRetrieve Docker service logs for a specific execution.
get/api/v1/execution/{execution}/download-resultsDownload execution results as a JSON file.
post/api/v1/execution/{execution}/logCreate a log entry for a specific execution (admin only).
post/api/v1/gee-oauth/callbackComplete GEE OAuth flow without requiring a JWT — for clients (e.g. the QGIS
get/api/v1/google-groups/infoRetrieve public information about available Google Groups.
get/api/v1/newsRetrieve news items for display in clients.
get/api/v1/news/{news_id}Retrieve a single news item by ID.
get/api/v1/oauth/clientsList the caller's active (non-revoked) service clients.
delete/api/v1/oauth/clients/{client_db_id}Revoke a service client by its database UUID.
post/api/v1/oauth/tokenExchange client credentials for a short-lived access token.
get/api/v1/rate-limit/eventsRetrieve historical rate limit breach events for auditing.
post/api/v1/rate-limit/resetReset all rate limits across the system.
post/api/v1/rate-limit/reset/{identifier}Reset a specific rate limit by its identifier.
get/api/v1/rate-limit/statusQuery current rate limiting status across the system.
get/api/v1/scriptRetrieve all scripts with flexible filtering, sorting, and pagination.
get/api/v1/script/exportExport scripts as a CSV file (admin only).
delete/api/v1/script/{script_id}/accessRemove all access restrictions from a script.
put/api/v1/script/{script_id}/access/appAllow users with an active application grant to access a script.
put/api/v1/script/{script_id}/access/rolesSet role-based access control for a script.
delete/api/v1/script/{script_id}/access/roles/{role}Remove a specific role from script access control list.
put/api/v1/script/{script_id}/access/usersSet user-specific access control for a script.
delete/api/v1/script/{script_id}/access/users/{user_id}Remove a specific user from script access control list.
delete/api/v1/script/{script}Permanently delete a script and all associated data.
patch/api/v1/script/{script}/configUpdate script metadata without uploading a new script archive.
get/api/v1/script/{script}/downloadDownload a script's source code and files as a compressed archive.
get/api/v1/script/{script}/logRetrieve processing and validation logs for a specific script.
post/api/v1/script/{script}/publishPublish a script to make it available for execution.
post/api/v1/script/{script}/runExecute a script with provided parameters.
post/api/v1/script/{script}/unpublishUnpublish a script to make it unavailable for new executions.
delete/api/v1/stats/cacheClear the stats cache.
get/api/v1/stats/dashboardGet comprehensive dashboard statistics.
get/api/v1/stats/executionsGet execution statistics and trends.
get/api/v1/stats/healthGet basic health check for stats endpoints.
get/api/v1/stats/usersGet user statistics and geographical distribution.
get/api/v1/statusRetrieve system status logs for monitoring and diagnostics.
get/api/v1/status/clusterGet cluster status (orchestrator-agnostic alias for /status/swarm).
get/api/v1/status/swarmGet cached Docker Swarm cluster status including comprehensive node information.
patch/api/v1/unsubscribeUpdate the email subscription preferences for a tokenised user.
get/api/v1/userRetrieve list of users with filtering, sorting, and pagination.
get/api/v1/user/exportExport users as a CSV file (admin only).
delete/api/v1/user/meDelete current user's account and all associated data.
get/api/v1/user/me/app-accessList the caller's own application grants and pending requests.
post/api/v1/user/me/app-access/{app_key}Request access to a gated application.
patch/api/v1/user/me/change-passwordChange current user's password with old password verification.
get/api/v1/user/me/clientsGet current user's client platform metadata.
delete/api/v1/user/me/gee-credentialsDelete current user's Google Earth Engine credentials.
patch/api/v1/user/me/gee-credentials/projectSave the user's selected GEE Cloud Project ID and grant bucket write access.
post/api/v1/user/me/gee-credentials/testTest current user's Google Earth Engine credentials.
post/api/v1/user/me/gee-oauth/callbackComplete OAuth flow and store Google Earth Engine credentials.
post/api/v1/user/me/gee-oauth/initiateInitiate OAuth flow for Google Earth Engine authentication.
post/api/v1/user/me/gee-service-accountUpload Google Earth Engine service account credentials.
put/api/v1/user/me/google-groupsUpdate current user's Google Groups preferences and trigger synchronization.
post/api/v1/user/me/google-groups/syncManually trigger synchronization of user's Google Groups memberships.
delete/api/v1/user/me/openeo-credentialsRemove the current user's stored openEO credentials.
get/api/v1/user/me/openeo-credentials/checkValidate the current user's stored openEO credentials against the backend.
delete/api/v1/user/me/sessionsRevoke all authentication sessions for current user (logout everywhere).
delete/api/v1/user/me/sessions/{session_id}Revoke a specific authentication session.
post/api/v1/user/reset-passwordReset password using a secure token from password recovery email.
delete/api/v1/user/{user_id}/gee-credentialsDelete another user's Google Earth Engine credentials (Admin only).
post/api/v1/user/{user_id}/gee-credentials/testTest another user's Google Earth Engine credentials (Admin only).

Changes to Return the caller's profile and effective access to app_key.

get/api/v1/apps/{app_key}/me

Oct 17, 20265b9a4507913b Revision changes
- info
  endpoint added