Which APIs are available to who? What are the different APIs?

The different APIs are available for viewing on the left-hand side of the page at this link.

The table below lists which API is available to whom.

  • Public = the API is available for public use
  • Power/Moderator/Administrator/Super = the API can only be used by the specified kinds of users
  • Authentication required = the API requires authentication
  • None (internal use only) / Not for public = the API is only to be used internally within the software
API Access
PUT BulkExportFiles_CancelBulkExportFile Super
DELETE BulkExportFiles_DeleteBulkExportFile Super
GET BulkExportFiles_GetBulkExportFile Super
GET BulkExportFiles_GetBulkExportFiles Super
POST BulkExportFiles_PostBulkExportFile Super
PUT BulkExportFiles_StartBulkExportFile Super
POST BulkImportFiles_AuroraWatchNet Public
GET BulkImportFiles_GetBulkUploadStatus Public
GET Configurations_IoTCarsConfiguration Public
GET Export_ExportDiariesToMIDAS None (internal use only)
GET Export_ExportObservationsToMetDB None (internal use only)
GET Export_ExportObservationsToMIDAS None (internal use only)
GET Export_ExportSitesToMetDB None (internal use only)
GET Forecasts_Get Public
POST Groups_AddOwnerToGroup Authentication required
POST Groups_AddSiteToGroup Authentication required
DELETE Groups_DeleteGroup Super
GET Groups_GetGroup Public
GET Groups_GetGroupOwners Public
GET Groups_GetGroups Public
GET Groups_GetGroupSites Public
GET Groups_GetGroupSitesWithSiteId Public
GET Groups_GetGroupTypes Public
GET Groups_GetPublicAndPrivateGroups Public
GET Groups_GetPublicGroups Public
GET Groups_GetWaitingGroupRequests Authentication required
GET Groups_GetWaitingGroupRequestsForSite Authentication required
POST Groups_PostGroup Super
PUT Groups_PutGroup Super
DELETE Groups_RemoveOwnerFromGroup Authentication required
DELETE Groups_RemoveSiteFromGroup Authentication required
PUT Groups_SetGroupRequestState Authentication required
GET Groups_SetGroupRequestStateForSite Authentication required
GET GroupTypes_GetGroupType Public
GET GroupTypes_GetGroupTypes Public
POST GroupTypes_PostGroupType Super
PUT GroupTypes_PutGroupType Super
PUT Images_Allow Moderator, Administrator, Super
DELETE Images_Delete Moderator, Administrator, Super
DELETE Images_DeleteFlagged Moderator, Administrator, Super
POST Images_Flag Authentication required
GET Images_Get Public
GET Images_GetFlaggedImages Moderator, Administrator, Super
GET Images_GetWithParams Public
POST Images_IsLiked Authentication required
POST Images_Like Authentication required
OPTIONS Images_Options Public
POST Images_Post Public
POST Images_Publish Public
PUT Images_Put Moderator, Administrator, Super
GET Images_Tags Public
POST Images_UnLike Authentication required
DELETE ObservationParameters_DeleteObservationParameter Super
GET ObservationParameters_GetObservationParameter Public
GET ObservationParameters_GetObservationParameters Public
POST ObservationParameters_PostObservationParameter Super
PUT ObservationParameters_PutObservationParameter Super
GET Observations_BulkFileStatus Public
DELETE Observations_DeleteMultipleObservations None (internal use only)
DELETE Observations_DeleteObservation None (internal use only)
POST Observations_FlagObservation Public
GET Observations_GetAreaBasedObservationsAsCanonicalGeoJson Public
GET Observations_GetDailyObservationsAsGeoJson Public
GET Observations_GetGraphView Public
GET Observations_GetLatestBySiteId Public
GET Observations_GetObservation Public
GET Observations_GetObservationsAsExternalGeoJson Public
GET Observations_GetObservationsAsGeoJson Public
GET Observations_GetObservationsBySite Public
GET Observations_GetObservationsBySites Public
GET Observations_GetObservationsByVersion Public
GET Observations_GetObservationsVersions Public
GET Observations_GetPrecipitations Public
GET Observations_GetQuickObservationsOfCurrentUser Authentication required
GET Observations_GetSingleObservationAsGeoJson Public
GET Observations_GetSiteBasedObservationsAsCanonicalGeoJson Public
GET Observations_GetTableView Public
POST Observations_isFlaggedByUser Authentication required
OPTIONS Observations_Options Public
POST Observations_PostObservation Public
GET Observations_PostObservationFromAutomaticWeatherlinkWeatherStation_GET Public
POST Observations_PostObservationFromAutomaticWeatherlinkWeatherStation_POST Public
GET Observations_PostObservationFromAutomaticWeatherStation_GET Public
POST Observations_PostObservationFromAutomaticWeatherStation_POST Public
POST Observations_PostObservationFromWebsite None (internal use only)
POST Observations_UpdateObservationFromWebsite None (internal use only)
POST Observations_UploadBulkFile Public
DELETE ProfilerRecords_Delete Public
GET ProfilerRecords_Get Public
DELETE ReferenceDatas_DeleteReferenceData Administrator, Super
GET ReferenceDatas_GetReferenceData Public
GET ReferenceDatas_GetReferenceDatas Public
POST ReferenceDatas_PostReferenceData Administrator, Super
PUT ReferenceDatas_PutReferenceData Administrator, Super
DELETE SiteHolidays_DeleteSiteHoliday Authentication required
GET SiteHolidays_GetSiteHoliday Public
GET SiteHolidays_GetSiteHolidays Public
POST SiteHolidays_PostSiteHoliday Authentication required
PUT SiteHolidays_PutSiteHoliday Authentication required
POST SiteHolidays_UpdateSiteHolidays Authentication required
POST SiteInvite_ApproveInvite Authentication required
GET SiteInvite_GetInvites Authentication required
POST SiteInvite_PostInvite Authentication required
POST SiteInvite_RejectInvite Authentication required
GET Sites_AggregateById Public
POST Sites_Allow Authentication required
DELETE Sites_Delete Super
POST Sites_Flag Public
GET Sites_GetChanged Public
GET Sites_GetFlaggedSite Authentication required
GET Sites_GetFlaggedSites Authentication required
GET Sites_GetObservationSite Public
GET Sites_GetObservationSiteDataMeasurement Public
GET Sites_GetOfficialSiteById Public
GET Sites_GetSite Public
GET Sites_GetSiteBadges Public
GET Sites_GetSiteCounts Moderator, Super
GET Sites_GetSiteReport Moderator, Super
GET Sites_GetSitesAsCanonicalGeoJson Public
GET Sites_GetSitesWithDCNN Power, Super
GET Sites_GetSitesWithMembership Authentication required
GET Sites_GetSubmissionDays Public
GET Sites_LegacyJsonFormatterEndpoint Not for public
GET Sites_NearestOfficial Public
POST Sites_PostSite Authentication required
PUT Sites_PutSite Authentication required
GET Sites_Relinquish Super
DELETE Sites_RemoveDCNN Power, Super
POST Sites_SaveDefaultGraphViewFields Authentication required
POST Sites_SaveDefaultTableViewFields Authentication required
GET Sites_Search Public
POST Sites_SetAsOfficial Administrator, Super
GET Sites_TakeControl Super
POST Sites_Update Authentication required
PUT Sites_UpdateDCNN Power, Super
POST Support_CreateFeedback None (internal use only)
POST UserNotifications_AcknowledgeUserNotification Authentication required
DELETE UserNotifications_DeleteUserNotification Power, Moderator, Administrator, Super
GET UserNotifications_GetCurrentUserNotifications Authentication required
GET UserNotifications_GetUserNotification Authentication required
GET UserNotifications_GetUserNotifications Power, Moderator, Administrator, Super
POST UserNotifications_PostUserNotification Power, Moderator, Administrator, Super
DELETE Users_DeleteUser Super
GET Users_GetCurrentUser Authentication required
GET Users_GetSchoolSitesForCurrentUser Authentication required
GET Users_GetSitesForCurrentUser Authentication required
GET Users_GetSitesGroupsForCurrentUser Authentication required
GET Users_GetUnitForCurrentUser Authentication required
GET Users_GetUser Public
GET Users_GetUserByUniqueIdentityKey Public
GET Users_GetUserByUsername Public
GET Users_GetUsers Super
POST Users_PostUnitForCurrentUser Authentication required
POST Users_PostUser None (internal use only)
PUT Users_PutCurrentUser Authentication required
PUT Users_PutCurrentUserUniqueIdentityKey Authentication required
PUT Users_PutUser Super
PUT Videos_Allow Moderator, Administrator, Super
DELETE Videos_Delete Moderator, Administrator, Super
DELETE Videos_DeleteFlagged Moderator, Administrator, Super
POST Videos_Flag Authentication required
GET Videos_Get Public
GET Videos_GetFlaggedVideos Authentication required
GET Videos_GetWithParams Public
POST Videos_IsLiked Authentication required
POST Videos_Like Authentication required
OPTIONS Videos_Options Public
POST Videos_Post Public
POST Videos_Publish Public
PUT Videos_Put Public
GET Videos_Tags Public
POST Videos_UnLike Authentication required
DELETE WeatherImpactReports_DeleteWeatherImpactReport Super
GET WeatherImpactReports_GetHazards Public
GET WeatherImpactReports_GetWeatherImpactReport Public
GET WeatherImpactReports_GetWeatherImpactReports Super
GET WeatherImpactReports_GetWeatherImpactReportsOfCurrentUser Authentication required
POST WeatherImpactReports_PostWeatherImpactReport Public
DELETE Webcams_Delete Authentication required
GET Webcams_Get Public
GET Webcams_GetBySiteId Public
GET Webcams_GetCurrentUserWebcams Authentication required
GET Webcams_GetImages Public
GET Webcams_GetUrl Public
GET Webcams_GetWebcamsDetailsById Authentication required
POST Webcams_PostWebcam Authentication required
PUT Webcams_PutWebcam Authentication required