I/O Docs: API Documentation
Test our API services using I/O Docs. You can also view our written documentation.
This is the interactive documentation for the V3 API. The API is now in GA. Please contact Support if you have any questions.
API for managing Members, Applications, Roles and Package Keys (MARK). The API is now in GA. Please contact Support if you have any questions.
API for managing Organizations
This is the interactive documentation for the Reporting V3 API. The API is now in GA. Please contact Support if you have any questions.
-
Administration Methods
-
POST Call Mashery API (JSON-RPC) /v2/json-rpc/:site_id
-
-
Reporting Methods
-
GET CallsQPSForArea /v2/rest/:site_id/reports/calls/qps/area
-
GET CallsQPSForDeveloper /v2/rest/:site_id/reports/calls/qps/developer
-
GET CallsQPSForEndpoint /v2/rest/:site_id/reports/calls/qps/endpoint
-
GET AreaPlatformLatencyPercentileNinetyFive /v2/rest/:site_id/reports/area/platformlatency/percentile-ninety-five
-
GET CallsCountsChangeOverTime /v2/rest/:site_id/reports/calls/counts/change_over_time
-
GET KeysUsageConsistency /v2/rest/:site_id/reports/keys/usage/consistency
-
GET PercentageCommunicationAvailablity /v2/rest/:site_id/reports/percentage/communication/availability
-
GET AreaQpsRate /v2/rest/:site_id/reports/area/qpsrate
-
GET AreaDataServed /v2/rest/:site_id/reports/area/data-served
-
GET AreaCacheHitRate /v2/rest/:site_id/reports/area/cache-hit-rate
-
GET AreaCountMembersRegistered /v2/rest/:site_id/reports/area/count/members-registered
-
GET AreaCountApplicationsCreated /v2/rest/:site_id/reports/area/count/applications-created
-
GET AreaCountKeysDistributed /v2/rest/:site_id/reports/area/count/keys-distributed
-
GET TotalCallsPackagesSummary /v2/rest/:site_id/reports/total/calls/packages-summary
-
GET AreaPlatformStatusTrend /v2/rest/:site_id/reports/area/platform-status/trend
-
GET AreaPlatformAvailabilityTrend /v2/rest/:site_id/reports/area/platform-availablity/trend
-
GET AreaQpsTrend /v2/rest/:site_id/reports/area/qps/trend
-
GET AreaDataServedTrend /v2/rest/:site_id/reports/area/data-served/trend
-
GET AreaPlatformStatus /v2/rest/:site_id/reports/area/platform/status
-
GET CallsDeveloperActivityForService /v2/rest/:site_id/reports/calls/developer_activity/service/:service_key
-
GET CallsErrorcodesForService /v2/rest/:site_id/reports/calls/errorcodes/service/:service_key
-
GET CallsErrorcodesForServiceForDeveloper /v2/rest/:site_id/reports/calls/errorcodes/service/:service_key/developer/:service_dev_key
-
GET CallsErrorcountByDeveloperForService /v2/rest/:site_id/reports/calls/errorcount_by_developer/service/:service_key
-
GET CallsErrorcountByMethodForService /v2/rest/:site_id/reports/calls/errorcount_by_method/service/:service_key
-
GET CallsLatencyForService /v2/rest/:site_id/reports/calls/latency/service/:service_key
-
GET CallsLatencyByMethodForService /v2/rest/:site_id/reports/calls/latency_by_method/service/:service_key
-
GET CallsLatencyByResponsecodeForService /v2/rest/:site_id/reports/calls/latency_by_responsecode/service/:service_key
-
GET CallsStatusForServiceForDeveloper /v2/rest/:site_id/reports/calls/status/service/:service_key/developer/:service_dev_key
-
GET CallsMethodsForService /v2/rest/:site_id/reports/calls/methods/service/:service_key
-
GET CallsMethodsForServiceForDeveloper /v2/rest/:site_id/reports/calls/methods/service/:service_key/developer/:service_dev_key
-
GET CallsMedianVolumeByHourForService /v2/rest/:site_id/reports/calls/median_volume_by_hour/service/:service_key
-
GET CallsResponsesFromCacheForService /v2/rest/:site_id/reports/calls/responses_from_cache/service/:service_key
-
GET CallsStatusForService /v2/rest/:site_id/reports/calls/status/service/:service_key
-
GET CallsGeolocationForService /v2/rest/:site_id/reports/calls/geolocation/service/:service_key
-
GET CallsGeolocationForServiceForDeveloper /v2/rest/:site_id/reports/calls/geolocation/service/:service_key/developer/:service_dev_key
-
-
Services
-
GET fetch all /services
-
GET fetch /services/:serviceId
-
POST create /services
-
PUT update /services/:serviceId
-
DELETE delete /services/:serviceId
-
-
ServiceRoles
-
GET fetch all /services/:serviceId/roles
-
PUT update /services/:serviceId
-
PUT delete /services/:serviceId
-
-
SecurityProfile
-
GET fetch /services/:serviceId/securityProfile
-
PUT update /services/:serviceId/securityProfile
-
-
OAuth
-
GET fetch /services/:serviceId/securityProfile/oauth
-
POST create /services/:serviceId/securityProfile/oauth
-
PUT update /services/:serviceId/securityProfile/oauth
-
DELETE delete /services/:serviceId/securityProfile/oauth
-
-
ServiceCache
-
GET fetch /services/:serviceId/cache
-
POST create /services/:serviceId/cache
-
PUT update /services/:serviceId/cache
-
DELETE delete /services/:serviceId/cache
-
-
ErrorSets
-
GET fetch all /services/:serviceId/errorSets
-
GET fetch /services/:serviceId/errorSets/:errorSetId
-
POST create /services/:serviceId/errorSets
-
PUT update /services/:serviceId/errorSets/:errorSetId
-
DELETE delete /services/:serviceId/errorSets/:errorSetId
-
-
ErrorMessages
-
GET fetch all /services/:serviceId/errorSets/:errorSetId/errorMessages
-
GET fetch /services/:serviceId/errorSets/:errorSetId/errorMessages/messageType
-
PUT update /services/:serviceId/errorSets/:errorSetId/errorMessages/messageType
-
-
Endpoints
-
GET fetch all /services/:serviceId/endpoints
-
GET fetch /services/:serviceId/endpoints/:endpointId
-
POST create /services/:serviceId/endpoints
-
PUT update /services/:serviceId/endpoints/:endpointId
-
DELETE delete /services/:serviceId/endpoints/:endpointId
-
-
ScheduledMaintenanceEvent
-
GET fetch /services/:serviceId/endpoints/:endpointId/scheduledMaintenanceEvent
-
POST create /services/:serviceId/endpoints/:endpointId/scheduledMaintenanceEvent
-
PUT update /services/:serviceId/endpoints/:endpointId/scheduledMaintenanceEvent
-
DELETE delete /services/:serviceId/endpoints/:endpointId/scheduledMaintenanceEvent
-
-
EndpointCache
-
GET fetch /services/:serviceId/endpoints/:endpointId/cache
-
POST create /services/:serviceId/endpoints/:endpointId/cache
-
PUT update /services/:serviceId/endpoints/:endpointId/cache
-
DELETE delete /services/:serviceId/endpoints/:endpointId/cache
-
-
Cors
-
GET fetch /services/:serviceId/endpoints/:endpointId/cors
-
POST create /services/:serviceId/endpoints/:endpointId/cors
-
PUT update /services/:serviceId/endpoints/:endpointId/cors
-
DELETE delete /services/:serviceId/endpoints/:endpointId/cors
-
-
Roles
-
GET fetch all /roles
-
-
SystemDomainAuthentication
-
GET fetch /services/:serviceId/endpoints/:endpointId/systemDomainAuthentication
-
POST create /services/:serviceId/endpoints/:endpointId/systemDomainAuthentication
-
PUT update /services/:serviceId/endpoints/:endpointId/systemDomainAuthentication
-
DELETE delete /services/:serviceId/endpoints/:endpointId/systemDomainAuthentication
-
-
Methods
-
GET fetch all /services/:serviceId/endpoints/:endpointId/methods
-
GET fetch /services/:serviceId/endpoints/:endpointId/methods/:methodId
-
POST create /services/:serviceId/endpoints/:endpointId/methods
-
PUT update /services/:serviceId/endpoints/:endpointId/methods/:methodId
-
DELETE delete /services/:serviceId/endpoints/:endpointId/methods/:methodId
-
-
Response Filters
-
GET fetch all /services/:serviceId/endpoints/:endpointId/methods/:methodId/responseFilters
-
GET fetch /services/:serviceId/endpoints/:endpointId/methods/:methodId/responseFilters/:responseFilterId
-
POST create /services/:serviceId/endpoints/:endpointId/methods/:methodId/responseFilters
-
PUT update /services/:serviceId/endpoints/:endpointId/methods/:methodId/responseFilters/:responseFilterId
-
DELETE delete /services/:serviceId/endpoints/:endpointId/methods/:methodId/responseFilters/:responseFilterId
-
-
Email Template Sets
-
GET fetch all /emailTemplateSets
-
GET fetch /emailTemplateSets/:emailTemplateSetId
-
-
Email Templates
-
GET fetch all /emailTemplateSets/:emailTemplateSetId/emailTemplates
-
GET fetch /emailTemplateSets/:emailTemplateSetId/emailTemplates/:emailTemplateId
-
-
ScheduledMaintenanceEvents
-
GET fetch all /scheduledMaintenanceEvents
-
GET fetch /scheduledMaintenanceEvents/:scheduledMaintenanceEventId
-
POST create /scheduledMaintenanceEvents
-
PUT update /scheduledMaintenanceEvents/:scheduledMaintenanceEventId
-
DELETE delete /scheduledMaintenanceEvents/:scheduledMaintenanceEventId
-
-
ScheduledMaintenanceEventEndpoints
-
GET fetch all /scheduledMaintenanceEvents/:scheduledMaintenanceEventId/endpoints
-
GET fetch /scheduledMaintenanceEvents/:scheduledMaintenanceEventId/endpoints/:scheduledMaintenanceEventEndpointId
-
POST create /scheduledMaintenanceEvents/:scheduledMaintenanceEventId/endpoints
-
DELETE delete /scheduledMaintenanceEvents/:scheduledMaintenanceEventId/endpoints/:scheduledMaintenanceEventEndpointId
-
-
Domains
-
GET fetch all /domains
-
GET fetch /domains/:domainId
-
POST create /domains
-
-
Public Endpoint Domain Path Methods
-
GET fetch all /domains/public
-
-
System Endpoint Domain Paths
-
GET fetch all /domains/system
-
-
Unique Public Fully Qualified Domain Names
-
GET fetch all /domains/public/hostnames
-
-
Unique System Fully Qualified Domain Names
-
GET fetch all /domains/system/hostnames
-
-
Packages
-
GET fetch all /packages
-
GET fetch /packages/:packageId
-